CWIMAPFolder

Discussion

This class, which extends the CWFolder class, is used to implement IMAP-specific features such as server-side operations for copying messages between mailboxes.

Superclass

CWFolder

Declared In

CWIMAPFolder.h

Methods

-appendMessageFromRawSource:flags:internalDate:

-copyMessages: toFolder:

-copyMessages:toFolder:

-initWithName: mode:

-initWithName:mode:

-prefetch

-selected

-setSelected:

-setUIDValidity:

-UIDValidity

- (void) appendMessageFromRawSource: (NSData *) theData flags:(CWFlags *) theFlags 
        internalDate: (NSCalendarDate *) theDate; 

Parameters

Discussion

This method is used to append a message from its raw source representation (RFC2822 compliant) to the underlying store. It differs from -appendMessageFromRawSource:flags: in that this method supplies the given date to the server to use as the INTERNALDATE. Not supplying this date will cause some servers and clients to report the date of the message as the current date and time, rather than that specified in the Received header.

- (void) copyMessages: (NSArray *) theMessages toFolder: (NSString *) theFolder; 

Parameters

Discussion

This method copies the messages in theMessages array from the receiver to the destination folder's name, theFolder. On success, this method posts a PantomimeMessagesCopyCompleted notification (and calls -messagesCopyCompleted: on the delegate, if any). On failure, it posts a PantomimeMessagesCopyFailed notification (and calls -messagesCopyFailed: on the delegate, if any). This method is fully asynchronous.

See Also

- (void) copyMessages: (NSArray *) theMessages toFolder: (NSString *) theFolder; 

Parameters

Discussion

This method copies the messages in theMessages array from the receiver to the destination folder's name, theFolder. On success, this method posts a PantomimeMessagesCopyCompleted notification (and calls -messagesCopyCompleted: on the delegate, if any). On failure, it posts a PantomimeMessagesCopyFailed notification (and calls -messagesCopyFailed: on the delegate, if any). This method is fully asynchronous.

See Also

- (id) initWithName: (NSString *) theName mode: (PantomimeFolderMode) theMode; 

Parameters

Return Value

An CWIMAPFolder instance, nil on error.

Discussion

This method is used to initialize the receiver with theName using theMode. Normally, you should not invoke this method directly. You must rather use one of CWIMAPStore's folderForName: ... method.

See Also

- (id) initWithName: (NSString *) theName mode: (PantomimeFolderMode) theMode; 

Parameters

Discussion

This method is used to initialize the receiver with theName using theMode. Normally, you should not invoke this method directly. You must rather use one of CWIMAPStore's folderForName: ... method.

See Also

- (void) prefetch; 

Discussion

This method is used to cache part of the message headers from the IMAP server. On completion, it posts the PantomimeFolderPrefetchCompleted notification (and calls -folderPrefetchCompleted: on the delegate, if any). This method is fully asynchronous.

- (BOOL) selected; 

Return Value

YES if it is in a selected state, NO otherwise.

Discussion

This method is used to verify if the folder is in a selected state.

- (void) setSelected: (BOOL) theBOOL; 

Parameters

Discussion

This method is used to specify if the folder is in a selected state or not. You should never call this method directly. Instead, call IMAPStore: -folderForName: select:.

- (void) setUIDValidity: (unsigned int) theUIDValidity; 

Parameters

Discussion

This method is used to set the UID validity of the receiver. If the receiver has a cache (instance of CWIMAPCacheManager) and the UID validity of its cache differs from theUIDValidity, all cache entries are invalidated.

- (unsigned int) UIDValidity; 

Return Value

The UID validity of the folder.

Discussion

This method is used to obtain the UID validity of an IMAP folder. Refer to "2.3.1.1. Unique Identifier (UID) Message Attribute" of RFC 3501 for a detailed description of this parameter.

Member Data

_selected

_uid_validity

private

BOOL _selected; 

private

unsigned int _uid_validity;