The cl-pop Reference Manual

This is the cl-pop Reference Manual, version 0.2.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 04:04:14 2022 GMT+0.

1 Systems

The main system appears first, followed by any subsystem dependency.

cl-pop

1.1 `cl-pop`

Version

0.2.0

Dependencies

usocket (system).
cl-ppcre (system).

Source

cl-pop.asd.

Child Components

package.lisp (file).
cl-pop.lisp (file).

2 Files

Files are sorted by type and then listed depth-first from the systems components trees.

Lisp

2.1.1 `cl-pop/cl-pop.asd`

Source: cl-pop.asd.
Parent Component: cl-pop (system).
ASDF Systems: cl-pop.

2.1.2 `cl-pop/package.lisp`

Source: cl-pop.asd.
Parent Component: cl-pop (system).
Packages: cl-pop.

2.1.3 `cl-pop/cl-pop.lisp`

Dependency

package.lisp (file).

Source

cl-pop.asd.

Parent Component

cl-pop (system).

Public Interface

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).

Internals

*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).

3 Packages

Packages are listed by definition order.

cl-pop

3.1 `cl-pop`

Source

package.lisp.

Use List

cl-ppcre.
common-lisp.

Public Interface

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).

Internals

*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).

4 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

Public Interface
Internals

4.1 Public Interface

Macros
Ordinary functions

4.1.1 Macros

Macro: with-pop-connection ((var &rest args) &body body) ¶

Package: cl-pop.
Source: cl-pop.lisp.

4.1.2 Ordinary functions

Function: close-pop-connection (conn) ¶

Package: cl-pop.
Source: cl-pop.lisp.

Function: delete-pop-message (conn message-num) ¶

Mark the given message number for deletion

Package: cl-pop.
Source: cl-pop.lisp.

Function: message-count (conn) ¶

Number of message currently in the mailbox

Package: cl-pop.
Source: cl-pop.lisp.

Function: message-headers (conn message-num) ¶

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

Package: cl-pop.
Source: cl-pop.lisp.

Function: open-pop-connection (&key host port username password) ¶

Package: cl-pop.
Source: cl-pop.lisp.

Function: retrieve-pop-message (conn message-num &key max-size) ¶

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

Package: cl-pop.
Source: cl-pop.lisp.

Function: save-message (conn message-num pathname) ¶

Saves message’s entire contents including headers into a file with the given pathname

Package: cl-pop.
Source: cl-pop.lisp.

Function: send-pop-dele (conn message-num) ¶

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

Package: cl-pop.
Source: cl-pop.lisp.

Function: send-pop-list (conn &optional message-num) ¶

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.

Package: cl-pop.
Source: cl-pop.lisp.

Function: send-pop-noop (conn) ¶

conn - pop-conneciton instance Sends a no operation command

Package: cl-pop.
Source: cl-pop.lisp.

Function: send-pop-quit (conn) ¶

Ends the connection on the server

Package: cl-pop.
Source: cl-pop.lisp.

Function: send-pop-retr (conn message-num) ¶

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.

Package: cl-pop.
Source: cl-pop.lisp.

Function: send-pop-rset (conn) ¶

conn - pop connection class
Reset all messages that have been marked for deletion

Package: cl-pop.
Source: cl-pop.lisp.

Function: send-pop-stat (conn) ¶

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

Package: cl-pop.
Source: cl-pop.lisp.

Function: send-pop-top (conn message-num line-count) ¶

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

Package: cl-pop.
Source: cl-pop.lisp.

Function: send-pop-uidl (conn &optional message-num) ¶

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

Package: cl-pop.
Source: cl-pop.lisp.

4.2 Internals

Special variables
Macros
Ordinary functions
Generic functions
Classes

4.2.1 Special variables

Special Variable: *pop-debug? ¶

Package: cl-pop.
Source: cl-pop.lisp.

Special Variable: *termination-string* ¶

Package: cl-pop.
Source: cl-pop.lisp.

4.2.2 Macros

Macro: print-debug (str) ¶

