Share via


IMAP_RESPONSE_TYPE enumeration

[IMAP_RESPONSE_TYPE is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions.]

Identifies the types of server responses. The IMAP_RESPONSE_DATA structure is populated based on a value from this enumeration.

Syntax

typedef enum tagIMAP_RESPONSE_TYPE { 
  irtERROR_NOTIFICATION  = 0,
  irtCOMMAND_COMPLETION  = 1,
  irtSERVER_ALERT        = 2,
  irtPARSE_ERROR         = 3,
  irtMAILBOX_UPDATE      = 4,
  irtDELETED_MSG         = 5,
  irtFETCH_BODY          = 6,
  irtUPDATE_MSG          = 7,
  irtAPPLICABLE_FLAGS    = 8,
  irtPERMANENT_FLAGS     = 9,
  irtUIDVALIDITY         = 10,
  irtREADWRITE_STATUS    = 11,
  irtTRYCREATE           = 12,
  irtSEARCH              = 13,
  irtMAILBOX_LISTING     = 14,
  irtMAILBOX_STATUS      = 15,
  irtAPPEND_PROGRESS     = 16,
  irtUPDATE_MSG_EX       = 17
} ACCESSTYPE;

Constants

irtERROR_NOTIFICATION

Indicates an error has been encountered while parsing the server response.

irtCOMMAND_COMPLETION

Indicates the IMAP command has completed. If the command failed, IMAP_RESPONSE.lpszResponseText contains the failure message.

irtSERVER_ALERT

Indicates that the server has returned an ALERT response code. IMAP_RESPONSE.lpszResponseText contains the text of the alert.

irtPARSE_ERROR

Indicates that the server has returned a PARSE response code. IMAP_RESPONSE.lpszResponseText contains the text of the parsing error.

irtMAILBOX_UPDATE

Indicates that the server has returned an EXISTS, RECENT, or UNSEEN response. IMAP_RESPONSE_DATA.pmcMsgCount contains the response data.

irtDELETED_MSG

Indicates that the server has returned an EXPUNGE response. IMAP_RESPONSE_DATA.dwDeletedMsgSeqNum contains the response data.

irtFETCH_BODY

Indicates that the server has returned a partial message body in a FETCH response. IMAP_RESPONSE_DATA.pFetchBodyPart contains the response data.

irtUPDATE_MSG

Indicates that the server has returned a FETCH response and IMAP_FETCHEX_DISABLE is the current value of the persisted IMAPTransport extended fetch flag. The client can change the flag value with the EnableFetchEx method. IMAP_RESPONSE_DATA.pFetchResults contains the response data.

irtAPPLICABLE_FLAGS

Indicates that the server has returned a FLAGS response with a list of flags that apply to the current mailbox. IMAP_RESPONSE_DATA.imfImapMessageFlags contains the response data.

irtPERMANENT_FLAGS

Indicates that the server has returned a PERMANENTFLAGS response code with a list of flags that can be permanently changed by the client. IMAP_RESPONSE_DATA.imfImapMessageFlags contains the response data.

irtUIDVALIDITY

Indicates that the server has returned a UIDVALIDITY response code. IMAP_RESPONSE_DATA.dwUIDValidity contains the response data.

irtREADWRITE_STATUS

Indicates that the server has returned either a READ-WRITE or READ-ONLY response code. IMAP_RESPONSE_DATA.bReadWrite indicates which response code the server returned.

irtTRYCREATE

Indicates that the server has returned a TRYCREATE response code. IMAP_RESPONSE.lpszResponseText contains the text of the response code.

irtSEARCH

Indicates that the server has returned a SEARCH response. IMAP_RESPONSE_DATA.prlSearchResults indicates the returned message sequence numbers.

irtMAILBOX_LISTING

Indicates that the server has returned either a LIST or LSUB response. IMAP_RESPONSE_DATA.illrdMailboxListing contains the response data.

irtMAILBOX_STATUS

Indicates that the server has returned a STATUS response. IMAP_RESPONSE_DATA.pisrStatusResponse contains the response data.

irtAPPEND_PROGRESS

Indicates that the progress of an uploaded stream is available. IMAP_RESPONSE_DATA.papAppendProgress contains the response data.

irtUPDATE_MSG_EX

Indicates that the server has returned a FETCH response and IMAP_FETCHEX_ENABLE is the current value of the persisted IMAPTransport extended fetch flag. The client can change the flag value with the EnableFetchEx method. IMAP_RESPONSE_DATA.pFetchResultsEx contains the response data.

Requirements

Minimum supported client
Windows XP [desktop apps only]
Minimum supported server
Windows Server 2003 [desktop apps only]
Product
Outlook Express 6.0
Header
Imnxport.h
IDL
Imnxport.idl