This is the cl-pop Reference Manual, version 0.2.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 04:04:48 2022 GMT+0.
• Systems | The systems documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
The main system appears first, followed by any subsystem dependency.
• The cl-pop system |
0.2.0
cl-pop.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
• The cl-pop.asd file | ||
• The cl-pop/package.lisp file | ||
• The cl-pop/cl-pop.lisp file |
Next: The cl-pop/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
cl-pop.asd
cl-pop (system)
Next: The cl-pop/cl-pop․lisp file, Previous: The cl-pop․asd file, Up: Lisp files [Contents][Index]
Previous: The cl-pop/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
cl-pop (system)
cl-pop.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The cl-pop package |
package.lisp (file)
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported macros | ||
• Exported functions |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
cl-pop.lisp (file)
Previous: Exported macros, Up: Exported definitions [Contents][Index]
cl-pop.lisp (file)
Mark the given message number for deletion
cl-pop.lisp (file)
Number of message currently in the mailbox
cl-pop.lisp (file)
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
cl-pop.lisp (file)
cl-pop.lisp (file)
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
cl-pop.lisp (file)
Saves message’s entire contents including headers into a file with the given pathname
cl-pop.lisp (file)
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
cl-pop.lisp (file)
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.
cl-pop.lisp (file)
conn - pop-conneciton instance Sends a no operation command
cl-pop.lisp (file)
Ends the connection on the server
cl-pop.lisp (file)
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.
cl-pop.lisp (file)
conn - pop connection class
Reset all messages that have been marked for deletion
cl-pop.lisp (file)
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
cl-pop.lisp (file)
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
cl-pop.lisp (file)
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
cl-pop.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal special variables | ||
• Internal macros | ||
• Internal functions | ||
• Internal generic functions | ||
• Internal classes |
Next: Internal macros, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
cl-pop.lisp (file)
cl-pop.lisp (file)
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
Debuging tool
cl-pop.lisp (file)
Next: Internal generic functions, Previous: Internal macros, Up: Internal definitions [Contents][Index]
cl-pop.lisp (file)
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
cl-pop.lisp (file)
Removes status key and end of line characters from string
cl-pop.lisp (file)
cl-pop.lisp (file)
cl-pop.lisp (file)
Next: Internal classes, Previous: Internal functions, Up: Internal definitions [Contents][Index]
automatically generated reader method
cl-pop.lisp (file)
automatically generated reader method
cl-pop.lisp (file)
automatically generated reader method
cl-pop.lisp (file)
cl-pop.lisp (file)
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.
cl-pop.lisp (file)
automatically generated reader method
cl-pop.lisp (file)
automatically generated writer method
cl-pop.lisp (file)
automatically generated reader method
cl-pop.lisp (file)
automatically generated writer method
cl-pop.lisp (file)
Current state of the connection options are :disconnected, :connected
cl-pop.lisp (file)
automatically generated reader method
cl-pop.lisp (file)
Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
cl-pop.lisp (file)
standard-object (class)
:host
host (generic function)
:port
110
port (generic function)
:username
""
username (generic function)
:password
""
password (generic function)
:socket
socket (generic function)
(setf socket) (generic function)
:socket-stream
socket-stream (generic function)
(setf socket-stream) (generic function)
Current state of the connection options are :disconnected, :connected
:disconneted
state (generic function)
(setf state) (generic function)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | C F L |
---|
Jump to: | C F L |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
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 |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
H P S U |
---|
Jump to: | *
H P S U |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | C P S |
---|
Jump to: | C P S |
---|