aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/objc/imap/MCOIMAPAppendMessageOperation.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/objc/imap/MCOIMAPAppendMessageOperation.h')
-rw-r--r--src/objc/imap/MCOIMAPAppendMessageOperation.h11
1 files changed, 10 insertions, 1 deletions
diff --git a/src/objc/imap/MCOIMAPAppendMessageOperation.h b/src/objc/imap/MCOIMAPAppendMessageOperation.h
index 0377d797..95f29f5d 100644
--- a/src/objc/imap/MCOIMAPAppendMessageOperation.h
+++ b/src/objc/imap/MCOIMAPAppendMessageOperation.h
@@ -10,14 +10,23 @@
#define __MAILCORE_MCOIMAPAPPENDMESSAGEOPERATION_H_
+// This class implements an operation that adds a message to a folder.
+
#import <MailCore/MCOIMAPBaseOperation.h>
#import <MailCore/MCOConstants.h>
@interface MCOIMAPAppendMessageOperation : MCOIMAPBaseOperation
+// This block will be called during the progression while sending the message
+// when some bytes have been sent to the network.
@property (nonatomic, copy) MCOIMAPBaseOperationProgressBlock progress;
-- (void)start:(void (^)(NSError *error, uint32_t createdUID))completionBlock;
+// Starts the asynchronous operation.
+// On success, the completion block will be called with nil as error. createdUID will be the value of the UID of
+// the created message is the server supports UIDPLUS or zero if not.
+// On failure, error will be set with MCOErrorDomain as domain and an error code available in MCOConstants.h.
+// createdUID will be zero.
+- (void) start:(void (^)(NSError * error, uint32_t createdUID))completionBlock;
@end