cl-rfc2047 API Documentation

Syntax:

— Function: decode string &key start end

Arguments and Values:

string—a string.

start, end—bounding index designators of string. The default for start is 0 and the default for end is nil.

Description:

decode returns the decoded word in string.

Exceptional Situations:

If decode fails an error condition is signaled.

Syntax:

— Function: decode* string &key start end errorp

Arguments and Values:

string—a string.

start, end—bounding index designators of string. The default for start is 0 and the default for end is nil.

error-p—a generalized boolean. The default is true.

Description:

decode* returns a decoded copy of string containing encoded as well as unencoded words.

Exceptional Situations:

If decode* fails and error-p is true an error condition is signaled.

Syntax:

— Function: encode string &key encoding charset

Arguments and Values:

string—a string.

encoding—a keyword. Can either be :b or :q. The default is :b.

charset—a keyword denoting the character encoding used. The default is :utf-8.

Description:

encode returns an encoded copy of string. Words will be encoded using encoding and charset. If encoding is :b then the "B" encoding is used. If encoding is :q then the "Q" encoding is used.

Syntax:

— Function: should-encode-p string

Arguments and Values:

string—a string.

Description:

should-encode-p returns true if string contains characters that need to be encoded, otherwise, returns false.