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

pop3_command

Example: pop3_command Post Office Protocol Vuser Functions (POP3)

Sends a command to the POP3 server.

long pop3_command( char *transaction, char *command, [char *command,] [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, "".
command One or more commands to send to the server in the following format:"Command=command1", "Command=command2"...
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_command function sends a command to the POP3 server. The server returns the result of the command. For example, if you send the command "UIDL 1", the server returns the unique ID of the first message.

The pop3_command function cannot handle multi-line server responses. For example, it cannot handle the responses to UIDL, RETR, or LIST commands.

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