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

pop3_delete_ex

Example: pop3_delete_ex Post Office Protocol Vuser Functions (POP3)

Deletes messages on the POP3 server for a specific session.

long pop3_delete_ex( POP3 *pppop3, char *transaction, char *deleteList, LAST );
pppop3 A session identifier.
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"
LAST A marker indicating the end of the argument list.

The pop3_delete_ex function deletes messages on the POP3 server for a specific session.

This function is for use with multiple sessions. For global sessions, use the pop3_delete function, which leaves out the 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