FETCH_BODY_PART structure

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

Contains a partial message body returned by the Internet Message Access Protocol (IMAP) server in a FETCH response. The FETCH_CMD_RESULTS or FETCH_CMD_RESULTS_EX structure contains data about the entire FETCH response when it is complete.

Syntax

typedef struct tagFETCH_BODY_PART {
  DWORD  dwMsgSeqNum;
  LPSTR  pszBodyTag;
  DWORD  dwTotalBytes;
  DWORD  dwSizeOfData;
  DWORD  dwOffset;
  BOOL   fDone;
  LPSTR  pszData;
  LPARAM lpFetchCookie1;
  LPARAM lpFetchCookie2;
} FETCH_BODY_PART;

Members

dwMsgSeqNum

Type: DWORD

Contains a DWORD that contains the message sequence number for the message being received. The IMAP transport initializes this parameter to zero.

pszBodyTag

Type: LPSTR

Contains an LPSTR that contains the IMAP tag identifying this body section and is equivalent to "msg_att" defined in the "Formal Syntax" section of RFC 2060 (for example, "RFC822.PEEK", or "BODY[2.2]<0.2048>"). The transport terminates the tag at the first space character, so "BODY[HEADER.FIELDS (string)]" returns as "BODY[HEADER.FIELDS". The IMAP transport initializes this parameter to NULL.

dwTotalBytes

Type: DWORD

Contains a DWORD that indicates the total number of bytes expected for the received body part. The IMAP transport initializes this parameter to zero.

dwSizeOfData

Type: DWORD

Contains a DWORD that indicates the number of bytes pointed to by pszData. The IMAP transport initializes this parameter to zero.

dwOffset

Type: DWORD

Contains a DWORD that indicates the offset of the start of the data buffer. The IMAP transport initializes this parameter to zero.

fDone

Type: BOOL

Contains a BOOL that indicates whether this is the last part of the message body. The IMAP transport initializes this parameter to FALSE.

pszData

Type: LPSTR

Contains an LPSTR that contains the received partial message body data. The IMAP transport initializes this parameter to NULL.

lpFetchCookie1

Type: LPARAM

Contains an LPARAM that contains a user-settable value that persists throughout the FETCH response, that is, for all FETCH_BODY_PART responses (even if multiple partial message bodies are fetched) and for the final FETCH_CMD_RESULTS or FETCH_CMD_RESULTS_EX structure. IMAPTransport initializes this parameter to zero.

lpFetchCookie2

Type: LPARAM

Contains an LPARAM that contains a user-settable value that persists throughout the FETCH response, that is, for all FETCH_BODY_PART responses (even if multiple partial message bodies are fetched) and for the final FETCH_CMD_RESULTS or FETCH_CMD_RESULTS_EX structure. IMAPTransport initializes this parameter to zero.

Requirements