diff options
| -rw-r--r-- | src/objc/imap/MCOIMAPMessage.h | 7 | ||||
| -rw-r--r-- | src/objc/imap/MCOIMAPSession.h | 12 | ||||
| -rw-r--r-- | src/objc/rfc822/MCOMessageBuilder.h | 3 | ||||
| -rw-r--r-- | src/objc/rfc822/MCOMessageParser.h | 4 |
4 files changed, 26 insertions, 0 deletions
diff --git a/src/objc/imap/MCOIMAPMessage.h b/src/objc/imap/MCOIMAPMessage.h index bcc1b5a1..f0a1e0ec 100644 --- a/src/objc/imap/MCOIMAPMessage.h +++ b/src/objc/imap/MCOIMAPMessage.h @@ -11,6 +11,13 @@ #define __MAILCORE_MCOIMAPMESSAGE_H_ // This class implements an IMAP message. +// If you fetched the MIME structure of the message, you can fetch +// efficiently the content of the message by fetching only the parts +// that you need to show it. +// For example, you could fetch only the text parts to show the summary +// of the message, using -[MCOIMAPSession fetchMessageAttachmentByUIDOperationWithFolder:uid:partID:encoding:] +// You can also decide to fetch entirely the message using +// -[MCOIMAPSession fetchMessageByUIDOperationWithFolder:uid:] #import <MailCore/MCOAbstractMessage.h> #import <MailCore/MCOConstants.h> diff --git a/src/objc/imap/MCOIMAPSession.h b/src/objc/imap/MCOIMAPSession.h index 3849b32e..99d67532 100644 --- a/src/objc/imap/MCOIMAPSession.h +++ b/src/objc/imap/MCOIMAPSession.h @@ -339,6 +339,7 @@ // Returns an operation to fetch an attachment. // The operation needs to be started. // +// Example 1: // { // ... // MCOIMAPFetchContentOperation * op = [session fetchMessageAttachmentByUIDOperationWithFolder:@"INBOX" @@ -349,6 +350,17 @@ // ... // }]; // +// Example 2: +// { +// ... +// MCOIMAPFetchContentOperation * op = [session fetchMessageAttachmentByUIDOperationWithFolder:@"INBOX" +// uid:[message uid] +// partID:[part partID] +// encoding:[part encoding]]; +// [op start:^(NSError * error, NSData * partData) { +// ... +// }]; +// - (MCOIMAPFetchContentOperation *) fetchMessageAttachmentByUIDOperationWithFolder:(NSString *)folder uid:(uint32_t)uid partID:(NSString *)partID diff --git a/src/objc/rfc822/MCOMessageBuilder.h b/src/objc/rfc822/MCOMessageBuilder.h index a2131d05..a01e3350 100644 --- a/src/objc/rfc822/MCOMessageBuilder.h +++ b/src/objc/rfc822/MCOMessageBuilder.h @@ -13,6 +13,9 @@ #import <MailCore/MCOAbstractMessage.h> // This class will allow you to build a RFC 822 formatted message. +// For example when you need to send a message using SMTP, +// you need to generate first a RFC 822 formatted message. +// This class will help you do that. /* diff --git a/src/objc/rfc822/MCOMessageParser.h b/src/objc/rfc822/MCOMessageParser.h index dc59973f..c0df2fbb 100644 --- a/src/objc/rfc822/MCOMessageParser.h +++ b/src/objc/rfc822/MCOMessageParser.h @@ -10,6 +10,10 @@ #define __MAILCORE_MCOMESSAGEPARSER_H_ +// This class implements a parsed message. +// When the full content of a message has been fetched using POP or IMAP, +// you need to parse it. + #import <MailCore/MCOAbstractMessage.h> @protocol MCOHTMLRendererDelegate; |