Share this page

# pop3_logon_ex

Post Office Protocol Vuser Functions (POP3)

Logs on to a POP3 server for a specific session.

    int pop3_logon_ex( POP3 *pppop3, char *transaction, char *url, [char* LocalAddr, char* STARTTLS,] 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, "".
url | The URL of the POP3 server, in the FTP format style:`"`URL=pop3://username:password@server[:port]`" "`URL=pop3s://username:password@server[:port]`"`
LocalAddr | Optional: Sets the preferred IP address of the client <ip_addr>[:<port>]. This option is useful for IP spoofing. Use the following format: "LocalAddr=199.123.123.123"
STARTTLS | Optional: Indicates that POP3's StartTLS (Start Transport Layer Security) extension must be activated on the session. If the parameter is set, then the POP3 protocol's 'STARTTLS' command will be issued on the session during logon and connection will be switched to TLS mode. Use the following format : "STARTTLS"
LAST | A marker indicating the end of the argument list.

The pop3_logon_ex function logs on to a POP3 server for a specific session. It uses the format used by the FTP protocol.

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

## Example

In the following example, the pop3_logon_ex function logs on to the POP3 server.

Copy code

    ...
    // Logon to the POP3 server
    pop3_logon_ex(&pppop3, "Login",
                "URL=pop3://user4t:my_pwd@techno.merc-int.com",
                LAST );
    // Send a "UIDL 1" command to the server
    pop3_command_ex(&pppop3, "UID_Command",
                "Command=UIDL 1",
                LAST );

Tips to improve your search results... VuGen Function Reference Version 26.1-26.3 Function Reference 26.1-26.3 All View Local Help Center View Online Help Center Version: