This is the cl-mime Reference Manual, version 0.5.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:27:30 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-mimeRobert Marlow <bobstopper@bobturf.org>
Robert Marlow <bobstopper@bobturf.org>
0.5.1
cl-ppcre (system).
cl-base64 (system).
cl-qprint (system).
package.lisp (file).
utilities.lisp (file).
classes.lisp (file).
headers.lisp (file).
encoding.lisp (file).
parse-mime.lisp (file).
print-mime.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-mime/cl-mime.asdcl-mime/package.lispcl-mime/utilities.lispcl-mime/classes.lispcl-mime/headers.lispcl-mime/encoding.lispcl-mime/parse-mime.lispcl-mime/print-mime.lispcl-mime/utilities.lisppackage.lisp (file).
cl-mime (system).
aif (macro).
ensure-keyword (function).
read-line/strip-cr (function).
read-lines (macro).
read-stream-to-string (macro).
cl-mime/classes.lisputilities.lisp (file).
cl-mime (system).
boundary (reader method).
(setf boundary) (writer method).
charset (reader method).
(setf charset) (writer method).
content (reader method).
content (reader method).
(setf content) (writer method).
(setf content) (writer method).
content-description (reader method).
(setf content-description) (writer method).
content-disposition (reader method).
(setf content-disposition) (writer method).
content-disposition-parameters (reader method).
(setf content-disposition-parameters) (writer method).
content-id (reader method).
(setf content-id) (writer method).
content-subtype (reader method).
content-subtype (reader method).
content-transfer-encoding (reader method).
(setf content-transfer-encoding) (writer method).
content-type (reader method).
content-type (reader method).
content-type (reader method).
content-type-parameters (reader method).
(setf content-type-parameters) (writer method).
epilogue (reader method).
(setf epilogue) (writer method).
get-content-disposition-parameter (function).
get-content-type-parameter (function).
make-content-id (function).
mime (class).
mime-version (reader method).
(setf mime-version) (writer method).
multipart-mime (class).
prologue (reader method).
(setf prologue) (writer method).
text-mime (class).
content-encoding (reader method).
(setf content-encoding) (writer method).
make-boundary (function).
cl-mime/headers.lispclasses.lisp (file).
cl-mime (system).
get-header (generic function).
get-mime-headers (function).
cl-mime/encoding.lispheaders.lisp (file).
cl-mime (system).
decode-content (function).
encode-content (function).
cl-mime/parse-mime.lispencoding.lisp (file).
cl-mime (system).
header-comments (function).
header-parms (function).
header-value (function).
lookup-mime (function).
parse-body (generic function).
parse-headers (function).
parse-mime (generic function).
*mime-types-file* (special variable).
create-header (function).
extract-header-comments (function).
extract-params (function).
get-epilogue (generic function).
get-prologue (generic function).
header-raw-params (function).
read-until-boundary (function).
cl-mime/print-mime.lispparse-mime.lisp (file).
cl-mime (system).
print-headers (function).
print-mime (generic function).
add-to-print-headers (function).
Packages are listed by definition order.
cl-mimeA package for constructing MIME objects for printing and parsing MIME formatted strings or streams.
mime
cl-base64.
cl-ppcre.
common-lisp.
boundary (generic reader).
(setf boundary) (generic writer).
charset (generic reader).
(setf charset) (generic writer).
content (generic reader).
(setf content) (generic writer).
content-description (generic reader).
(setf content-description) (generic writer).
content-disposition (generic reader).
(setf content-disposition) (generic writer).
content-disposition-parameters (generic reader).
(setf content-disposition-parameters) (generic writer).
content-id (generic reader).
(setf content-id) (generic writer).
content-subtype (generic reader).
content-transfer-encoding (generic reader).
(setf content-transfer-encoding) (generic writer).
content-type (generic reader).
content-type-parameters (generic reader).
(setf content-type-parameters) (generic writer).
decode-content (function).
encode-content (function).
epilogue (generic reader).
(setf epilogue) (generic writer).
get-content-disposition-parameter (function).
get-content-type-parameter (function).
get-header (generic function).
get-mime-headers (function).
header-comments (function).
header-parms (function).
header-value (function).
lookup-mime (function).
make-content-id (function).
mime (class).
mime-version (generic reader).
(setf mime-version) (generic writer).
multipart-mime (class).
parse-body (generic function).
parse-headers (function).
parse-mime (generic function).
print-headers (function).
print-mime (generic function).
prologue (generic reader).
(setf prologue) (generic writer).
text-mime (class).
*mime-types-file* (special variable).
add-to-print-headers (function).
aif (macro).
content-encoding (generic reader).
(setf content-encoding) (generic writer).
create-header (function).
ensure-keyword (function).
extract-header-comments (function).
extract-params (function).
get-epilogue (generic function).
get-prologue (generic function).
header-raw-params (function).
make-boundary (function).
read-line/strip-cr (function).
read-lines (macro).
read-stream-to-string (macro).
read-until-boundary (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Provided a parameter name in the form of a keyword, will get the corresponding value from the parameter list of the Content-Disposition header
Provided a parameter name in the form of a keyword, will get the corresponding value from the parameter list of the Content-Type header
Retrieves all known headers in mime-obj
Returns all comments from the keyword/value header pair in HEADER
Takes a header cons and returns all parameters contained within
Takes a header cons and returns the value component
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
Make a Content-ID header value
Parses headers from a stream and converts them into keyword/value pairs
Prints headers in the provided assoc-list
multipart-mime)) ¶automatically generated reader method
multipart-mime)) ¶automatically generated writer method
multipart-mime)) ¶automatically generated reader method
multipart-mime)) ¶automatically generated writer method
multipart-mime)) ¶automatically generated reader method
text-mime)) ¶automatically generated reader method
multipart-mime)) ¶automatically generated reader method
multipart-mime)) ¶automatically generated writer method
Returns a cons of header name (in keyword format) and value
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.
stream) (mime-type (eql :multipart-mime)) &optional boundary) ¶string) (mime-type (eql :multipart-mime)) &optional boundary) ¶stream) (mime-type (eql :text-mime)) &optional boundary) ¶string) (mime-type (eql :text-mime)) &optional boundary) ¶stream) (mime-type (eql :mime)) &optional boundary) ¶string) (mime-type (eql :mime)) &optional boundary) ¶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
Prints a mime object’s contents, optionally with headers
multipart-mime) headers-p version-p) ¶multipart-mime)) ¶automatically generated reader method
multipart-mime)) ¶automatically generated writer method
Standard MIME Object Representation
(setf content).
content.
(setf content-description).
content-description.
(setf content-disposition).
content-disposition.
(setf content-disposition-parameters).
content-disposition-parameters.
(setf content-encoding).
content-encoding.
(setf content-id).
content-id.
content-subtype.
(setf content-transfer-encoding).
content-transfer-encoding.
content-type.
(setf content-type-parameters).
content-type-parameters.
get-header.
get-header.
get-header.
(setf mime-version).
mime-version.
print-mime.
(error "mime objects must have a type")
:type
This slot is read-only.
(error "mime objects must have a subtype")
:subtype
This slot is read-only.
list
:parameters
:id
:description
Encoding to use when printing the MIME content. May be :7BIT :BASE64 or :QUOTED-PRINTABLE
:7bit
:encoding
Encoding the MIME content is currently in. May be :7BIT :BASE64 or :QUOTED-PRINTABLE
:7bit
:content-encoding
:disposition
list
:disposition-parameters
:content
"1.0"
:version
Multipart Mime Object Representation
mime.
"multipart"
This slot is read-only.
list
:content
(cl-mime::make-boundary)
:boundary
(or null string)
:prologue
(or null string)
:epilogue
Text MIME Object Representation
mime.
"text"
This slot is read-only.
"plain"
:subtype
This slot is read-only.
"us-ascii"
:charset
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
Reads STREAM until EOF and returns a string containing the contents
Adds a requested header from the provided alist to a printable headers string
Takes a header string and returns a keyword/value header pair
Returns keyword for a name
Takes a header string and optional list of already extracted comments and returns all comments contained within that string
Takes a string of parameters and returns a list of keyword/value parameter pairs
Takes header cons and returns a string containining only params or nil if there is no additional params.
This just makes a boundary out of random junk
Reads a MIME body from STREAM until it reaches a boundary defined by BOUNDARY
Grab the prologue from a Multipart MIME message
Grab the prologue from a Multipart MIME message
| 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 |
|---|
| Jump to: | *
B C E M P S |
|---|
| Jump to: | *
B C E M P S |
|---|
| Jump to: | C E F H M P S T U |
|---|
| Jump to: | C E F H M P S T U |
|---|