diff options
author | 2013-04-06 11:01:14 -0700 | |
---|---|---|
committer | 2013-04-06 11:01:14 -0700 | |
commit | abc2b119c709a3fcea92ea1750f208b2bf47c9d5 (patch) | |
tree | 93bbf712bb9b0ff2e568b7bf951507a17b0d814d /src/objc/imap/MCOIMAPCapabilityOperation.h | |
parent | ed6ba5a558bccf6024c1a5ab3db2b89d4c6a1420 (diff) |
Work in progress on IMAP documentation.
Diffstat (limited to 'src/objc/imap/MCOIMAPCapabilityOperation.h')
-rw-r--r-- | src/objc/imap/MCOIMAPCapabilityOperation.h | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/src/objc/imap/MCOIMAPCapabilityOperation.h b/src/objc/imap/MCOIMAPCapabilityOperation.h index f1e662a8..38166e0b 100644 --- a/src/objc/imap/MCOIMAPCapabilityOperation.h +++ b/src/objc/imap/MCOIMAPCapabilityOperation.h @@ -10,13 +10,20 @@ #define __MAILCORE_MCOIMAPCAPBILITYOPERATION_H_ +// This class implements an operation to query capabilities. + #import <MailCore/MCOIMAPBaseOperation.h> @class MCOIndexSet; @interface MCOIMAPCapabilityOperation : MCOIMAPBaseOperation -- (void)start:(void (^)(NSError *error, MCOIndexSet * capabilities))completionBlock; +// 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. +- (void) start:(void (^)(NSError * error, MCOIndexSet * capabilities))completionBlock; @end |