CWMessage

Discussion

This class is used to describe Internet messages. This class extends the CWPart class and inherit all its methods.

Conforms to

NSCoding

Superclass

CWPart

Declared In

CWMessage.h

Methods

-addHeader: withValue:

-addHeader:withValue:

-addHeadersFromData:record:

-addRecipient:

-allReferences

-baseSubject

-flags

-folder

-forward:

-from

-initWithHeaders:

-initWithHeadersFromData:

-inReplyTo

-isInitialized

-messageID

-messageNumber

-MIMEVersion

-organization

-propertyForKey:

-rawSource

-receivedDate

-recipients

-recipientsCount

-removeAllRecipients

-removeRecipient:

-reply:

-replyTo

-resentDate

-resentFrom

-resentMessageID

-resentSubject

-setBaseSubject:

-setFlags:

-setFolder:

-setFrom:

-setHeadersFromData:record:

-setInitialized:

-setInReplyTo:

-setMessageID:

-setMessageNumber:

-setMIMEVersion:

-setOrganization:

-setProperty: forKey:

-setProperty:forKey:

-setRawSource:

-setReceivedDate:

-setRecipients:

-setReferences:

-setReplyTo:

-setResentDate:

-setResentFrom:

-setResentMessageID:

-setResentSubject:

-setSubject:

-subject

- (void) addHeader: (NSString *) theName withValue: (NSString *) theValue; 

Parameters

Discussion

This method is used to add an extra header to the list of headers of the message.

See Also

- (void) addHeader: (NSString *) theName withValue: (NSString *) theValue; 

Parameters

Discussion

This method is used to add an extra header to the list of headers of the message.

See Also

- (void) addHeadersFromData: (NSData *) theHeaders record: (cache_record *) theRecord; 

Parameters

Discussion

This method is used to add addionnal headers from their raw representation. It will not erase the currently defined headers. It also updates the cache record theRecord with the decoded information.

- (void) addRecipient: (CWInternetAddress *) theAddress; 

Parameters

Discussion

This method is used to add a recipient to the list of all recipients for the receiver. The recipient type is determined by calling the -type method on the CWInternetAddress's instance.

- (NSArray *) allReferences; 

Return Value

The value of the "References" header. This corresponds to a NSArray of NSString instances. Each instance is normally a Message-ID.

Discussion

This method is used to obtain the value of the "References" header. The values are particularly useful for message threading.

- (NSString *) baseSubject; 

Return Value

The base subject.

Discussion

This method is used to obtain the base subject. The base subject is basically the value of the "Subject" header but without the "re" or "fwd" (or whatever) prefix.

- (CWFlags *) flags; 

Return Value

The CWFlags instance of the receiver.

Discussion

This method is used to obtain the flags associated to the receiver.

- (CWFolder *) folder; 

Return Value

The CWFolder instance in which the message is stored, nil if no folder holds the receiver.

Discussion

This method is used to get the associated receiver's folder.

- (CWMessage *) forward: (PantomimeForwardMode) theMode; 

Parameters

Return Value

A CWMessage instance used for forwarding.

Discussion

This method is used to contruct a new CWMessage instance to be used when forward a message. The returned message will always use the UTF-8 charset.

- (CWInternetAddress *) from; 

Return Value

The value of the "From" header, as an CWInternetAddress instance.

Discussion

This method is used to obtain the value of the "From" header.

- (id) initWithHeaders: (NSDictionary *) theHeaders; 

Parameters

Return Value

A Message instance, nil on error.

Discussion

This method is used to initialize the receiver with a predefined set of headers. The headers are specified in a NSDictionary instance where the keys are the header names (for example, "Content-Type") and the values are the respective values of for each keys. This method class -setHeaders:.

- (id) initWithHeadersFromData: (NSData *) theHeaders; 

Parameters

Return Value

A Message instance, nil on error.

Discussion

This method is used to initialize the receiver with a predefined set of headers in their raw representation. This method calls -setHeadersFromData:.

