Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-mime Reference Manual, version 0.5.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 15:02:49 2021 GMT+0.
• Introduction | What cl-mime is all about | |
• Systems | The systems documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
This is a library for reading and printing MIME content. It supports automatic conversion between 7bit, quoted-printable and base64 encodings via cl-base64 and cl-qprint libraries.
The required libraries can be found at: http://files.b9.com/cl-base64/cl-base64-latest.tar.gz http://www.bobturf.org/software/cl-qprint http://weitz.de/cl-ppcre/
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The cl-mime system |
Robert Marlow <bobstopper@bobturf.org>
Robert Marlow <bobstopper@bobturf.org>
0.5.1
cl-mime.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
Next: The cl-mime/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
cl-mime.asd
cl-mime (system)
Next: The cl-mime/utilities․lisp file, Previous: The cl-mime․asd file, Up: Lisp files [Contents][Index]
Next: The cl-mime/classes․lisp file, Previous: The cl-mime/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
cl-mime (system)
utilities.lisp
Next: The cl-mime/headers․lisp file, Previous: The cl-mime/utilities․lisp file, Up: Lisp files [Contents][Index]
utilities.lisp (file)
cl-mime (system)
classes.lisp
Next: The cl-mime/encoding․lisp file, Previous: The cl-mime/classes․lisp file, Up: Lisp files [Contents][Index]
classes.lisp (file)
cl-mime (system)
headers.lisp
Next: The cl-mime/parse-mime․lisp file, Previous: The cl-mime/headers․lisp file, Up: Lisp files [Contents][Index]
headers.lisp (file)
cl-mime (system)
encoding.lisp
Next: The cl-mime/print-mime․lisp file, Previous: The cl-mime/encoding․lisp file, Up: Lisp files [Contents][Index]
encoding.lisp (file)
cl-mime (system)
parse-mime.lisp
Previous: The cl-mime/parse-mime․lisp file, Up: Lisp files [Contents][Index]
parse-mime.lisp (file)
cl-mime (system)
print-mime.lisp
add-to-print-headers (function)
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The cl-mime-system package | ||
• The cl-mime package |
Next: The cl-mime package, Previous: Packages, Up: Packages [Contents][Index]
cl-mime.asd
Previous: The cl-mime-system package, Up: Packages [Contents][Index]
A package for constructing MIME objects for printing and parsing MIME formatted strings or streams.
package.lisp (file)
mime
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 functions | ||
• Exported generic functions | ||
• Exported classes |
Next: Exported generic functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
encoding.lisp (file)
encoding.lisp (file)
Provided a parameter name in the form of a keyword, will get the corresponding value from the parameter list of the Content-Disposition header
classes.lisp (file)
Provided a parameter name in the form of a keyword, will get the corresponding value from the parameter list of the Content-Type header
classes.lisp (file)
Retrieves all known headers in mime-obj
headers.lisp (file)
Returns all comments from the keyword/value header pair in HEADER
parse-mime.lisp (file)
Takes a header cons and returns all parameters contained within
parse-mime.lisp (file)
Takes a header cons and returns the value component
parse-mime.lisp (file)
Takes a PATHNAME argument and uses MIME-TYPES-FILE (or the system default) to determine the mime type of PATHNAME. Returns two values: the content type and the the content subtype
parse-mime.lisp (file)
Make a Content-ID header value
classes.lisp (file)
Parses headers from a stream and converts them into keyword/value pairs
parse-mime.lisp (file)
Prints headers in the provided assoc-list
print-mime.lisp (file)
Next: Exported classes, Previous: Exported functions, Up: Exported definitions [Contents][Index]
automatically generated reader method
classes.lisp (file)
automatically generated writer method
classes.lisp (file)
automatically generated reader method
classes.lisp (file)
automatically generated writer method
classes.lisp (file)
automatically generated reader method
classes.lisp (file)
automatically generated writer method
classes.lisp (file)
automatically generated reader method
classes.lisp (file)
automatically generated writer method
classes.lisp (file)
automatically generated reader method
classes.lisp (file)
automatically generated writer method
classes.lisp (file)
automatically generated reader method
classes.lisp (file)
automatically generated writer method
classes.lisp (file)
automatically generated reader method
classes.lisp (file)
automatically generated writer method
classes.lisp (file)
automatically generated reader method
classes.lisp (file)
automatically generated writer method
classes.lisp (file)
automatically generated reader method
classes.lisp (file)
automatically generated reader method
classes.lisp (file)
Encoding to use when printing the MIME content. May be :7BIT :BASE64 or :QUOTED-PRINTABLE
classes.lisp (file)
automatically generated reader method
classes.lisp (file)
automatically generated reader method
classes.lisp (file)
automatically generated reader method
classes.lisp (file)
automatically generated reader method
classes.lisp (file)
automatically generated writer method
classes.lisp (file)
automatically generated reader method
classes.lisp (file)
automatically generated writer method
classes.lisp (file)
Returns a cons of header name (in keyword format) and value
headers.lisp (file)
automatically generated reader method
classes.lisp (file)
automatically generated writer method
classes.lisp (file)
Parses a mime body within the context of the mime type expected. Assumes the stream’s position is already at the body. If it’s not, you should call parse headers first or read through to the first null line.
parse-mime.lisp (file)
Parse a string or stream containing a MIME message and return a mine object representing it or nil if the message is not MIME compatible
parse-mime.lisp (file)
Prints a mime object’s contents, optionally with headers
print-mime.lisp (file)
automatically generated reader method
classes.lisp (file)
automatically generated writer method
classes.lisp (file)
Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
Standard MIME Object Representation
classes.lisp (file)
standard-object (class)
:type
(error "mime objects must have a type")
content-type (generic function)
:subtype
(error "mime objects must have a subtype")
content-subtype (generic function)
list
:parameters
content-type-parameters (generic function)
(setf content-type-parameters) (generic function)
:id
content-id (generic function)
(setf content-id) (generic function)
:description
content-description (generic function)
(setf content-description) (generic function)
Encoding to use when printing the MIME content. May be :7BIT :BASE64 or :QUOTED-PRINTABLE
:encoding
:7bit
content-transfer-encoding (generic function)
(setf content-transfer-encoding) (generic function)
Encoding the MIME content is currently in. May be :7BIT :BASE64 or :QUOTED-PRINTABLE
:content-encoding
:7bit
content-encoding (generic function)
(setf content-encoding) (generic function)
:disposition
content-disposition (generic function)
(setf content-disposition) (generic function)
list
:disposition-parameters
content-disposition-parameters (generic function)
(setf content-disposition-parameters) (generic function)
:content
content (generic function)
(setf content) (generic function)
:version
"1.0"
mime-version (generic function)
(setf mime-version) (generic function)
Multipart Mime Object Representation
classes.lisp (file)
mime (class)
"multipart"
content-type (generic function)
list
:content
content (generic function)
(setf content) (generic function)
:boundary
(cl-mime::make-boundary)
boundary (generic function)
(setf boundary) (generic function)
(or null string)
:prologue
prologue (generic function)
(setf prologue) (generic function)
(or null string)
:epilogue
epilogue (generic function)
(setf epilogue) (generic function)
Text MIME Object Representation
classes.lisp (file)
mime (class)
"text"
content-type (generic function)
:subtype
"plain"
content-subtype (generic function)
:charset
"us-ascii"
charset (generic function)
(setf charset) (generic function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal special variables | ||
• Internal macros | ||
• Internal functions | ||
• Internal generic functions |
Next: Internal macros, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
parse-mime.lisp (file)
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
utilities.lisp (file)
Reads lines into LINE-VAR from STREAM until either EOF is reached or EXIT-CLAUSE is true where upon EXIT-BODY is executed. Executes BODY for every line in the file
utilities.lisp (file)
Reads STREAM until EOF and returns a string containing the contents
utilities.lisp (file)
Next: Internal generic functions, Previous: Internal macros, Up: Internal definitions [Contents][Index]
Adds a requested header from the provided alist to a printable headers string
print-mime.lisp (file)
Takes a header string and returns a keyword/value header pair
parse-mime.lisp (file)
Returns keyword for a name
utilities.lisp (file)
Takes a header string and optional list of already extracted comments and returns all comments contained within that string
parse-mime.lisp (file)
Takes a string of parameters and returns a list of keyword/value parameter pairs
parse-mime.lisp (file)
Takes header cons and returns a string containining only params or nil if there is no additional params.
parse-mime.lisp (file)
This just makes a boundary out of random junk
classes.lisp (file)
utilities.lisp (file)
Reads a MIME body from STREAM until it reaches a boundary defined by BOUNDARY
parse-mime.lisp (file)
Previous: Internal functions, Up: Internal definitions [Contents][Index]
Encoding the MIME content is currently in. May be :7BIT :BASE64 or :QUOTED-PRINTABLE
classes.lisp (file)
Grab the prologue from a Multipart MIME message
parse-mime.lisp (file)
Grab the prologue from a Multipart MIME message
parse-mime.lisp (file)
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 E F G H L M P R |
---|
Jump to: | (
A B C D E F G H L M P R |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
B C E M P S |
---|
Jump to: | *
B C E M P S |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | C M P S T |
---|
Jump to: | C M P S T |
---|