aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/objc/imap/MCOIMAPIdentityOperation.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/objc/imap/MCOIMAPIdentityOperation.h')
-rw-r--r--src/objc/imap/MCOIMAPIdentityOperation.h9
1 files changed, 8 insertions, 1 deletions
diff --git a/src/objc/imap/MCOIMAPIdentityOperation.h b/src/objc/imap/MCOIMAPIdentityOperation.h
index 60d040e3..0a32892c 100644
--- a/src/objc/imap/MCOIMAPIdentityOperation.h
+++ b/src/objc/imap/MCOIMAPIdentityOperation.h
@@ -10,11 +10,18 @@
#define __MAILCORE_MCOIMAPIDENTITYOPERATION_H_
+// This class implements an operation to get/send identity.
+
#import <MailCore/MCOIMAPBaseOperation.h>
@interface MCOIMAPIdentityOperation : MCOIMAPBaseOperation
-- (void)start:(void (^)(NSError *error, NSDictionary * serverIdentity))completionBlock;
+// Starts the asynchronous operation.
+// On success, the completion block will be called with nil as error. serverIdentity contains the server identity information.
+// See RFC 2971 for the common keys of this dictionary.
+// On failure, error will be set with MCOErrorDomain as domain and an error code available in MCOConstants.h.
+// serverIdentity will be nil.
+- (void) start:(void (^)(NSError * error, NSDictionary * serverIdentity))completionBlock;
@end