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

pop3_list

Example: pop3_list Post Office Protocol Vuser Functions (POP3)

Lists the messages on the POP3 server.

long pop3_list( char *transaction, [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, "".
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_list function lists the messages on the POP3 server. It returns the total number of messages that are available on the server.

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

You cannot use standard parameterization for any arguments in this function.