- (NSString *) inReplyTo; 

Return Value

The value of the "In-Reply-To" header.

Discussion

This method is used to obtain the value of the "In-Reply-To" header.

- (BOOL) isInitialized; 

Return Value

YES if the message is initialized, NO otherwise.

Discussion

This method is used to verify if a message has been initialized or not. An inititalized message is a message for which all parts have been initilized. A message for which only the headers are set is not an initialized message.

- (NSString *) messageID; 

Return Value

The value of the "Message-ID" header.

Discussion

This method is used to obtain the value of the "Message-ID" header.

- (unsigned int) messageNumber; 

Return Value

The MSN, 0 if none was previously set.

Discussion

This method is used to obtain the message sequence number (MSN) of the receiver. MSN have a special meaning for IMAP messages (see 2.3.1.2. of RFC3501 for details).

- (NSString *) MIMEVersion; 

Return Value

The value of the header, nil if none was set.

Discussion

This method is used to obtain the value of the "MIME-Version" header.

- (NSString *) organization; 

Return Value

The value of the "Organization" header.

Discussion

This method is used to obtain the value of the "Organization" header.

- (id) propertyForKey: (id) theKey; 

Return Value

The property for the specified key, nil if key isn't found.

Discussion

This method is used to get an extra property for the specified key.

- (NSData *) rawSource; 

Return Value

The raw representation, or nil if it has not been loaded.

Discussion

This method is used to obtain the raw representation of the receiver. Subclasses will overwrite this method so it's not blocking (see the documentation of this method for CWIMAPMessage, for example).

- (NSCalendarDate *) receivedDate; 

Return Value

The value of the "Date" header, as a NSCalendarDate instance.

Discussion

This method is used to obtain the value of the "Date" header.

- (NSArray *) recipients; 

Return Value

The array of recipients which are all CWInternetAddress instances.

Discussion

This method is used to obtain the list of recipients of the receiver. All recipient types are returned.

- (unsigned int) recipientsCount; 

Return Value

The count.

Discussion

This method is used to obtain the number of recipients the receiver has.

- (void) removeAllRecipients; 

Discussion

This method is used to remove all recipients from the receiver.

- (void) removeRecipient: (CWInternetAddress *) theAddress; 

Parameters

Discussion

This method is used to remove the specified recipient from the receiver's list of recipients.

- (CWMessage *) reply: (PantomimeReplyMode) theMode; 

Parameters

Return Value

A CWMessage instance used for replying.

Discussion

This method is used to contruct a new CWMessage instance to be used when replying to a message. The returned message will always use the UTF-8 charset. The message will NOT have a content other than the plain text one(s).

- (NSArray *) replyTo; 

Return Value

The value of the "Reply-To" header, as an array of CWInternetAddress instances. If there are none, nil is returned.

Discussion

This method is used to obtain the value of the "Reply-To" header.

- (NSCalendarDate *) resentDate; 

Return Value

The value of the "Resent-Date" header.

Discussion

This method is used to obtain the value of the "Resent-Date" header.

- (CWInternetAddress *) resentFrom; 

Return Value

The value of the "Resent-From" header.

Discussion

This method is used to obtain the value of the "Resent-From" header.

- (NSString *) resentMessageID; 

Return Value

The value of the "Resent-Message-ID" header.

Discussion

This method is used to obtain the value of the "Resent-Message-ID" header.

- (NSString *) resentSubject; 

Return Value

The value of the "Resent-Subject" header.

Discussion

This method is used to obtain the value of the "Resent-Subject" header.

- (void) setBaseSubject: (NSString *) theBaseSubject; 

Parameters

Discussion

This method is used to set the base subject of the receiver.

- (void) setFlags: (CWFlags *) theFlags; 

Parameters

Discussion

This method is used to set the flags of the receiver, replacing any previous values set. Subclasses of CWMessage sometimes overwrite this method.

- (void) setFolder: (CWFolder *) theFolder; 

