Logs the user into the system (the POP3 server).
Files
pop3-c.h/pop3-c.c
Prototype
Code Block |
---|
void POP3c_Authenticate (NET_SOCK_ID sock,
CPU_CHAR *username,
CPU_CHAR *pswd,
NET_ERR *perr); |
Arguments
sock
Socket ID returned by POP3c_Connect()
.
username
Username on the POP3 server, or NULL
if not needed.
pswd
Password associated with the previous username, or NULL
if not needed.
perr
Pointer to a variable that will hold the return error code from this function:
POP3c_ERR_NONE
POP3c_ERR_ARG_TOO_LONG
POP3c_ERR_NEG_RESP
POP3c_ERR_RX_FAILED
.
Returned Values
None.
Required Configuration
None.
Notes / Warnings
- As stated in RFC #1939, Section ‘Basic Operation’, “Each argument may be up to 40 characters long”. Passing a
NULL
argument for either the username of the password result in the associate command not to be send to the server.
Example Usage
...
See Sample Application.