diff options
author | 2013-06-02 20:41:28 -0500 | |
---|---|---|
committer | 2013-06-02 20:41:28 -0500 | |
commit | 3ae5bf7a1d806c749c28f641be34733c85808efe (patch) | |
tree | 27513da58055e421686ace2601d37a1e23eacb28 /src/objc/imap/MCOIMAPCopyMessagesOperation.h | |
parent | 6fbe6f212003b97860a23c254e5124f0b2578366 (diff) |
Finished formatting docs for Appledoc for IMAP and SMTP
Diffstat (limited to 'src/objc/imap/MCOIMAPCopyMessagesOperation.h')
-rw-r--r-- | src/objc/imap/MCOIMAPCopyMessagesOperation.h | 19 |
1 files changed, 13 insertions, 6 deletions
diff --git a/src/objc/imap/MCOIMAPCopyMessagesOperation.h b/src/objc/imap/MCOIMAPCopyMessagesOperation.h index 0fb3c5ad..c916e1d7 100644 --- a/src/objc/imap/MCOIMAPCopyMessagesOperation.h +++ b/src/objc/imap/MCOIMAPCopyMessagesOperation.h @@ -12,17 +12,24 @@ #define __MAILCORE_MCOCOPYMESSAGESOPERATION_H_ -// This class implements an operation to copy messages. +/** Implements an operation for copying messages between folders */ @class MCOIndexSet; @interface MCOIMAPCopyMessagesOperation : MCOIMAPBaseOperation -// Starts the asynchronous operation. -// On success, the completion block will be called with nil as error. destUids will contain the UID of the messages -// created in the destination folder if UIDPLUS is supported. destUids will be nil if UIDPLUS is not supported. -// 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 copy operation. + + @param completionBlock Called when the operation is finished. + + - On success `error` will be nil and `destUids` will contain the UIDs of the messages created + in the destination folder. If the server doesn't support UIDPLUS then `destUids` will be nil. + + - On failure, `error` will be set with `MCOErrorDomain` as domain and an + error code available in `MCOConstants.h`, `destUids` will be nil +*/ + - (void) start:(void (^)(NSError * error, MCOIndexSet * destUids))completionBlock; @end |