Parameters

Discussion

This method is used to set the associated folder to the message.

- (void) setFrom: (CWInternetAddress *) theInternetAddress; 

Parameters

Discussion

This method is used to set the value of the "From:" header.

- (void) setHeadersFromData: (NSData *) theHeaders record: (cache_record *) theRecord; 

Parameters

Discussion

This method initalize all the headers of a message from the raw data source. It replaces previously defined values of headers found in theHeaders. It also updates the cache record theRecord with the decoded information.

- (void) setInitialized: (BOOL) theBOOL; 

Parameters

Discussion

This method is used to initialize the message or free the resources taken by its content. Subclasses of CWMessage sometimes overwrite this method.

- (void) setInReplyTo: (NSString *) theInReplyTo; 

Parameters

Discussion

This method is used to set the value of the "In-Reply-To" header.

- (void) setMessageID: (NSString *) theMessageID; 

Parameters

Discussion

This method is used to set the value of the "Message-ID" header.

- (void) setMessageNumber: (unsigned int) theMessageNumber; 

Parameters

Discussion

This method is used to set the message number value of the receiver.

- (void) setMIMEVersion: (NSString *) theMIMEVersion; 

Parameters

Discussion

This method is used to set the value of the "MIME-Version" header, replacing any values previously set.

- (void) setOrganization: (NSString *) theOrganization; 

Parameters

Discussion

This method is used to set the value of the "Organization" header.

- (void) setProperty: (id) theProperty forKey: (id) theKey; 

Parameters

Discussion

This method is used to set an extra property for the specified key on this folder. If nil is passed for theProperty parameter, the value will actually be REMOVED for theKey.

See Also

- (void) setProperty: (id) theProperty forKey: (id) theKey; 

Parameters

Discussion

This method is used to set an extra property for the specified key on this folder. If nil is passed for theProperty parameter, the value will actually be REMOVED for theKey.

See Also

- (void) setRawSource: (NSData *) theRawSource; 

Parameters

Discussion

This method is used to set the raw representation of the receiver. No specific actions are taken when invoking this method.

- (void) setReceivedDate: (NSCalendarDate *) theDate; 

Parameters

Discussion

This method is used to set the value of the "Date" header.

- (void) setRecipients: (NSArray *) theRecipients; 

Parameters

Discussion

This method is used to add theRecipients to the list of the receiver's recipients.

- (void) setReferences: (NSArray *) theReferences; 

Parameters

Discussion

This method is used to the value of the "References" header, replacing any previously defined value.

- (void) setReplyTo: (NSArray *) theAddressList; 

Parameters

Discussion

This method is used to set the value of the "Reply-To:" header.

- (void) setResentDate: (NSCalendarDate *) theResentDate; 

Parameters

Discussion

This method is used to set the value of the "Resent-Date" header.

- (void) setResentFrom: (CWInternetAddress *) theInternetAddress; 

Parameters

Discussion

This method is used to set the value of the "Resent-From" header.

- (void) setResentMessageID: (NSString *) theResentMessageID; 

Parameters

Discussion

This method is used to set the value of the "Resent-Message-ID" header.

- (void) setResentSubject: (NSString *) theResentSubject; 

Parameters

Discussion

This method is used to set the value of the "Resent-Subject" header.

- (void) setSubject: (NSString *) theSubject; 

Parameters

Discussion

This method is used to set the value of the "Subject" header.

- (NSString *) subject; 

Return Value

The value of the "Subject" header.

Discussion

This method is used to obtain the value of the "Subject" header.

Member Data

_flags

_folder

_initialized

_message_number

_properties

_rawSource

_recipients

_references

private

CWFlags *_flags; 

private

CWFolder *_folder; 

private

BOOL _initialized; 

private

unsigned int _message_number; 

private

NSMutableDictionary *_properties; 

protected

NSData *_rawSource; 

private

NSMutableArray *_recipients; 

private

NSArray *_references;