Debuging tool

Package: cl-pop.
Source: cl-pop.lisp.

4.2.3 Ordinary functions

Function: authorize-pop-connection (conn) ¶

Package: cl-pop.
Source: cl-pop.lisp.

Function: break-pop-response (str &key integers) ¶

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

Package: cl-pop.
Source: cl-pop.lisp.

Function: clean-pop-message (str start &key mask-dot?) ¶

Removes status key and end of line characters from string

Package: cl-pop.
Source: cl-pop.lisp.

Function: parse-raw-message-headers (headers) ¶

Package: cl-pop.
Source: cl-pop.lisp.

Function: send-pop-command (conn command) ¶

Package: cl-pop.
Source: cl-pop.lisp.

4.2.4 Generic functions

Generic Reader: host (object) ¶

Package

cl-pop.

Methods

Reader Method: host ((pop-connection pop-connection)) ¶

automatically generated reader method

Source: cl-pop.lisp.
Target Slot: host.

Generic Reader: password (object) ¶

Package

cl-pop.

Methods

Reader Method: password ((pop-connection pop-connection)) ¶

automatically generated reader method

Source: cl-pop.lisp.
Target Slot: password.

Generic Reader: port (object) ¶

Package

cl-pop.

Methods

Reader Method: port ((pop-connection pop-connection)) ¶

automatically generated reader method

Source: cl-pop.lisp.
Target Slot: port.

Generic Function: read-multi-line-pop-response (conn &key mask-dot?) ¶

Package

cl-pop.

Methods

Method: read-multi-line-pop-response (conn &key mask-dot?) ¶

Source: cl-pop.lisp.

Generic Function: read-single-pop-response (conn) ¶

Package

cl-pop.

Methods

Method: read-single-pop-response (conn) ¶

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.

Source: cl-pop.lisp.

Generic Reader: socket (object) ¶

Package

cl-pop.

Methods

Reader Method: socket ((pop-connection pop-connection)) ¶

automatically generated reader method

Source: cl-pop.lisp.
Target Slot: socket.

Generic Writer: (setf socket) (object) ¶

Package

cl-pop.

Methods

Writer Method: (setf socket) ((pop-connection pop-connection)) ¶

automatically generated writer method

Source: cl-pop.lisp.
Target Slot: socket.

Generic Reader: socket-stream (object) ¶

Package

cl-pop.

Methods

Reader Method: socket-stream ((pop-connection pop-connection)) ¶

automatically generated reader method

Source: cl-pop.lisp.
Target Slot: socket-stream.

Generic Writer: (setf socket-stream) (object) ¶

Package

cl-pop.

Methods

Writer Method: (setf socket-stream) ((pop-connection pop-connection)) ¶

automatically generated writer method

Source: cl-pop.lisp.
Target Slot: socket-stream.

Generic Reader: state (object) ¶

Generic Writer: (setf state) (object) ¶

Package

cl-pop.

Methods

Reader Method: state ((pop-connection pop-connection)) ¶

Writer Method: (setf state) ((pop-connection pop-connection)) ¶

Current state of the connection options are :disconnected, :connected

Source: cl-pop.lisp.
Target Slot: state.

Generic Reader: username (object) ¶

Package

cl-pop.

Methods

Reader Method: username ((pop-connection pop-connection)) ¶

automatically generated reader method

Source: cl-pop.lisp.
Target Slot: username.

4.2.5 Classes

Class: pop-connection ¶

Package

cl-pop.

Source

cl-pop.lisp.

Direct methods

host.
password.
port.
(setf socket).
socket.
(setf socket-stream).
socket-stream.
(setf state).
state.
username.

Direct slots

Slot: host ¶

Initargs: :host
Readers: host.
Writers: This slot is read-only.

Slot: port ¶

Initform: 110
Initargs: :port
Readers: port.
Writers: This slot is read-only.

Slot: username ¶

Initform: ""
Initargs: :username
Readers: username.
Writers: This slot is read-only.

Slot: password ¶

Initform: ""
Initargs: :password
Readers: password.
Writers: This slot is read-only.

Slot: socket ¶

Initargs: :socket
Readers: socket.
Writers: (setf socket).

Slot: socket-stream ¶

Initargs: :socket-stream
Readers: socket-stream.
Writers: (setf socket-stream).

Slot: state ¶

Current state of the connection options are :disconnected, :connected

Initform: :disconneted
Readers: state.
Writers: (setf state).

Appendix A Indexes

Concepts
Functions
Variables
Data types

A.1 Concepts

A.2 Functions

Jump to:	( A B C D F G H M O P R S U W

	Index Entry	Section

(
	`(setf socket)`:	Private generic functions
	`(setf socket)`:	Private generic functions
	`(setf socket-stream)`:	Private generic functions
	`(setf socket-stream)`:	Private generic functions
	`(setf state)`:	Private generic functions
	`(setf state)`:	Private generic functions

A
	`authorize-pop-connection`:	Private ordinary functions

B
	`break-pop-response`:	Private ordinary functions

C
	`clean-pop-message`:	Private ordinary functions
	`close-pop-connection`:	Public ordinary functions

D
	`delete-pop-message`:	Public ordinary functions

F
	`Function, authorize-pop-connection`:	Private ordinary functions
	`Function, break-pop-response`:	Private ordinary functions
	`Function, clean-pop-message`:	Private ordinary functions
	`Function, close-pop-connection`:	Public ordinary functions
	`Function, delete-pop-message`:	Public ordinary functions
	`Function, message-count`:	Public ordinary functions
	`Function, message-headers`:	Public ordinary functions
	`Function, open-pop-connection`:	Public ordinary functions
	`Function, parse-raw-message-headers`:	Private ordinary functions
	`Function, retrieve-pop-message`:	Public ordinary functions
	`Function, save-message`:	Public ordinary functions
	`Function, send-pop-command`:	Private ordinary functions
	`Function, send-pop-dele`:	Public ordinary functions
	`Function, send-pop-list`:	Public ordinary functions
	`Function, send-pop-noop`:	Public ordinary functions
	`Function, send-pop-quit`:	Public ordinary functions
	`Function, send-pop-retr`:	Public ordinary functions
	`Function, send-pop-rset`:	Public ordinary functions
	`Function, send-pop-stat`:	Public ordinary functions
	`Function, send-pop-top`:	Public ordinary functions
	`Function, send-pop-uidl`:	Public ordinary functions

G
	`Generic Function, (setf socket)`:	Private generic functions
	`Generic Function, (setf socket-stream)`:	Private generic functions
	`Generic Function, (setf state)`:	Private generic functions
	`Generic Function, host`:	Private generic functions
	`Generic Function, password`:	Private generic functions
	`Generic Function, port`:	Private generic functions
	`Generic Function, read-multi-line-pop-response`:	Private generic functions
	`Generic Function, read-single-pop-response`:	Private generic functions
	`Generic Function, socket`:	Private generic functions
	`Generic Function, socket-stream`:	Private generic functions
	`Generic Function, state`:	Private generic functions
	`Generic Function, username`:	Private generic functions

H
	`host`:	Private generic functions
	`host`:	Private generic functions

M
	`Macro, print-debug`:	Private macros
	`Macro, with-pop-connection`:	Public macros
	`message-count`:	Public ordinary functions
	`message-headers`:	Public ordinary functions
	`Method, (setf socket)`:	Private generic functions
	`Method, (setf socket-stream)`:	Private generic functions
	`Method, (setf state)`:	Private generic functions
	`Method, host`:	Private generic functions
	`Method, password`:	Private generic functions
	`Method, port`:	Private generic functions
	`Method, read-multi-line-pop-response`:	Private generic functions
	`Method, read-single-pop-response`:	Private generic functions
	`Method, socket`:	Private generic functions
	`Method, socket-stream`:	Private generic functions
	`Method, state`:	Private generic functions
	`Method, username`:	Private generic functions

O
	`open-pop-connection`:	Public ordinary functions

P
	`parse-raw-message-headers`:	Private ordinary functions
	`password`:	Private generic functions
	`password`:	Private generic functions
	`port`:	Private generic functions
	`port`:	Private generic functions
	`print-debug`:	Private macros

R
	`read-multi-line-pop-response`:	Private generic functions
	`read-multi-line-pop-response`:	Private generic functions
	`read-single-pop-response`:	Private generic functions
	`read-single-pop-response`:	Private generic functions
	`retrieve-pop-message`:	Public ordinary functions

S
	`save-message`:	Public ordinary functions
	`send-pop-command`:	Private ordinary functions
	`send-pop-dele`:	Public ordinary functions
	`send-pop-list`:	Public ordinary functions
	`send-pop-noop`:	Public ordinary functions
	`send-pop-quit`:	Public ordinary functions
	`send-pop-retr`:	Public ordinary functions
	`send-pop-rset`:	Public ordinary functions
	`send-pop-stat`:	Public ordinary functions
	`send-pop-top`:	Public ordinary functions
	`send-pop-uidl`:	Public ordinary functions
	`socket`:	Private generic functions
	`socket`:	Private generic functions
	`socket-stream`:	Private generic functions
	`socket-stream`:	Private generic functions
	`state`:	Private generic functions
	`state`:	Private generic functions

U
	`username`:	Private generic functions
	`username`:	Private generic functions

W
	`with-pop-connection`:	Public macros

Jump to:	( A B C D F G H M O P R S U W

A.3 Variables

Jump to:	* H P S U

	Index Entry	Section

*
	`*pop-debug?`:	Private special variables
	`termination-string`:	Private special variables

H
	`host`:	Private classes

P
	`password`:	Private classes
	`port`:	Private classes

S
	`Slot, host`:	Private classes
	`Slot, password`:	Private classes
	`Slot, port`:	Private classes
	`Slot, socket`:	Private classes
	`Slot, socket-stream`:	Private classes
	`Slot, state`:	Private classes
	`Slot, username`:	Private classes
	`socket`:	Private classes
	`socket-stream`:	Private classes
	`Special Variable, *pop-debug?`:	Private special variables
	`Special Variable, termination-string`:	Private special variables
	`state`:	Private classes

U
	`username`:	Private classes

Jump to:	* H P S U

A.4 Data types

Jump to:	C F P S

	Index Entry	Section

C
	`cl-pop`:	The cl-pop system
	`cl-pop`:	The cl-pop package
	`cl-pop.asd`:	The cl-pop/cl-pop․asd file
	`cl-pop.lisp`:	The cl-pop/cl-pop․lisp file
	`Class, pop-connection`:	Private classes

F
	`File, cl-pop.asd`:	The cl-pop/cl-pop․asd file
	`File, cl-pop.lisp`:	The cl-pop/cl-pop․lisp file
	`File, package.lisp`:	The cl-pop/package․lisp file

P
	`Package, cl-pop`:	The cl-pop package
	`package.lisp`:	The cl-pop/package․lisp file
	`pop-connection`:	Private classes

S
	`System, cl-pop`:	The cl-pop system

Jump to:	C F P S

The cl-pop Reference Manual

The cl-pop Reference Manual

Table of Contents

1 Systems

1.1 cl-pop

2 Files

2.1 Lisp

2.1.1 cl-pop/cl-pop.asd

2.1.2 cl-pop/package.lisp

2.1.3 cl-pop/cl-pop.lisp

3 Packages

3.1 cl-pop

4 Definitions

4.1 Public Interface

4.1.1 Macros

4.1.2 Ordinary functions

4.2 Internals

4.2.1 Special variables

4.2.2 Macros

4.2.3 Ordinary functions

4.2.4 Generic functions

4.2.5 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

1.1 `cl-pop`

2.1.1 `cl-pop/cl-pop.asd`

2.1.2 `cl-pop/package.lisp`

2.1.3 `cl-pop/cl-pop.lisp`

3.1 `cl-pop`