Merge pull request #155 from paulyoung/message-rendering-with-session

Simple message rendering methods on IMAP.

1 files changed, 58 insertions, 0 deletions

diff --git a/src/objc/imap/MCOIMAPSession.h b/src/objc/imap/MCOIMAPSession.h
index 3a6cbc6f..8a223749 100644
--- a/src/objc/imap/MCOIMAPSession.h
+++ b/src/objc/imap/MCOIMAPSession.h
@@ -29,6 +29,8 @@
 @class MCOIMAPSearchExpression;
 @class MCOIMAPIdentityOperation;
 @class MCOIMAPCapabilityOperation;
+@class MCOIMAPMessageRenderingOperation;
+@class MCOIMAPMessage;
 
 /**
  This is the main IMAP class from which all operations are created 
@@ -534,6 +536,62 @@
 - (MCOIMAPSearchOperation *) searchExpressionOperationWithFolder:(NSString *)folder
                                                       expression:(MCOIMAPSearchExpression *)expression;
 
+/** @name Rendering Operations */
+
+/**
+ Returns an operation to render the HTML version of a message to be displayed in a web view.
+ 
+    MCOIMAPMessageRenderingOperation * op = [session htmlRenderingOperationWithMessage:msg
+                                                                            folder:@"INBOX"];
+    
+    [op start:^(NSString * htmlString, NSError * error) {
+        ...
+    }];
+*/
+- (MCOIMAPMessageRenderingOperation *) htmlRenderingOperationWithMessage:(MCOIMAPMessage *)message
+                                                                  folder:(NSString *)folder;
+
+/**
+ Returns an operation to render the HTML body of a message to be displayed in a web view.
+ 
+    MCOIMAPMessageRenderingOperation * op = [session htmlBodyRenderingOperationWithMessage:msg
+                                                                                    folder:@"INBOX"];
+    
+    [op start:^(NSString * htmlString, NSError * error) {
+        ...
+    }];
+ */
+- (MCOIMAPMessageRenderingOperation *) htmlBodyRenderingOperationWithMessage:(MCOIMAPMessage *)message
+                                                                      folder:(NSString *)folder;
+
+/**
+ Returns an operation to render the plain text version of a message.
+ 
+    MCOIMAPMessageRenderingOperation * op = [session plainTextRenderingOperationWithMessage:msg
+                                                                                     folder:@"INBOX"];
+
+    [op start:^(NSString * htmlString, NSError * error) {
+        ...
+    }];
+ */
+- (MCOIMAPMessageRenderingOperation *) plainTextRenderingOperationWithMessage:(MCOIMAPMessage *)message
+                                                                       folder:(NSString *)folder;
+
+/**
+ Returns an operation to render the plain text body of a message.
+ All end of line will be removed and white spaces cleaned up.
+ This method can be used to generate the summary of the message.
+ 
+    MCOIMAPMessageRenderingOperation * op = [session plainTextBodyRenderingOperationWithMessage:msg
+                                                                                         folder:@"INBOX"];
+ 
+    [op start:^(NSString * htmlString, NSError * error) {
+        ...
+    }];
+ */
+- (MCOIMAPMessageRenderingOperation *) plainTextBodyRenderingOperationWithMessage:(MCOIMAPMessage *)message
+                                                                           folder:(NSString *)folder;
+
 @end
 
 #endif