pop3_free_ex

Post Office Protocol Vuser Functions (POP3)

Frees the POP3 server for a specific session.

void pop3_free_ex( POP3 *pppop3 );
pppop3 A session identifier.

The pop3_free_ex function frees up the POP3 server for a specific session, and cancels all of the pending commands.

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

Example

In the following example, the pop3_free function frees up the POP3 server.

...
// Logon to the POP3 server
pop3_logon_ex(&pppop3, "Login", "
        URL=pop3://user0004t:my_pwd@techno.merc-int.com",
        LAST );
// Retrieve all messages on the server without deleting any of them
pop3_retrieve_ex(&pppop3, "POP3", "RetrieveList=ALL", "DeleteMail=false", LAST );
// Free up the server
pop3_free_ex(&pppop3);
...