aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/objc/imap/MCOIMAPFetchContentToFileOperation.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/objc/imap/MCOIMAPFetchContentToFileOperation.h')
-rw-r--r--src/objc/imap/MCOIMAPFetchContentToFileOperation.h51
1 files changed, 51 insertions, 0 deletions
diff --git a/src/objc/imap/MCOIMAPFetchContentToFileOperation.h b/src/objc/imap/MCOIMAPFetchContentToFileOperation.h
new file mode 100644
index 00000000..4d06e94d
--- /dev/null
+++ b/src/objc/imap/MCOIMAPFetchContentToFileOperation.h
@@ -0,0 +1,51 @@
+//
+// MCOIMAPFetchContentToFileOperation.h
+// mailcore2
+//
+// Created by Dmitry Isaikin on 2/08/16.
+// Copyright (c) 2016 MailCore. All rights reserved.
+//
+
+#ifndef MAILCORE_MCOIMAPFETCHCONTENTTOFILEOPERATION_H
+
+#define MAILCORE_MCOIMAPFETCHCONTENTTOFILEOPERATION_H
+
+/**
+ This class implements an operation to fetch the content of a message to the file.
+ It can be a part or a full message.
+*/
+
+#import <MailCore/MCOIMAPBaseOperation.h>
+#import <MailCore/MCOConstants.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface MCOIMAPFetchContentToFileOperation : MCOIMAPBaseOperation
+
+/**
+ This block will be called as bytes are received from the network
+*/
+@property (nonatomic, copy, nullable) MCOIMAPBaseOperationProgressBlock progress;
+
+@property (nonatomic, assign, getter=isLoadingByChunksEnabled) BOOL loadingByChunksEnabled;
+@property (nonatomic, assign) uint32_t chunksSize;
+@property (nonatomic, assign) uint32_t estimatedSize;
+
+/**
+ Starts the asynchronous fetch operation.
+
+ @param completionBlock Called when the operation is finished.
+
+ - On success `error` will be nil
+
+ - On failure, `error` will be set with `MCOErrorDomain` as domain and an
+ error code available in `MCOConstants.h`
+*/
+
+- (void) start:(void (^)(NSError * __nullable error))completionBlock;
+
+@end
+
+NS_ASSUME_NONNULL_END
+
+#endif