CWIMAPStore.h

Use the links in the table of contents to the left to access the documentation.

Includes <Pantomime/CWConnection.h>, <Pantomime/CWConstants.h>, <Pantomime/CWService.h>, <Pantomime/CWStore.h>, <Foundation/NSArray.h>, <Foundation/NSDictionary.h>, <Foundation/NSObject.h>, <Foundation/NSString.h>

Classes

CWConnection
CWFlags
CWIMAPCacheManager
CWIMAPFolder
CWIMAPMessage
CWIMAPQueueObject
CWIMAPStore: Pantomime IMAP client code.
CWTCPConnection

Typedefs

IMAPCommand: Supported IMAP commands.

IMAPCommand

Supported IMAP commands.

  typedef enum { 
    IMAP_APPEND = 0x1, 
    IMAP_AUTHENTICATE_CRAM_MD5, 
    IMAP_AUTHENTICATE_LOGIN, 
    IMAP_AUTHORIZATION, 
    IMAP_CAPABILITY, 
    IMAP_CLOSE, 
    IMAP_CREATE, 
    IMAP_DELETE, 
    IMAP_EXAMINE, 
    IMAP_EXPUNGE, 
    IMAP_LIST, 
    IMAP_LOGIN, 
    IMAP_LOGOUT, 
    IMAP_LSUB, 
    IMAP_NOOP, 
    IMAP_RENAME, 
    IMAP_SELECT, 
    IMAP_STARTTLS, 
    IMAP_STATUS, 
    IMAP_SUBSCRIBE, 
    IMAP_UID_COPY, 
    IMAP_UID_FETCH_BODY_TEXT, 
    IMAP_UID_FETCH_HEADER_FIELDS, 
    IMAP_UID_FETCH_HEADER_FIELDS_NOT, 
    IMAP_UID_FETCH_RFC822, 
    IMAP_UID_SEARCH, 
    IMAP_UID_SEARCH_ALL, 
    IMAP_UID_SEARCH_ANSWERED, 
    IMAP_UID_SEARCH_FLAGGED, 
    IMAP_UID_SEARCH_UNSEEN, 
    IMAP_UID_STORE, 
    IMAP_UNSUBSCRIBE, 
    IMAP_EMPTY_QUEUE 
} IMAPCommand;

Constants

IMAP_APPEND: The IMAP APPEND command - see 6.3.11. APPEND Command of RFC 3501.
IMAP_AUTHENTICATE_CRAM_MD5: CRAM-MD5 authentication.
IMAP_AUTHENTICATE_LOGIN: LOGIN authentication
IMAP_AUTHORIZATION: Special command so that we know we are in the authorization state.
IMAP_CAPABILITY: The IMAP CAPABILITY command - see 6.1.1. CAPABILITY Command of RFC 3501.
IMAP_CLOSE: The IMAP CLOSE command - see 6.4.2. CLOSE Command of RFC 3501.
IMAP_CREATE: The IMAP CREATE command - see 6.3.3. CREATE Command of RFC 3501.
IMAP_DELETE: The IMAP DELETE command - see 6.3.4. DELETE Command of RFC 3501.
IMAP_EXAMINE: The IMAP EXAMINE command - see 6.3.2. EXAMINE Command of RFC 3501.
IMAP_EXPUNGE: The IMAP EXPUNGE command - see 6.4.3. EXPUNGE Command of RFC 3501.
IMAP_LIST: The IMAP LIST command - see 6.3.8. LIST Command of RFC 3501.
IMAP_LOGIN: The IMAP LOGIN command - see 6.2.3. LOGIN Command of RFC 3501.
IMAP_LOGOUT: The IMAP LOGOUT command - see 6.1.3. LOGOUT Command of RFC 3501.
IMAP_LSUB: The IMAP LSUB command - see 6.3.9. LSUB Command of RFC 3501.
IMAP_NOOP: The IMAP NOOP command - see 6.1.2. NOOP Command of RFC 3501.
IMAP_RENAME: The IMAP RENAME command - see 6.3.5. RENAME Command of RFC 3501.
IMAP_SELECT: The IMAP SELECT command - see 6.3.1. SELECT Command of RFC 3501.
IMAP_STARTTLS: The STARTTLS IMAP command - see RFC2595.
IMAP_STATUS: The IMAP STATUS command - see 6.3.10. STATUS Command of RFC 3501.
IMAP_SUBSCRIBE: The IMAP SUBSCRIBE command - see 6.3.6. SUBSCRIBE Command of RFC 3501.
IMAP_UID_COPY: The IMAP COPY command - see 6.4.7. COPY Command of RFC 3501.
IMAP_UID_FETCH_BODY_TEXT: The IMAP FETCH command - see 6.4.5. FETCH Command of RFC 3501.
IMAP_UID_FETCH_HEADER_FIELDS: The IMAP FETCH command - see 6.4.5. FETCH Command of RFC 3501.
IMAP_UID_FETCH_HEADER_FIELDS_NOT: The IMAP FETCH command - see 6.4.5. FETCH Command of RFC 3501.
IMAP_UID_FETCH_RFC822: The IMAP FETCH command - see 6.4.5. FETCH Command of RFC 3501.
IMAP_UID_SEARCH: The IMAP SEARCH command - see 6.4.4. SEARCH Command of RFC 3501. Used to update the IMAP Folder cache.
IMAP_UID_SEARCH_ALL: The IMAP SEARCH command - see 6.4.4. SEARCH Command of RFC 3501.
IMAP_UID_SEARCH_ANSWERED: Special command used to update the IMAP Folder cache.
IMAP_UID_SEARCH_FLAGGED: Special command used to update the IMAP Folder cache.
IMAP_UID_SEARCH_UNSEEN: Special command used to update the IMAP Folder cache.
IMAP_UID_STORE: The IMAP STORE command - see 6.4.6. STORE Command of RFC 3501.
IMAP_UNSUBSCRIBE: The IMAP UNSUBSCRIBE command - see 6.3.7. UNSUBSCRIBE Command of RFC 3501.
IMAP_EMPTY_QUEUE: Special command to empty the command queue.

Discussion

This enum lists the supported IMAP commands available in Pantomime's IMAP client code.

Globals

PantomimeFolderStatusCompleted
PantomimeFolderStatusFailed
PantomimeFolderSubscribeCompleted
PantomimeFolderSubscribeFailed
PantomimeFolderUnsubscribeCompleted
PantomimeFolderUnsubscribeFailed

PantomimeFolderStatusCompleted

extern NSString *PantomimeFolderStatusCompleted;

PantomimeFolderStatusFailed

extern NSString *PantomimeFolderStatusFailed;

PantomimeFolderSubscribeCompleted

extern NSString *PantomimeFolderSubscribeCompleted;

PantomimeFolderSubscribeFailed

extern NSString *PantomimeFolderSubscribeFailed;

PantomimeFolderUnsubscribeCompleted

extern NSString *PantomimeFolderUnsubscribeCompleted;

PantomimeFolderUnsubscribeFailed

extern NSString *PantomimeFolderUnsubscribeFailed;

Macro Definitions

_Pantomime_H_CWIMAPStore

_Pantomime_H_CWIMAPStore

#define _Pantomime_H_CWIMAPStore

Last Updated: Wednesday, 13 April 2022