The cl-mime Reference Manual

Table of Contents

The cl-mime Reference Manual

This is the cl-mime Reference Manual, version 0.5.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:14:55 2018 GMT+0.

1 Introduction

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/

2 Systems

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

2.1 cl-mime

Maintainer

Robert Marlow <bobstopper@bobturf.org>

Author

Robert Marlow <bobstopper@bobturf.org>

Version

0.5.1

Dependencies

• cl-ppcre
• cl-base64
• cl-qprint

Source

cl-mime.asd (file)

Components

• package.lisp (file)
• utilities.lisp (file)
• classes.lisp (file)
• headers.lisp (file)
• encoding.lisp (file)
• parse-mime.lisp (file)
• print-mime.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 cl-mime.asd

Location

cl-mime.asd

Systems

cl-mime (system)

Packages

cl-mime-system

3.1.2 cl-mime/package.lisp

Parent

cl-mime (system)

Location

package.lisp

Packages

cl-mime

3.1.3 cl-mime/utilities.lisp

Dependency

package.lisp (file)

Parent

cl-mime (system)

Location

utilities.lisp

Internal Definitions

• aif (macro)
• ensure-keyword (function)
• read-line/strip-cr (function)
• read-lines (macro)
• read-stream-to-string (macro)

3.1.4 cl-mime/classes.lisp

Dependency

utilities.lisp (file)

Parent

cl-mime (system)

Location

classes.lisp

Exported Definitions

• boundary (method)
• (setf boundary) (method)
• charset (method)
• (setf charset) (method)
• content (method)
• (setf content) (method)
• content (method)
• (setf content) (method)
• content-description (method)
• (setf content-description) (method)
• content-disposition (method)
• (setf content-disposition) (method)
• content-disposition-parameters (method)
• (setf content-disposition-parameters) (method)
• content-id (method)
• (setf content-id) (method)
• content-subtype (method)
• content-subtype (method)
• content-transfer-encoding (method)
• (setf content-transfer-encoding) (method)
• content-type (method)
• content-type (method)
• content-type (method)
• content-type-parameters (method)
• (setf content-type-parameters) (method)
• epilogue (method)
• (setf epilogue) (method)
• get-content-disposition-parameter (function)
• get-content-type-parameter (function)
• make-content-id (function)
• mime (class)
• mime-version (method)
• (setf mime-version) (method)
• multipart-mime (class)
• prologue (method)
• (setf prologue) (method)
• text-mime (class)

Internal Definitions

• content-encoding (method)
• (setf content-encoding) (method)
• make-boundary (function)

3.1.5 cl-mime/headers.lisp

Dependency

classes.lisp (file)

Parent

cl-mime (system)

Location

headers.lisp

Exported Definitions

• get-header (generic function)
• get-header (method)
• get-header (method)
• get-header (method)
• get-mime-headers (function)

3.1.6 cl-mime/encoding.lisp

Dependency

headers.lisp (file)

Parent

cl-mime (system)

Location

encoding.lisp

Exported Definitions

• decode-content (function)
• encode-content (function)

3.1.7 cl-mime/parse-mime.lisp

Dependency

encoding.lisp (file)

Parent

cl-mime (system)

Location

parse-mime.lisp

Exported Definitions

• header-comments (function)
• header-parms (function)
• header-value (function)
• lookup-mime (function)
• parse-body (generic function)
• parse-body (method)
• parse-body (method)
• parse-body (method)
• parse-body (method)
• parse-body (method)
• parse-body (method)
• parse-headers (function)
• parse-mime (generic function)
• parse-mime (method)
• parse-mime (method)

Internal Definitions

• *mime-types-file* (special variable)
• create-header (function)
• extract-header-comments (function)
• extract-parms (function)
• get-epilogue (generic function)
• get-epilogue (method)
• get-epilogue (method)
• get-prologue (generic function)
• get-prologue (method)
• get-prologue (method)
• read-until-boundary (function)

3.1.8 cl-mime/print-mime.lisp

