POP3RESPONSE structure

[The POP3RESPONSE structure is available for use in Windows XP. It might be altered or unavailable in subsequent versions.]

Do not use. Contains information about a Post Office Protocol version 3 (POP3) response.

Syntax

typedef struct tagPOP3RESPONSE {
  POP3COMMAND    command;
  BOOL           fDone;
  IXPRESULT      rIxpResult;
  IPOP3Transport *pTransport;
  BOOL           fValidInfo;
  union {
    POP3UIDL rUidlInfo;
    POP3STAT rStatInfo;
    POP3LIST rListInfo;
    DWORD    dwPopId;
    POP3RETR rRetrInfo;
    POP3TOP  rTopInfo;
  };
} POP3RESPONSE, *LPPOP3RESPONSE;

Members

command

Type: POP3COMMAND

Contains the POP3COMMAND for which the response was generated.

fDone

Type: BOOL

Contains a BOOL that indicates whether the command finished. The client should wait until this member is TRUE before issuing another POP3 command through the IPOP3Transport object.

rIxpResult

Type: IXPRESULT

Contains an IXPRESULT structure that contains the information about the server response. If rIxpResult.hrResult specifies a FAILED result, the structure contains other information.

pTransport

Type: IPOP3Transport*

Contains a pointer to the IPOP3Transport object that generated the OnResponse call.

fValidInfo

Type: BOOL

Contains a BOOL that indicates whether the data in the union is valid. This parameter has a value of FALSE when the received response has no data.

rUidlInfo

Type: POP3UIDL

Occupies the union when command is equal to POP3_UIDL. Contains the POP3UIDL structure that holds the response data.

rStatInfo

Type: POP3STAT

Occupies the union when command is equal to POP3_STAT. Contains the POP3STAT structure that holds the response data.

rListInfo

Type: POP3LIST

Occupies the union when command is equal to POP3_LIST. Contains the POP3LIST structure that holds the response data.

dwPopId

Type: DWORD

Occupies the union when command is equal to POP3_DELE. Contains a DWORD that holds the success or error message from the DELE command.

rRetrInfo

Type: POP3RETR

Occupies the union when command is equal to POP3_RETR. Contains the POP3RETR structure that holds the response data.

rTopInfo

Type: POP3TOP

Occupies the union when command is equal to POP3_TOP. Contains the POP3TOP structure that holds the response data.

Requirements