CWMIMEUtility

MIME utility class.

Discussion

This class provides static methods to deal with the MIME standard. Normally, you should not invoke any of those methods directly.

Superclass

NSObject

Declared In

CWMIMEUtility.h

Methods

+compositeMessageContentFromRawSource:

+compositeMultipartContentFromRawSource:boundary:

+decodeHeader: charset:

+decodeHeader:charset:

+discreteContentFromRawSource: encoding: charset: part:

+discreteContentFromRawSource:encoding:

+encodeHeader: charset: encoding:

+encodeHeader:charset:encoding:

+encodeWordUsingBase64:prefixLength:

+encodeWordUsingQuotedPrintable:prefixLength:

+globallyUniqueBoundary

+globallyUniqueID

+plainTextContentFromPart:

+setContentFromRawSource: inPart:

+setContentFromRawSource:inPart:

+ (CWMessage *) compositeMessageContentFromRawSource: (NSData *) theData; 

Parameters

Return Value

A Message instance, nil on error.

Discussion

This method is used to obtain a composite type (message) from theData.

+ (CWMIMEMultipart *) compositeMultipartContentFromRawSource: (NSData *) theData 
        boundary: (NSData *) theBoundary; 

Parameters

Return Value

A CWMIMEMultipart instance, nil on error.

Discussion

This method is used to obtain a composity type (multipart) from theData, using theBoundary.

+ (NSString *) decodeHeader: (NSData *) theData charset: (NSString *) theCharset; 

Parameters

Return Value

The decoded header.

Discussion

This method is used to decode a header value encoded in base64 or quoted-printable. RFC 2047 describes how those headers should be encoded (in particular, "2. Syntax of encoded-words"). If theCharset is not nil, it is used to decode the header. Otherwise, the charset used in the header is used.

See Also

+ (NSString *) decodeHeader: (NSData *) theData charset: (NSString *) theCharset; 

Parameters

Discussion

This method is used to decode a header value encoded in base64 or quoted-printable. RFC 2047 describes how those headers should be encoded (in particular, "2. Syntax of encoded-words"). If theCharset is not nil, it is used to decode the header. Otherwise, the charset used in the header is used.

See Also

+ (id) discreteContentFromRawSource: (NSData *) theData 
        encoding: (PantomimeEncoding) theEncoding; 

Parameters

Return Value

A NSData instance.

Discussion

This method is used to obtain discrete types such as text/, application/, image/, etc. It might return a NSString or a NSData object (if the encoding is PantomimeEncodingBase64).

See Also

+ (id) discreteContentFromRawSource: (NSData *) theData 
        encoding: (PantomimeEncoding) theEncoding; 

Parameters

Discussion

This method is used to obtain discrete types such as text/, application/, image/, etc. It might return a NSString or a NSData object (if the encoding is PantomimeEncodingBase64).

See Also

+ (NSData *) encodeHeader: (NSString *) theText charset: (NSString *) theCharset 
        encoding: (PantomimeEncoding) theEncoding; 

Parameters

Return Value

The encoded data.

Discussion

This method is used to encode a header value in the format specified by RFC 2047 (in particular, "2. Syntax of encoded-words").

See Also

+ (NSData *) encodeHeader: (NSString *) theText charset: (NSString *) theCharset 
        encoding: (PantomimeEncoding) theEncoding; 

Parameters

Discussion

This method is used to encode a header value in the format specified by RFC 2047 (in particular, "2. Syntax of encoded-words").

See Also

+ (NSData *) encodeWordUsingBase64: (NSString *) theWord 
        prefixLength: (int) thePrefixLength; 

+ (NSData *) encodeWordUsingQuotedPrintable: (NSString *) theWord 
        prefixLength: (unsigned int) thePrefixLength; 

+ (NSData *) globallyUniqueBoundary; 

Return Value

The boundary, as a NSData instance.

Discussion

This method is used to generate a unique MIME boundary (or any kind of boundary).

+ (NSData *) globallyUniqueID; 

Return Value

The unique ID, as a NSData instance.

Discussion

This method is used to generate a unique ID that CWMessage (or CWPart) instances use as their unique ID. (Message-ID, Content-ID, etc.)

+ (NSData *) plainTextContentFromPart: (CWPart *) thePart; 

Parameters

Return Value

The pure "text".

Discussion

This method is used to obtain a pure "text" part. For example, it can be used to strip any HTML content from a part in order to get only the text.

+ (void) setContentFromRawSource: (NSData *) theData inPart: (CWPart *) thePart; 

Parameters

Discussion

This method is used to initialize a message, or a part of the message using theData. The CWPart's Content-Type MUST be defined BEFORE calling this function otherwise the content will be considered as a pure string.

See Also

+ (void) setContentFromRawSource: (NSData *) theData inPart: (CWPart *) thePart; 

Parameters

Discussion

This method is used to initialize a message, or a part of the message using theData. The CWPart's Content-Type MUST be defined BEFORE calling this function otherwise the content will be considered as a pure string.

See Also