Post Office Protocol Vuser Functions (POP3) > Alphabetical List of Functions > pop3_delete

pop3_delete

Example: pop3_delete Post Office Protocol Vuser Functions (POP3)

Deletes messages on the POP3 server.

long pop3_delete( char *transaction, char *deleteList, [char *save_to_param,] LAST );
transaction A transaction name for this step in quotes. To instruct VuGen not to create a transaction for this step, use a NULL string, "".
deleteList The messages to delete. Use the following format: "DeleteList=message1,message2,mesage3..." where each message is a 1-based index of the message in the list.
To delete all messages, use "DeleteList=All"
save_to_param Saves the data returned by the server to a parameter. Use the format:
"SaveTo=ParameterName"
This parameter is optional.
LAST A marker indicating the end of the argument list.

The pop3_delete function deletes messages on the POP3 server.

This function is for use with global sessions. For multiple sessions, use the pop3_delete_ex function, which allows you to specify a session identifier.

Return Values

If this function succeeds, it returns LR_PASS. Otherwise, it returns LR_FAIL.

Parameterization

The following argument(s) can be parameterized with standard parameterization: deleteList