Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Logs the user into the system (the POP3 server).

...

Files

...

pop3-c.h/pop3-c.c

...

Prototype

...

1049575 CPU_CHAR *username, CPU_CHAR *pswd, NET_ERR *perr);
HTML Table
classCode_Listing
Table Row (tr)
Table Cell (td)
rowspan5
Anchor
1049575
Code Block
void  POP3c_Authenticate (NET_SOCK_ID
sock,
Anchor
10495761049576
Anchor
10495771049577
Anchor
10495781049578
Table Row (tr)
Table Row (tr)
Table Row (tr)
Table Row (tr)

...

   sock,
                          CPU_CHAR     *username,
                          CPU_CHAR     *pswd,
                          NET_ERR      *perr);

Arguments

sock

Socket ID returned by POP3c_Connect().

Anchor10495901049590username 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

...

.


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

Anchor10496081049608 See section 3-3 “µC/POP3cExample Code” on page 7See Sample Application.