9 POP3: Reading Mail
| ||||||
| sender : output-port? | ||||||
| receiver : input-port? | ||||||
| server : string? | ||||||
| port : (integer-in 0 65535) | ||||||
| state : (one-of/c 'disconnected 'authorization 'transaction) |
Once a connection to a POP-3 server has been established, its state is
stored in a communicator instance, and other procedures take
communicator instances as an argument.
| (connect-to-server server [port-number]) → communicator? |
| server : string? |
| port-number : (integer-in 0 65535) = 110 |
Connects to server at port-number.
| (disconnect-from-server communicator) → void? |
| communicator : communicator? |
Disconnects communicator from the server, and sets
communicator’s state to 'disconnected.
| |||||||||||||||||||||
| user : string? | |||||||||||||||||||||
| passwd : string? | |||||||||||||||||||||
| communicator : communicator? |
Authenticates using user and passwd. If
authentication is successful, communicator’s state is set to
'transaction.
| |||||||
| communicator : communicator? |
Returns the number of messages and the number of octets in the
mailbox.
| ||||||||
| ||||||||
| communicator : communicator? | ||||||||
| message-number : exact-integer? |
Given a message number, returns a list of message-header lines and
list of message-body lines.
| ||||||||
| ||||||||
| communicator : communicator? | ||||||||
| message-number : exact-integer? |
Given a message number, returns a list of message-header lines.
| ||||||||
| ||||||||
| communicator : communicator? | ||||||||
| message-number : exact-integer? |
Given a message number, returns a list of message-body lines.
| ||||||||||||||
| communicator : communicator? | ||||||||||||||
| message-number : exact-integer? |
Deletes the specified message.
| ||||||||||||||
| communicator : communicator? | ||||||||||||||
| message-number : exact-integer? |
Gets the server’s unique id for a particular message.
| (get-unique-id/all communicator) |
| → (listof (cons/c exact-integer? string?)) |
| communicator : communicator? |
Gets a list of unique id’s from the server for all the messages in the
mailbox. The car of each item in the result list is the
message number, and the cdr of each item is the message’s
id.
| (make-desired-header tag-string) → regexp? |
| tag-string : string? |
Takes a header field’s tag and returns a regexp to match the field
| (extract-desired-headers header desireds) → (listof string?) |
| header : (listof string?) |
| desireds : (listof regexp?) |
Given a list of header lines and of desired regexps, returns the
header lines that match any of the desireds.
9.1 Exceptions
The supertype of all POP3 exceptions.
|
Raised when a connection to a server cannot be established.
|
Raised if the username is rejected.
|
Raised if the password is rejected.
| ||||||
| communicator : communicator? |
Raised when the communicator is not in transaction mode.
| ||||||
| communicator : communicator? | ||||||
| message : exact-integer? |
Raised when the server does not respond with headers for a message as
requested.
| ||||||
| communicator : communicator? | ||||||
| message : exact-integer? |
Raised when the client specifies an illegal message number.
| ||||||
| communicator : communicator? | ||||||
| message : exact-integer? |
Raised when the server is unable to delete a message.
| ||||||
| communicator : communicator? |
Raised when the server does not gracefully disconnect.
| ||||||
| communicator : communicator? |
Raised when the server produces a mal-formed response.
9.2 Example Session
| > (require net/pop3) |
| > (define c (connect-to-server "cs.rice.edu")) |
| > (authenticate/plain-text "scheme" "********" c) |
| > (get-mailbox-status c) |
| 196 |
| 816400 |
| > (get-message/headers c 100) |
| ("Date: Thu, 6 Nov 1997 12:34:18 -0600 (CST)" |
| "Message-Id: <199711061834.MAA11961@new-world.cs.rice.edu>" |
| "From: Shriram Krishnamurthi <shriram@cs.rice.edu>" |
| .... |
| "Status: RO") |
| > (get-message/complete c 100) |
| ("Date: Thu, 6 Nov 1997 12:34:18 -0600 (CST)" |
| "Message-Id: <199711061834.MAA11961@new-world.cs.rice.edu>" |
| "From: Shriram Krishnamurthi <shriram@cs.rice.edu>" |
| .... |
| "Status: RO") |
| ("some body" "text" "goes" "." "here" "." "") |
| > (get-unique-id/single c 205) |
| no message numbered 205 available for unique id |
| > (list-tail (get-unique-id/all c) 194) |
| ((195 . "e24d13c7ef050000") (196 . "3ad2767070050000")) |
| > (get-unique-id/single c 196) |
| "3ad2767070050000" |
| > (disconnect-from-server c) |
9.3 POP3 Unit
| (require net/pop3-unit) |
| pop3@ : unit? |
Imports nothing, exports pop3^.
9.4 POP3 Signature
| (require net/pop3-sig) |
| pop3^ : signature |
Includes everything exported by the net/pop3 module.