Retrieve Method

Retrieves a message specified by MessageNumber from the server.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int Retrieve();

Unicode (Windows)
INT Retrieve();

- (void)retrieve;

#define MID_POP_RETRIEVE 12

IPWORKS_EXTERNAL int IPWORKS_CALL IPWorks_POP_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method is used to retrieve a message specified by MessageNumber from the server. It asks the MailServer to retrieve the message specified by MessageNumber. The message headers will arrive in the Header event, and the message text will arrive in the Transfer event.

The MaxLines property defines the number of lines retrieved.

Example (Connect and Retrieve Message)

POPControl.MailServer = "MyPOPServer"
POPControl.User = "username"
POPControl.Password = "password"
POPControl.Connect()

POPControl.MessageNumber = 1
POPControl.Retrieve()

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)