CWIMAPStore

Pantomime IMAP client code.

Discussion

This class, which extends the CWService class and implements the CWStore protocol, is Pantomime's IMAP client code.

Conforms to

CWStore

Superclass

CWService

Declared In

CWIMAPStore.h

Methods

-folderForName:mode:prefetch:

-folderForName:select:

-folderStatus:

-lastTag

-nextTag

-sendCommand:info:arguments:

-sendCommand:info:arguments: ...

-subscribeToFolderWithName:

-unsubscribeToFolderWithName:

- (CWIMAPFolder *) folderForName: (NSString *) theName mode: (PantomimeFolderMode) theMode 
        prefetch: (BOOL) aBOOL; 

Parameters

Return Value

A CWIMAPFolder instance.

Discussion

This method is used to get the folder with the specified name and mode.

- (CWIMAPFolder *) folderForName: (NSString *) theName select: (BOOL) aBOOL; 

Parameters

Return Value

A CWIMAPFolder instance.

Discussion

This method is used to obtain the folder with the specified name. If aBOOL is YES, the folder will be selected. Otherwise, a non-selected folder will be returned which is used to proceed with an append operation. Note that when aBOOL is equal to NO, the returned folder is NOT part of the list of opened folders.

- (NSDictionary *) folderStatus: (NSArray *) theArray; 

Parameters

Return Value

A NSDictionary instance for which the keys are the folder names (NSString instance) and the values are CWFolderInformation instance if the information was loaded, nil otherwise.

Discussion

This method is used to obtain the status of the specified folder names in theArray. It is fully asynchronous. The first time it is invoked, it'll perform its work asynchronously and post a PantomimeFolderStatusCompleted notification (and call -folderStatusCompleted on the delegate, if any) if succeeded. If not, it will post a PantomimeFolderStatusFailed notification (and call -folderStatusFailed: on the delegate, if any). Further calls of this method on the same set of folders will immediately return the status information.

- (NSData *) lastTag; 

Return Value

The tag as a NSData instance.

Discussion

This method is used to obtain the last IMAP tag sent to the IMAP server.

- (NSData *) nextTag; 

Return Value

The tag as a NSData instance.

Discussion

This method is used to obtain the next IMAP tag that will be sent to the IMAP server. Normally you shouldn't call this method directly.

- (void) sendCommand: (IMAPCommand) theCommand info: (NSDictionary *) theInfo 
        arguments: (NSString *) theFormat, ...; 

Parameters

Discussion

This method is used to send commands to the IMAP server. Normally, you should not call this method directly.

See Also

- (void) sendCommand: (IMAPCommand) theCommand info: (NSDictionary *) theInfo 
        arguments: (NSString *) theFormat, ...; 

Parameters

Discussion

This method is used to send commands to the IMAP server. Normally, you should not call this method directly.

See Also

- (void) subscribeToFolderWithName: (NSString *) theName; 

Parameters

Discussion

This method is used to subscribe to the specified folder. The method will post a PantomimeFolderSubscribeCompleted notification (and call -folderSubscribeCompleted: on the delegate, if any) if it succeeded. If not, it will post a PantomimeFolderSubscribeFailed notification (and call -folderSubscribeFailed: on the delegate, if any)

- (void) unsubscribeToFolderWithName: (NSString *) theName; 

Parameters

Discussion

This method is used to unsubscribe to the specified folder. The method will post a PantomimeFolderUnsubscribeCompleted notification (and call -folderUnsubscribeCompleted: on the delegate, if any) if it succeeded. If not, it will post a PantomimeFolderUnsubscribeFailed notification (and call -folderUnsubscribeFailed: on the delegate, if any)

Member Data

_currentQueueObject

_folders

_folderSeparator

_folderStatus

_openFolders

_selectedFolder

_subscribedFolders

_tag

private

CWIMAPQueueObject *_currentQueueObject; 

private

NSMutableDictionary *_folders; 

private

unichar _folderSeparator; 

private

NSMutableDictionary *_folderStatus; 

private

NSMutableDictionary *_openFolders; 

private

CWIMAPFolder *_selectedFolder; 

private

NSMutableArray *_subscribedFolders; 

private

int _tag;