Header documentation for SMTP and RFC822.

1 files changed, 19 insertions, 1 deletions

diff --git a/src/objc/rfc822/MCOMessageBuilder.h b/src/objc/rfc822/MCOMessageBuilder.h
index 576a37a7..fb48ac91 100644
--- a/src/objc/rfc822/MCOMessageBuilder.h
+++ b/src/objc/rfc822/MCOMessageBuilder.h
@@ -14,6 +14,23 @@
 
 // This class will allow you to build a RFC 822 formatted message.
 
+/*
+ 
+{
+  ...
+  MCOMessageBuilder * builder = [[MCOMessageBuilder alloc] init];
+  [[builder header] setFrom:[MCOAddress addressWithDisplayName:@"Hoa V. DINH" mailbox:@"hoa@etpan.org"];
+  NSArray * to = [NSArray arrayWithObject:[MCOAddress addressWithDisplayName:@"Gael Roualland" mailbox:@"gael@etpan.org"]];
+  [[builder header] setTo:to];
+  [[builder header] setSubject:@"A nice picture!"];
+  [builder setHTMLBody:@"<div>Here's the message I need to send.</div>"];
+  [builder addAttachment:[MCOAttachment attachmentWithContentsOfFile:@"/Users/foo/Pictures/image.jpg"]];
+  NSData * rfc822Data = [builder data];
+  ...
+}
+ 
+ */
+
 @class MCOAttachment;
 @protocol MCOHTMLRendererDelegate;
 
@@ -31,7 +48,8 @@
 // List of related file attachments (included as cid: link in the HTML part).
 @property (nonatomic, copy) NSArray * relatedAttachments;
 
-// Prefix for the boundary identifier
+// Prefix for the boundary identifier.
+// Default value is nil.
 @property (nonatomic, copy) NSString * boundaryPrefix;
 
 // Add an attachment.