Share this page

# pop3_logon

Post Office Protocol Vuser Functions (POP3)

Logs on to a POP3 server.

    int pop3_logon( char *transaction, char *url, [char* LocalAddr, char* STARTTLS ,] 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, "".
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 function logs on to a POP3 server. It uses the format used by the FTP protocol.

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

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: url

## Example

In the following example, the pop3_logon function logs onto the techno server.

    ...

    // Logon to the POP3 server

    pop3_logon("Login",
            "URL=pop3://user0004t:my_pwd@techno.merc-int.com",
            LAST );

    // Send a "UIDL 1" command to the server

    pop3_command("UID_Command", "Command=UIDL 1", LAST );

    ...

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