GSMimeDocument

Authors

Richard Frith-Macdonald

Version: $Revision$

Date: $Date$

GSMimeDocument

GSMimeDocument

Declared in: Foundation/GSMime.h

Inherits from: NSObject

Conforms to: NSObject

This class is intended to provide a wrapper for MIME messages permitting easy access to the contents of a message and providing a basis for parsing an unparsing messages that have arrived via email or as a web document.

The class keeps track of all the document headers, and provides methods for modifying the headers that apply to a document and for looking at the header structures, by providing an info dictionary containing the various parts of a header.

The common dictionary keys used for elements provided for all headers are -

RawHeader

This is the unmodified text of the header

BaseName

This is the header name.

BaseValue

This is the text after the header name and colon.

Name

This is a lowercase representation of the header name.

Value

This is the value of the header (normally lower case). It may only be a small subset of the information in the header with other information being split into separate fields depending on the type of header.

Instance Variables

Methods

• +mimeDocument
• -addHeader:
• -allHeaders
• -content
• -deleteHeader:
• -deleteHeaderNamed:
• -headerNamed:
• -headersNamed:
• -setContent:
• -setHeader:

Class Methods

mimeDocument

Instances Methods

addHeader:

This method may be called to add a header to the document. The header must be a mutable dictionary object that contains at least the fields that are standard for all headers.

allHeaders

This method returns an array containing NSDictionary objects representing the headers associated with the document.

The order of the headers in the array is the order of the headers in the document.

content

text

an NSString object

binary

an NSData object

multipart

an NSArray object containing GSMimeDocument objects

deleteHeader:

deleteHeaderNamed:

headerNamed:

headersNamed:

setContent:

setHeader: