The cl-pop Reference Manual

Table of Contents

The cl-pop Reference Manual

This is the cl-pop Reference Manual, version 0.2.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Oct 13 10:00:57 2021 GMT+0.

1 Systems

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

1.1 cl-pop

Version

0.2.0

Dependencies

• usocket
• cl-ppcre

Source

cl-pop.asd (file)

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.

2.1 Lisp

2.1.1 cl-pop.asd

Location

cl-pop.asd

Systems

cl-pop (system)

2.1.2 cl-pop/package.lisp

Parent

cl-pop (system)

Location

package.lisp

Packages

cl-pop

2.1.3 cl-pop/cl-pop.lisp

Dependency

package.lisp (file)

Parent

cl-pop (system)

Location

cl-pop.lisp

Exported Definitions

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

Internal Definitions

• *pop-debug? (special variable)
• *termination-string* (special variable)
• authorize-pop-connection (function)
• break-pop-response (function)
• clean-pop-message (function)
• host (method)
• parse-raw-message-headers (function)
• password (method)
• pop-connection (class)
• port (method)
• print-debug (macro)
• read-multi-line-pop-response (method)
• read-single-pop-response (method)
• send-pop-command (function)
• socket (method)
• (setf socket) (method)
• socket-stream (method)
• (setf socket-stream) (method)
• state (method)
• (setf state) (method)
• username (method)

3 Packages

Packages are listed by definition order.

3.1 cl-pop

Source

package.lisp (file)

Use List

• cl-ppcre
• common-lisp

Exported Definitions

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

Internal Definitions

• *pop-debug? (special variable)
• *termination-string* (special variable)
• authorize-pop-connection (function)
• break-pop-response (function)
• clean-pop-message (function)
• host (generic function)
• host (method)
• parse-raw-message-headers (function)
• password (generic function)
• password (method)
• pop-connection (class)
• port (generic function)
• port (method)
• print-debug (macro)
• read-multi-line-pop-response (generic function)
• read-multi-line-pop-response (method)
• read-single-pop-response (generic function)
• read-single-pop-response (method)
• send-pop-command (function)
• socket (generic function)
• socket (method)
• (setf socket) (method)
• (setf socket) (generic function)
• socket-stream (generic function)
• socket-stream (method)
• (setf socket-stream) (method)
• (setf socket-stream) (generic function)
• state (generic function)
• state (method)
• (setf state) (method)
• (setf state) (generic function)
• username (generic function)
• username (method)

4 Definitions

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

4.1 Exported definitions

4.1.1 Macros

Macro: with-pop-connection (VAR &rest ARGS) &body BODY

Package

cl-pop

Source

cl-pop.lisp (file)

4.1.2 Functions

Function: close-pop-connection CONN

Package

cl-pop

Source

cl-pop.lisp (file)

Function: delete-pop-message CONN MESSAGE-NUM

Mark the given message number for deletion

Package

cl-pop

Source

cl-pop.lisp (file)

Function: message-count CONN

Number of message currently in the mailbox

Package

cl-pop

Source

cl-pop.lisp (file)

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 (file)

Function: open-pop-connection &key HOST PORT USERNAME PASSWORD

Package

cl-pop

Source

cl-pop.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

Function: send-pop-noop CONN

conn - pop-conneciton instance Sends a no operation command

Package

cl-pop

Source

cl-pop.lisp (file)

Function: send-pop-quit CONN

Ends the connection on the server

Package

cl-pop

Source

cl-pop.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

4.2 Internal definitions

4.2.1 Special variables

Special Variable: *pop-debug?

Package

cl-pop

Source

cl-pop.lisp (file)

Special Variable: *termination-string*

Package

cl-pop

Source

cl-pop.lisp (file)

4.2.2 Macros

Macro: print-debug STR

Debuging tool

Package

cl-pop

Source

cl-pop.lisp (file)

4.2.3 Functions

Function: authorize-pop-connection CONN

Package

cl-pop

Source

cl-pop.lisp (file)

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 (file)

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 (file)

Function: parse-raw-message-headers HEADERS

Package

cl-pop

Source

cl-pop.lisp (file)

Function: send-pop-command CONN COMMAND

Package

cl-pop

Source

cl-pop.lisp (file)

4.2.4 Generic functions

Generic Function: host OBJECT

Package

cl-pop

Methods

Method: host (POP-CONNECTION pop-connection)

automatically generated reader method

Source

cl-pop.lisp (file)

Generic Function: password OBJECT

Package

cl-pop

Methods

Method: password (POP-CONNECTION pop-connection)

automatically generated reader method

Source

cl-pop.lisp (file)

Generic Function: port OBJECT

Package

cl-pop

Methods

Method: port (POP-CONNECTION pop-connection)

automatically generated reader method

Source

cl-pop.lisp (file)

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 (file)

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 (file)

Generic Function: socket OBJECT

Generic Function: (setf socket) NEW-VALUE OBJECT

Package

cl-pop

Methods

Method: socket (POP-CONNECTION pop-connection)

automatically generated reader method

Source

cl-pop.lisp (file)

Method: (setf socket) NEW-VALUE (POP-CONNECTION pop-connection)

automatically generated writer method

Source

cl-pop.lisp (file)

Generic Function: socket-stream OBJECT

Generic Function: (setf socket-stream) NEW-VALUE OBJECT

Package

cl-pop

Methods

Method: socket-stream (POP-CONNECTION pop-connection)

automatically generated reader method

Source

cl-pop.lisp (file)

Method: (setf socket-stream) NEW-VALUE (POP-CONNECTION pop-connection)

automatically generated writer method

Source

cl-pop.lisp (file)

Generic Function: state OBJECT

Generic Function: (setf state) NEW-VALUE OBJECT

Package

cl-pop

Methods

Method: state (POP-CONNECTION pop-connection)

Method: (setf state) NEW-VALUE (POP-CONNECTION pop-connection)

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

Source

cl-pop.lisp (file)

Generic Function: username OBJECT

Package

cl-pop

Methods

Method: username (POP-CONNECTION pop-connection)

automatically generated reader method

Source

cl-pop.lisp (file)

4.2.5 Classes

Class: pop-connection ()

Package

cl-pop

Source

cl-pop.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• state (method)
• state (method)
• socket-stream (method)
• socket-stream (method)
• socket (method)
• socket (method)
• password (method)
• username (method)
• port (method)
• host (method)

Direct slots

Slot: host

Initargs

:host

Readers

host (generic function)

Slot: port

Initargs

:port

Initform

110

Readers

port (generic function)

Slot: username

Initargs

:username

Initform

""

Readers

username (generic function)

Slot: password

Initargs

:password

Initform

""

Readers

password (generic function)

Slot: socket

Initargs

:socket

Readers

socket (generic function)

Writers

(setf socket) (generic function)

Slot: socket-stream

Initargs

:socket-stream

Readers

socket-stream (generic function)

Writers

(setf socket-stream) (generic function)

Slot: state

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

Initform

:disconneted

Readers

state (generic function)

Writers

(setf state) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types