Dependency

parse-mime.lisp (file)

Parent

cl-mime (system)

Location

print-mime.lisp

Exported Definitions

• print-headers (function)
• print-mime (generic function)
• print-mime (method)
• print-mime (method)

Internal Definitions

add-to-print-headers (function)

4 Packages

Packages are listed by definition order.

4.1 cl-mime-system

Source

cl-mime.asd

Use List

• common-lisp
• asdf/interface

4.2 cl-mime

A package for constructing MIME objects for printing and parsing MIME formatted strings or streams.

Source

package.lisp (file)

Nickname

mime

Use List

• cl-base64
• cl-ppcre
• common-lisp

Exported Definitions

• boundary (generic function)
• boundary (method)
• (setf boundary) (method)
• (setf boundary) (generic function)
• charset (generic function)
• charset (method)
• (setf charset) (method)
• (setf charset) (generic function)
• content (generic function)
• content (method)
• (setf content) (method)
• content (method)
• (setf content) (method)
• (setf content) (generic function)
• content-description (generic function)
• content-description (method)
• (setf content-description) (method)
• (setf content-description) (generic function)
• content-disposition (generic function)
• content-disposition (method)
• (setf content-disposition) (method)
• (setf content-disposition) (generic function)
• content-disposition-parameters (generic function)
• content-disposition-parameters (method)
• (setf content-disposition-parameters) (method)
• (setf content-disposition-parameters) (generic function)
• content-id (generic function)
• content-id (method)
• (setf content-id) (method)
• (setf content-id) (generic function)
• content-subtype (generic function)
• content-subtype (method)
• content-subtype (method)
• content-transfer-encoding (generic function)
• content-transfer-encoding (method)
• (setf content-transfer-encoding) (method)
• (setf content-transfer-encoding) (generic function)
• content-type (generic function)
• content-type (method)
• content-type (method)
• content-type (method)
• content-type-parameters (generic function)
• content-type-parameters (method)
• (setf content-type-parameters) (method)
• (setf content-type-parameters) (generic function)
• decode-content (function)
• encode-content (function)
• epilogue (generic function)
• epilogue (method)
• (setf epilogue) (method)
• (setf epilogue) (generic function)
• get-content-disposition-parameter (function)
• get-content-type-parameter (function)
• get-header (generic function)
• get-header (method)
• get-header (method)
• get-header (method)
• 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 function)
• mime-version (method)
• (setf mime-version) (method)
• (setf mime-version) (generic function)
• multipart-mime (class)
• parse-body (generic function)
• parse-body (method)
• parse-body (method)
• parse-body (method)
• parse-body (method)
• parse-body (method)
• parse-body (method)
• parse-headers (function)
• parse-mime (generic function)
• parse-mime (method)
• parse-mime (method)
• print-headers (function)
• print-mime (generic function)
• print-mime (method)
• print-mime (method)
• prologue (generic function)
• prologue (method)
• (setf prologue) (method)
• (setf prologue) (generic function)
• text-mime (class)

Internal Definitions

