This is the cl-pop Reference Manual, version 0.2.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 04:13:36 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-pop0.2.0
usocket (system).
cl-ppcre (system).
package.lisp (file).
cl-pop.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-pop/cl-pop.lisppackage.lisp (file).
cl-pop (system).
close-pop-connection (function).
delete-pop-message (function).
message-count (function).
message-headers (function).
open-pop-connection (function).
retrieve-pop-message (function).
save-message (function).
send-pop-dele (function).
send-pop-list (function).
send-pop-noop (function).
send-pop-quit (function).
send-pop-retr (function).
send-pop-rset (function).
send-pop-stat (function).
send-pop-top (function).
send-pop-uidl (function).
with-pop-connection (macro).
*pop-debug? (special variable).
*termination-string* (special variable).
authorize-pop-connection (function).
break-pop-response (function).
clean-pop-message (function).
host (reader method).
parse-raw-message-headers (function).
password (reader method).
pop-connection (class).
port (reader method).
print-debug (macro).
read-multi-line-pop-response (method).
read-single-pop-response (method).
send-pop-command (function).
socket (reader method).
(setf socket) (writer method).
socket-stream (reader method).
(setf socket-stream) (writer method).
state (reader method).
(setf state) (writer method).
username (reader method).
Packages are listed by definition order.
cl-popcl-ppcre.
common-lisp.
close-pop-connection (function).
delete-pop-message (function).
message-count (function).
message-headers (function).
open-pop-connection (function).
retrieve-pop-message (function).
save-message (function).
send-pop-dele (function).
send-pop-list (function).
send-pop-noop (function).
send-pop-quit (function).
send-pop-retr (function).
send-pop-rset (function).
send-pop-stat (function).
send-pop-top (function).
send-pop-uidl (function).
with-pop-connection (macro).
*pop-debug? (special variable).
*termination-string* (special variable).
authorize-pop-connection (function).
break-pop-response (function).
clean-pop-message (function).
host (generic reader).
parse-raw-message-headers (function).
password (generic reader).
pop-connection (class).
port (generic reader).
print-debug (macro).
read-multi-line-pop-response (generic function).
read-single-pop-response (generic function).
send-pop-command (function).
socket (generic reader).
(setf socket) (generic writer).
socket-stream (generic reader).
(setf socket-stream) (generic writer).
state (generic reader).
(setf state) (generic writer).
username (generic reader).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Mark the given message number for deletion
Number of message currently in the mailbox
Returns an assoc list of the email headers, if duplicate or multiline headers are present, they will be appended togther to form one associated pair
Returns a plist of the message with :header containing the parsed header fields and body containing a list where each element in the list is a string representing 1 line of the message. If a max-size is providing in bytes the message size is checked first if it is greater then the max nil is returned
Saves message’s entire contents including headers into a file with the given pathname
conn - pop connection class
message-num - pop message number to mark for deletion
Mark the given message number for deletion. Deletion occurs when the Quit Command is given
Conn – pop-connection instance,
Message-num – integer, number of desired message optional
Returns list of lists where the first atom is the message number and the second is the message size. If a message number is provided only the list for that particular message will be return.
conn - pop-conneciton instance Sends a no operation command
Ends the connection on the server
Retrieves the entire message and returns a list where each atom in the list is one line in the file. It is recommended that one uses the retrieve-pop-message function instead which offers a check for large mail messages.
conn - pop connection class
Reset all messages that have been marked for deletion
conn - pop-connection instance
Executes the pop stat command, returns a list if successful, with the number of messages in the mailbox and their combined size
Retrieves the messages header for the given message num and the first # of lines of the body of the message as determined by the line-count input
conn - pop-connection instance
message-num (optional) if given only return list for this message
Returns a list of lists, where the first element is the message num and the second is the unique id number for that message. If a message num is given only that individual messages information is returned
Separate answers into their individual components. would be faster to use regular expressions, but this keeps to pop package lighter. The integers key can be set to t if the answer is known to be a list of integers
Removes status key and end of line characters from string
pop-connection)) ¶automatically generated reader method
host.
pop-connection)) ¶automatically generated reader method
pop-connection)) ¶automatically generated reader method
port.
Reads a 1 line pop response, and returns two values, the first is whether the response came back as positive, the second is the information / message of the response.
pop-connection)) ¶automatically generated reader method
pop-connection)) ¶automatically generated writer method
pop-connection)) ¶automatically generated reader method
pop-connection)) ¶automatically generated writer method
pop-connection)) ¶pop-connection)) ¶Current state of the connection options are :disconnected, :connected
pop-connection)) ¶automatically generated reader method
| Jump to: | (
A B C D F G H M O P R S U W |
|---|
| Jump to: | (
A B C D F G H M O P R S U W |
|---|
| Jump to: | *
H P S U |
|---|
| Jump to: | *
H P S U |
|---|
| Jump to: | C F P S |
|---|
| Jump to: | C F P S |
|---|