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.

Certain well-known headers are restricted to one occurrence in an email, and when extra copies are added they replace originals.

The mime-version header is special... it is inserted before any other mime headers rather than being added at the end.

This method returns an array containing GSMimeHeader 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.

text

an NSString object

binary

an NSData object

multipart

an NSArray object containing GSMimeDocument objects

Make a probably unique string suitable for use as the boundary parameter in the content of a multipart document.

This implementation provides base64 encoded data consisting of an MD5 digest of some pseudo random stuff, plus an incrementing counter. The inclusion of the counter guarantees that we won't produce two identical strings in the same run of the program.

The boundary has a suffix of '=_' to ensure it's not mistaken for quoted-printable data.

Return an NSData object representing the MIME document as raw data ready to be sent via an email system.

The isOuter flag denotes whether this document is the outermost part of a MIME message, or is a part of a multipart message.

Long lines are folded at the default column.

Return an NSData object representing the MIME document as raw data ready to be sent via an email system.

The isOuter flag denotes whether this document is the outermost part of a MIME message, or is a part of a multipart message.

The fold number specifes the column at which lines are considered to be 'long', and get broken/folded.

During generation of the document this method will perform some consistency checks and try to automatically generate missing header information needed to build the mime data (eg. filling in the boundary parameter in the content-type header for multipart documents).
However, you should not depend on automatic behaviors but should fill in as much detail as possible before generating data.

Convenience method to set the content of the document along with creating a content-type header for it.

The type parameter may be a simple common content type (text, multipart, or application), in which case the default subtype for that type is used. Alternatively it may be full detail of a content type header value, which will be parsed into 'type', 'subtype' and 'parameters'.
NB. In this case, if the parsed data contains a 'name' parameter and the name argument is non-nil, the argument value will override the parsed value.

You can get the same effect by calling -setContent: to set the document content, then creating a GSMimeHeader instance, initialising it with the content type information you want using [GSMimeHeader -initWithName:value:parameters:] , and calling the -setHeader: method to attach it to the document.

Using this method imposes a few extra checks and restrictions on the combination of content and type/subtype you may use... so you may want to use the more primitive methods in order to bypass these checks if you are using unusual type/subtype information or if you need to provide additional parameters in the header.

Convenience method to set the content type of the document without altering any content. The supplied newType may be full type information including subtype and parameters as found after the colon in a mime Content-Type header.

The default implementation supports the following transfer encodings specified in either a transfer-encoding of content-transfer-encoding header -

• base64
• quoted-printable
• binary (no coding actually performed)
• 7bit (no coding actually performed)
• 8bit (no coding actually performed)
• chunked (for HTTP/1.1)
• x-uuencode

Decodes the raw data from the specified range in the source data object and appends it to the destination data object. The context object provides information about the content encoding type in use, and the state of the decoding operation.

This method may be called repeatedly to incrementally decode information as it arrives on some communications channel. It should be called with a nil source data item (or with the atEnd flag of the context set to YES) in order to flush any information held in the context to the output data object.

You may override this method in order to implement additional coding schemes, but usually it should be enough for you to implement a custom GSMimeCodingContext subclass fotr this method to use.

Correct the size of the output buffer (shrink back from the original allocation to the actual unchunked size).

This method is called repeatedly to pass raw mime data into the parser. It returns YES as long as it wants more data to complete parsing of a document, and NO if parsing is complete, either due to having reached the end of a document or due to an error.

Since it is not always possible to determine if the end of a MIME document has been reached from its content, the method may need to be called with a nil or empty argument after you have passed all the data to it... this tells it that the data is complete.

The parser attempts to be as flexible as possible and to continue parsing wherever it can. If an error occurs in parsing, the -isComplete method will always return NO, even after the -parse: method has been called with a nil argument.

A multipart document will be parsed to content consisting of an NSArray of GSMimeDocument instances representing each part.
Otherwise, a document will become content of type NSData, unless it is of content type text, in which case it will be an NSString.
If a document has no content type specified, it will be treated as text , unless it is identifiable as a file (eg. t has a content-disposition header containing a filename parameter).

This method is called to parse a header line for the current document, split its contents into a GSMimeHeader object, and add that information to the document.
The method is normally used internally by the -parse: method, but you may also call it to parse an entire header line and add it to the document (this may be useful in conjunction with the -expectNoHeaders method, to parse a document body data into a document where the headers are available from a separate source).

   GSMimeParser *parser = [GSMimeParser mimeParser];

   [parser parseHeader: @"content-type: text/plain"];
   [parser expectNoHeaders];
   [parser parse: bodyData];
   [parser parse: nil];
 

The standard implementation of this method scans the header name and then calls -scanHeaderBody:into: to complete the parsing of the header.

This method also performs consistency checks on headers scanned so it is recommended that it is not overridden, but that subclasses override -scanHeaderBody:into: to implement custom scanning.

As a special case, for HTTP support, this method also parses lines in the format of HTTP responses as if they were headers named http. The resulting header object contains additional object values -

HttpMajorVersion

The first part of the version number

HttpMinorVersion

The second part of the version number

NSHTTPPropertyServerHTTPVersionKey

The full HTTP protocol version number

NSHTTPPropertyStatusCodeKey

The HTTP status code (numeric)

NSHTTPPropertyStatusReasonKey

The text message (if any) after the status code

This method is called to parse a header line and split its contents into the supplied GSMimeHeader instance.

On entry, the header (info) is already partially filled, the name is a lowercase representation of the header name. The the scanner must be set to a scan location immediately after the colon in the original header string (ie to the header value string).

If the header is parsed successfully, the method should return YES, otherwise NO.

You would not normally call this method directly yourself, but may override it to support parsing of new headers.
If you do call this yourself, you need to be aware that it may change the state of the document in the parser.

You should be aware of the parsing that the standard implementation performs, and that needs to be done for certain headers in order to permit the parser to work generally -

content-disposition

Value

The content disposition (excluding parameters) as a lowercase string.

content-type

Subtype

The MIME subtype lowercase

Type

The MIME type lowercase

value

The full MIME type (xxx/yyy) in lowercase

content-transfer-encoding

Value

The transfer encoding type in lowercase

http

HttpVersion

The HTTP protocol version number

HttpMajorVersion

The first component of the version number

HttpMinorVersion

The second component of the version number

HttpStatus

The response status value (numeric code)

Value

The text message (if any)

transfer-encoding

Value

The transfer encoding type in lowercase

• Leading whitespace is ignored.

• Leading whitespace is ignored.
• Backslash escapes in quoted text are converted