• *mime-types-file* (special variable)
• add-to-print-headers (function)
• aif (macro)
• content-encoding (generic function)
• content-encoding (method)
• (setf content-encoding) (method)
• (setf content-encoding) (generic function)
• create-header (function)
• ensure-keyword (function)
• extract-header-comments (function)
• extract-parms (function)
• get-epilogue (generic function)
• get-epilogue (method)
• get-epilogue (method)
• get-prologue (generic function)
• get-prologue (method)
• get-prologue (method)
• make-boundary (function)
• read-line/strip-cr (function)
• read-lines (macro)
• read-stream-to-string (macro)
• read-until-boundary (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: decode-content MIME

Package

cl-mime

Source

encoding.lisp (file)

Function: encode-content MIME

Package

cl-mime

Source

encoding.lisp (file)

Function: get-content-disposition-parameter MIME-OBJ PARAMETER-NAME

Provided a parameter name in the form of a keyword, will get the corresponding value from the parameter list of the Content-Disposition header

Package

cl-mime

Source

classes.lisp (file)

Function: get-content-type-parameter MIME-OBJ PARAMETER-NAME

Provided a parameter name in the form of a keyword, will get the corresponding value from the parameter list of the Content-Type header

Package

cl-mime

Source

classes.lisp (file)

Function: get-mime-headers MIME-OBJ

Retrieves all known headers in mime-obj

Package

cl-mime

Source

headers.lisp (file)

Function: header-comments HEADER

Returns all comments from the keyword/value header pair in HEADER

Package

cl-mime

Source

parse-mime.lisp (file)

Function: header-parms HEADER

Takes a header cons and returns all parameters contained within

Package

cl-mime

Source

parse-mime.lisp (file)

Function: header-value HEADER

Takes a header cons and returns the value component

Package

cl-mime

Source

parse-mime.lisp (file)

Function: lookup-mime PATHNAME &optional MIME-TYPES-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

Package

cl-mime

Source

parse-mime.lisp (file)

Function: make-content-id ()

Make a Content-ID header value

Package

cl-mime

Source

classes.lisp (file)

Function: parse-headers STREAM

Parses headers from a stream and converts them into keyword/value pairs

Package

cl-mime

Source

parse-mime.lisp (file)

Function: print-headers STREAM HEADERS VERSION-P

Prints headers in the provided assoc-list

Package

cl-mime

Source

print-mime.lisp (file)

5.1.2 Generic functions

Generic Function: boundary OBJECT

Generic Function: (setf boundary) NEW-VALUE OBJECT

Package

cl-mime

Methods

Method: boundary (MULTIPART-MIME multipart-mime)

automatically generated reader method

Source

classes.lisp (file)

Method: (setf boundary) NEW-VALUE (MULTIPART-MIME multipart-mime)

automatically generated writer method

Source

classes.lisp (file)

Generic Function: charset OBJECT

Generic Function: (setf charset) NEW-VALUE OBJECT

Package

cl-mime

Methods

Method: charset (TEXT-MIME text-mime)

automatically generated reader method

Source

classes.lisp (file)

Method: (setf charset) NEW-VALUE (TEXT-MIME text-mime)

automatically generated writer method

Source

classes.lisp (file)

Generic Function: content OBJECT

Generic Function: (setf content) NEW-VALUE OBJECT

Package

cl-mime

Methods

Method: content (MULTIPART-MIME multipart-mime)

automatically generated reader method

Source

classes.lisp (file)

Method: (setf content) NEW-VALUE (MULTIPART-MIME multipart-mime)

automatically generated writer method

Source

classes.lisp (file)

Method: content (MIME mime)

automatically generated reader method

Source

classes.lisp (file)

Method: (setf content) NEW-VALUE (MIME mime)

automatically generated writer method

Source

classes.lisp (file)

Generic Function: content-description OBJECT

Generic Function: (setf content-description) NEW-VALUE OBJECT

Package

cl-mime

Methods

Method: content-description (MIME mime)

automatically generated reader method

Source

classes.lisp (file)

Method: (setf content-description) NEW-VALUE (MIME mime)

automatically generated writer method

Source

classes.lisp (file)

Generic Function: content-disposition OBJECT

Generic Function: (setf content-disposition) NEW-VALUE OBJECT

Package

cl-mime

Methods

Method: content-disposition (MIME mime)

automatically generated reader method

Source

classes.lisp (file)

Method: (setf content-disposition) NEW-VALUE (MIME mime)

automatically generated writer method

Source

classes.lisp (file)

Generic Function: content-disposition-parameters OBJECT

Generic Function: (setf content-disposition-parameters) NEW-VALUE OBJECT

Package

cl-mime

Methods

Method: content-disposition-parameters (MIME mime)

automatically generated reader method

Source

classes.lisp (file)

Method: (setf content-disposition-parameters) NEW-VALUE (MIME mime)

automatically generated writer method

Source

classes.lisp (file)

Generic Function: content-id OBJECT

Generic Function: (setf content-id) NEW-VALUE OBJECT

Package

cl-mime

Methods

Method: content-id (MIME mime)

automatically generated reader method

Source

classes.lisp (file)

Method: (setf content-id) NEW-VALUE (MIME mime)

automatically generated writer method

Source

classes.lisp (file)

Generic Function: content-subtype OBJECT

Package

cl-mime

Methods

Method: content-subtype (TEXT-MIME text-mime)

automatically generated reader method

Source

classes.lisp (file)

Method: content-subtype (MIME mime)

automatically generated reader method

Source

classes.lisp (file)

Generic Function: content-transfer-encoding OBJECT

Generic Function: (setf content-transfer-encoding) NEW-VALUE OBJECT

Package

cl-mime

Methods

Method: content-transfer-encoding (MIME mime)

Method: (setf content-transfer-encoding) NEW-VALUE (MIME mime)

Encoding to use when printing the MIME content. May be :7BIT :BASE64 or :QUOTED-PRINTABLE

Source

classes.lisp (file)

Generic Function: content-type OBJECT

Package

cl-mime

Methods

Method: content-type (MULTIPART-MIME multipart-mime)

automatically generated reader method

Source

classes.lisp (file)

Method: content-type (TEXT-MIME text-mime)

automatically generated reader method

Source

classes.lisp (file)

Method: content-type (MIME mime)

automatically generated reader method

Source

classes.lisp (file)

Generic Function: content-type-parameters OBJECT

Generic Function: (setf content-type-parameters) NEW-VALUE OBJECT

Package

cl-mime

Methods

Method: content-type-parameters (MIME mime)

automatically generated reader method

Source

classes.lisp (file)

Method: (setf content-type-parameters) NEW-VALUE (MIME mime)

automatically generated writer method

Source

classes.lisp (file)

Generic Function: epilogue OBJECT

Generic Function: (setf epilogue) NEW-VALUE OBJECT

Package

cl-mime

Methods

Method: epilogue (MULTIPART-MIME multipart-mime)

automatically generated reader method

Source

classes.lisp (file)

Method: (setf epilogue) NEW-VALUE (MULTIPART-MIME multipart-mime)

automatically generated writer method

Source

classes.lisp (file)

Generic Function: get-header MIME-OBJ HEADER

Returns a cons of header name (in keyword format) and value

Package

cl-mime

Source

headers.lisp (file)

Methods

Method: get-header (MIME-OBJ mime) (HEADER symbol)

Method: get-header (MIME-OBJ mime) (HEADER (eql content-disposition))

Method: get-header (MIME-OBJ mime) (HEADER (eql content-type))

Generic Function: mime-version OBJECT

Generic Function: (setf mime-version) NEW-VALUE OBJECT

Package

cl-mime

Methods

Method: mime-version (MIME mime)

automatically generated reader method

Source

classes.lisp (file)

Method: (setf mime-version) NEW-VALUE (MIME mime)

automatically generated writer method

Source

classes.lisp (file)

Generic Function: parse-body BODY MIME-TYPE &optional BOUNDARY

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.

Package

cl-mime

Source

parse-mime.lisp (file)

Methods

Method: parse-body (BODY stream) (MIME-TYPE (eql multipart-mime)) &optional BOUNDARY

Method: parse-body (BODY string) (MIME-TYPE (eql multipart-mime)) &optional BOUNDARY

Method: parse-body (BODY stream) (MIME-TYPE (eql text-mime)) &optional BOUNDARY

Method: parse-body (BODY string) (MIME-TYPE (eql text-mime)) &optional BOUNDARY

Method: parse-body (BODY stream) (MIME-TYPE (eql mime)) &optional BOUNDARY

Method: parse-body (BODY string) (MIME-TYPE (eql mime)) &optional BOUNDARY

Generic Function: parse-mime MIME &optional HEADERS

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

Package

cl-mime

Source

parse-mime.lisp (file)

Methods

Method: parse-mime (MIME stream) &optional HEADERS

Method: parse-mime (MIME string) &optional HEADERS

Generic Function: print-mime STREAM MIME-OBJ HEADERS-P VERSION-P

Prints a mime object’s contents, optionally with headers

Package

cl-mime

Source

print-mime.lisp (file)

Methods

Method: print-mime STREAM (MIME-OBJ multipart-mime) HEADERS-P VERSION-P

Method: print-mime STREAM (MIME-OBJ mime) HEADERS-P VERSION-P

Generic Function: prologue OBJECT

Generic Function: (setf prologue) NEW-VALUE OBJECT

Package

cl-mime

Methods

Method: prologue (MULTIPART-MIME multipart-mime)

automatically generated reader method

Source

classes.lisp (file)

Method: (setf prologue) NEW-VALUE (MULTIPART-MIME multipart-mime)

automatically generated writer method

Source

classes.lisp (file)

5.1.3 Classes

Class: mime ()

Standard MIME Object Representation

Package

cl-mime

Source

classes.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• text-mime (class)
• multipart-mime (class)

Direct methods

• print-mime (method)
• get-header (method)
• get-header (method)
• get-header (method)
• mime-version (method)
• mime-version (method)
• content (method)
• content (method)
• content-disposition-parameters (method)
• content-disposition-parameters (method)
• content-disposition (method)
• content-disposition (method)
• content-encoding (method)
• content-encoding (method)
• content-transfer-encoding (method)
• content-transfer-encoding (method)
• content-description (method)
• content-description (method)
• content-id (method)
• content-id (method)
• content-type-parameters (method)
• content-type-parameters (method)
• content-subtype (method)
• content-type (method)

Direct slots

Slot: content-type

Initargs

:type

Initform

(error "mime objects must have a type")

Readers

content-type (generic function)

Slot: content-subtype

Initargs

:subtype

Initform

(error "mime objects must have a subtype")

Readers

content-subtype (generic function)

Slot: content-type-parameters

Type

list

Initargs

:parameters

Readers

content-type-parameters (generic function)

Writers

(setf content-type-parameters) (generic function)

Slot: content-id

Initargs

:id

Readers

content-id (generic function)

Writers

(setf content-id) (generic function)

Slot: content-description

Initargs

:description

Readers

content-description (generic function)

Writers

(setf content-description) (generic function)

Slot: content-transfer-encoding

Encoding to use when printing the MIME content. May be :7BIT :BASE64 or :QUOTED-PRINTABLE

Initargs

:encoding

Initform

:7bit

Readers

content-transfer-encoding (generic function)

Writers

(setf content-transfer-encoding) (generic function)

Slot: content-encoding

Encoding the MIME content is currently in. May be :7BIT :BASE64 or :QUOTED-PRINTABLE

Initargs

:content-encoding

Initform

:7bit

Readers

content-encoding (generic function)

Writers

(setf content-encoding) (generic function)

Slot: content-disposition

Initargs

:disposition

Readers

content-disposition (generic function)

Writers

(setf content-disposition) (generic function)

Slot: content-disposition-parameters

Type

list

Initargs

:disposition-parameters

Readers

content-disposition-parameters (generic function)

Writers

(setf content-disposition-parameters) (generic function)

Slot: content

Initargs

:content

Readers

content (generic function)

Writers

(setf content) (generic function)

Slot: mime-version

Initargs

:version

Initform

"1.0"

Readers

mime-version (generic function)

Writers

(setf mime-version) (generic function)

Class: multipart-mime ()

Multipart Mime Object Representation

Package

cl-mime

Source

classes.lisp (file)

Direct superclasses

mime (class)

Direct methods

• print-mime (method)
• epilogue (method)
• epilogue (method)
• prologue (method)
• prologue (method)
• boundary (method)
• boundary (method)
• content (method)
• content (method)
• content-type (method)

Direct slots

Slot: content-type

Initform

"multipart"

Readers

content-type (generic function)

Slot: content

Type

list

Initargs

:content

Readers

content (generic function)

Writers

(setf content) (generic function)

Slot: boundary

Initargs

:boundary

Initform

(cl-mime::make-boundary)

Readers

boundary (generic function)

Writers

(setf boundary) (generic function)

Slot: prologue

Type

(or null string)

Initargs

:prologue

Readers

prologue (generic function)

Writers

(setf prologue) (generic function)

Slot: epilogue

Type

(or null string)

Initargs

:epilogue

Readers

epilogue (generic function)

Writers

(setf epilogue) (generic function)

Class: text-mime ()

Text MIME Object Representation

Package

cl-mime

Source

classes.lisp (file)

Direct superclasses

mime (class)

Direct methods

• charset (method)
• charset (method)
• content-subtype (method)
• content-type (method)

Direct slots

Slot: content-type

Initform

"text"

Readers

content-type (generic function)

Slot: content-subtype

Initargs

:subtype

Initform

"plain"

Readers

content-subtype (generic function)

Slot: charset

Initargs

:charset

Initform

"us-ascii"

Readers

charset (generic function)

Writers

(setf charset) (generic function)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *mime-types-file*

Package

cl-mime

Source

parse-mime.lisp (file)

5.2.2 Macros

Macro: aif TEST THEN &optional ELSE

Package

cl-mime

Source

utilities.lisp (file)

Macro: read-lines (LINE-VAR STREAM) (EXIT-CLAUSE &body EXIT-BODY) &body BODY

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

Package

cl-mime

Source

utilities.lisp (file)

Macro: read-stream-to-string STREAM LINE-VAR &optional EXIT-CLAUSE

Reads STREAM until EOF and returns a string containing the contents

Package

cl-mime

Source

utilities.lisp (file)

5.2.3 Functions

Function: add-to-print-headers KEY ALIST HEADERS-OUT

Adds a requested header from the provided alist to a printable headers string

Package

cl-mime

Source

print-mime.lisp (file)

Function: create-header HEADER-STRING

Takes a header string and returns a keyword/value header pair

Package

cl-mime

Source

parse-mime.lisp (file)

Function: ensure-keyword NAME

Returns keyword for a name

Package

cl-mime

Source

utilities.lisp (file)

Function: extract-header-comments HEADER-VALUE-STRING &optional COMMENT-LIST

Takes a header string and optional list of already extracted comments and returns all comments contained within that string

Package

cl-mime

Source

parse-mime.lisp (file)

Function: extract-parms PARM-STRING &optional PARMS

Takes a string of parameters and returns a list of keyword/value parameter pairs

Package

cl-mime

Source

parse-mime.lisp (file)

Function: make-boundary ()

This just makes a boundary out of random junk

Package

cl-mime

Source

classes.lisp (file)

Function: read-line/strip-cr &rest ARGS

Package

cl-mime

Source

utilities.lisp (file)

Function: read-until-boundary STREAM BOUNDARY

Reads a MIME body from STREAM until it reaches a boundary defined by BOUNDARY

Package

cl-mime

Source

parse-mime.lisp (file)

5.2.4 Generic functions

Generic Function: content-encoding OBJECT

Generic Function: (setf content-encoding) NEW-VALUE OBJECT

Package

cl-mime

Methods

Method: content-encoding (MIME mime)

Method: (setf content-encoding) NEW-VALUE (MIME mime)

Encoding the MIME content is currently in. May be :7BIT :BASE64 or :QUOTED-PRINTABLE

Source

classes.lisp (file)

Generic Function: get-epilogue BODY

Grab the prologue from a Multipart MIME message

Package

cl-mime

Source

parse-mime.lisp (file)

Methods

Method: get-epilogue (BODY stream)

Method: get-epilogue (BODY string)

Generic Function: get-prologue BODY BOUNDARY

Grab the prologue from a Multipart MIME message

Package

cl-mime

Source

parse-mime.lisp (file)

Methods

Method: get-prologue (BODY stream) BOUNDARY

Method: get-prologue (BODY string) BOUNDARY

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types