The cl-pop Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-pop Reference Manual

This is the cl-pop Reference Manual, version 0.2.0, generated automatically by Declt version 2.3 "Robert April" on Tue Jan 09 13:56:10 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Systems

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


Previous: , Up: Systems   [Contents][Index]

1.1 cl-pop

Version

0.2.0

Dependencies
Source

cl-pop.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

2 Files

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


Previous: , Up: Files   [Contents][Index]

2.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.1 cl-pop.asd

Location

cl-pop.asd

Systems

cl-pop (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.2 cl-pop/package.lisp

Parent

cl-pop (system)

Location

package.lisp

Packages

cl-pop


Previous: , Up: Lisp files   [Contents][Index]

2.1.3 cl-pop/cl-pop.lisp

Dependency

package.lisp (file)

Parent

cl-pop (system)

Location

cl-pop.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

3 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

3.1 cl-pop

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

4.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.1 Macros

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

cl-pop

Source

cl-pop.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Definitions   [Contents][Index]

4.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.2 Macros

Macro: print-debug STR

Debuging tool

Package

cl-pop

Source

cl-pop.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Internal definitions   [Contents][Index]

4.2.5 Classes

Class: pop-connection ()
Package

cl-pop

Source

cl-pop.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
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)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-pop.asd: The cl-pop<dot>asd file
cl-pop/cl-pop.lisp: The cl-pop/cl-pop<dot>lisp file
cl-pop/package.lisp: The cl-pop/package<dot>lisp file

F
File, Lisp, cl-pop.asd: The cl-pop<dot>asd file
File, Lisp, cl-pop/cl-pop.lisp: The cl-pop/cl-pop<dot>lisp file
File, Lisp, cl-pop/package.lisp: The cl-pop/package<dot>lisp file

L
Lisp File, cl-pop.asd: The cl-pop<dot>asd file
Lisp File, cl-pop/cl-pop.lisp: The cl-pop/cl-pop<dot>lisp file
Lisp File, cl-pop/package.lisp: The cl-pop/package<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

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

(
(setf socket): Internal generic functions
(setf socket): Internal generic functions
(setf socket-stream): Internal generic functions
(setf socket-stream): Internal generic functions
(setf state): Internal generic functions
(setf state): Internal generic functions

A
authorize-pop-connection: Internal functions

B
break-pop-response: Internal functions

C
clean-pop-message: Internal functions
close-pop-connection: Exported functions

D
delete-pop-message: Exported functions

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

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

H
host: Internal generic functions
host: Internal generic functions

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

O
open-pop-connection: Exported functions

P
parse-raw-message-headers: Internal functions
password: Internal generic functions
password: Internal generic functions
port: Internal generic functions
port: Internal generic functions
print-debug: Internal macros

R
read-multi-line-pop-response: Internal generic functions
read-multi-line-pop-response: Internal generic functions
read-single-pop-response: Internal generic functions
read-single-pop-response: Internal generic functions
retrieve-pop-message: Exported functions

S
save-message: Exported functions
send-pop-command: Internal functions
send-pop-dele: Exported functions
send-pop-list: Exported functions
send-pop-noop: Exported functions
send-pop-quit: Exported functions
send-pop-retr: Exported functions
send-pop-rset: Exported functions
send-pop-stat: Exported functions
send-pop-top: Exported functions
send-pop-uidl: Exported functions
socket: Internal generic functions
socket: Internal generic functions
socket-stream: Internal generic functions
socket-stream: Internal generic functions
state: Internal generic functions
state: Internal generic functions

U
username: Internal generic functions
username: Internal generic functions

W
with-pop-connection: Exported macros

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

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
H   P   S   U  
Index Entry  Section

*
*pop-debug?: Internal special variables
*termination-string*: Internal special variables

H
host: Internal classes

P
password: Internal classes
port: Internal classes

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

U
username: Internal classes

Jump to:   *  
H   P   S   U  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
cl-pop: The cl-pop system
cl-pop: The cl-pop package
Class, pop-connection: Internal classes

P
Package, cl-pop: The cl-pop package
pop-connection: Internal classes

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

Jump to:   C   P   S