diff options
Diffstat (limited to 'src/objc/imap/MCOIMAPCapabilityOperation.h')
-rw-r--r-- | src/objc/imap/MCOIMAPCapabilityOperation.h | 22 |
1 files changed, 16 insertions, 6 deletions
diff --git a/src/objc/imap/MCOIMAPCapabilityOperation.h b/src/objc/imap/MCOIMAPCapabilityOperation.h index 38166e0b..29b0d3be 100644 --- a/src/objc/imap/MCOIMAPCapabilityOperation.h +++ b/src/objc/imap/MCOIMAPCapabilityOperation.h @@ -10,7 +10,10 @@ #define __MAILCORE_MCOIMAPCAPBILITYOPERATION_H_ -// This class implements an operation to query capabilities. +/** + This class implements an operation to query for IMAP capabilities, + like for example the extensions UIDPLUS, IDLE, NAMESPACE, ... etc +*/ #import <MailCore/MCOIMAPBaseOperation.h> @@ -18,11 +21,18 @@ @interface MCOIMAPCapabilityOperation : MCOIMAPBaseOperation -// Starts the asynchronous operation. -// On success, the completion block will be called with nil as error. capabilities is a set of IMAP capabilities. -// See MCOConstants.h / MCOIMAPCapability. -// On failure, error will be set with MCOErrorDomain as domain and an error code available in MCOConstants.h. -// info will be nil. + +/** + Starts the asynchronous capabilities operation. + + @param completionBlock Called when the operation is finished. + + - On success `error` will be nil and `capabilities` will contain a set of IMAP capabilities. + See `MCOConstants.h` under `MCOIMAPCapability` for a list of possible values. + + - On failure, `error` will be set with `MCOErrorDomain` as domain and an + error code available in MCOConstants.h, `capabilities` will be nil +*/ - (void) start:(void (^)(NSError * error, MCOIndexSet * capabilities))completionBlock; @end |