This is the cl-rfc2047 Reference Manual, version 0.4, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 04:23:55 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-rfc2047Implemntation of RFC2047.
Max Rottenkolber <max@mr.gy>
Christian Haselbach
MIT
0.4
cl-base64 (system).
babel (system).
package.lisp (file).
constants.lisp (file).
encode.lisp (file).
decode.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-rfc2047/cl-rfc2047.asdcl-rfc2047/package.lispcl-rfc2047/constants.lispcl-rfc2047/encode.lispcl-rfc2047/decode.lispcl-rfc2047/constants.lisppackage.lisp (file).
cl-rfc2047 (system).
*ascii-boundary* (special variable).
*ascii-equals* (special variable).
*ascii-newline* (special variable).
*ascii-question-mark* (special variable).
*ascii-return* (special variable).
*ascii-space* (special variable).
*ascii-underscore* (special variable).
*crlfsp* (special variable).
*encoded-word-length* (special variable).
*encoded-word-length-overhead* (special variable).
*underscore-value* (special variable).
cl-rfc2047/encode.lisppackage.lisp (file).
constants.lisp (file).
cl-rfc2047 (system).
encode (function).
should-encode-p (function).
b-encode (function).
b-split (function).
character-ascii (function).
encoded-word (function).
encoded-word-content-bytes (function).
encoded-word-content-length (function).
encoded-words (function).
limited-words (function).
q-encode (function).
q-encode-characters (function).
q-encode-p (function).
q-encode-string (function).
string-to-grouped-bytes (function).
cl-rfc2047/decode.lisppackage.lisp (file).
constants.lisp (file).
cl-rfc2047 (system).
decode-bytes (function).
decode-word (function).
decode-word* (function).
encoded-word-to (function).
intern* (function).
lwsp-character-p (function).
parse-encoded-word (function).
q-decode (function).
unfold-crlfsp (function).
write-decoded-underscore-value (function).
Packages are listed by definition order.
cl-rfc2047Implementation of the Email header encoding defined in [RFC 2047](http://tools.ietf.org/html/rfc2047).
babel.
cl-base64.
common-lisp.
decode (function).
decode* (function).
encode (function).
should-encode-p (function).
*ascii-boundary* (special variable).
*ascii-equals* (special variable).
*ascii-newline* (special variable).
*ascii-question-mark* (special variable).
*ascii-return* (special variable).
*ascii-space* (special variable).
*ascii-underscore* (special variable).
*crlfsp* (special variable).
*encoded-word-length* (special variable).
*encoded-word-length-overhead* (special variable).
*underscore-value* (special variable).
b-encode (function).
b-split (function).
character-ascii (function).
decode-bytes (function).
decode-word (function).
decode-word* (function).
encoded-word (function).
encoded-word-content-bytes (function).
encoded-word-content-length (function).
encoded-word-to (function).
encoded-words (function).
intern* (function).
limited-words (function).
lwsp-character-p (function).
parse-encoded-word (function).
q-decode (function).
q-encode (function).
q-encode-characters (function).
q-encode-p (function).
q-encode-string (function).
string-to-grouped-bytes (function).
unfold-crlfsp (function).
write-decoded-underscore-value (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
*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.
*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.
*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.
*Arguments and Values:*
_string_—a _string_.
*Description*:
{should-encode-p} returns _true_ if _string_ contains characters that need to be encoded, otherwise, returns _false_.
ASCII boundary.
ASCII equals sign character code.
ASCII newline character code.
ASCII question mark character code.
ASCII return character code.
ASCII space character code.
ASCII underscore character code.
<CRLFSP>
Maximum length of an encoded word.
Number of syntax overhead characters for encoded words.
RFC2047 mandaed value for underscore character in q encoded strings.
Return list of base64 encoded words for STRING using CHARSET.
Return STRING split up in parts for b-encoding according to CHARSET.
Return ASCII code for CHARACTER or NIL.
Decode ENCODED-BYTES according to CHARSET.
Decode ENCODED-WORD.
Decode mixed STRING.
Return encoded word for ENCODING, CHARSET and STRING.
Return number of maximum bytes per b-encoded word using CHARSET.
Return maximum length of encoded word contents for CHARSET.
Find end of encoded word in STRING starting at FROM.
Return encoded words for ENCODING, CHARSET and STRINGS.
Intern STRING upcased in KEYWORD package.
Return list of words no longer than LENGTH concatenated from PIECES destructively.
Predicate to test if CHARACTER is a LWSP-char.
Parse encoding, charset and encoded string of ENCODED-WORD.
Decode ENCODED-STRING according to CHARSET.
Return list of q encoded words for STRING using CHARSET.
Return list of q encoded characters for STRING using CHARSET.
Predicate to test if CHARACTER needs to be q-encoded.
Return q encoded STRING using CHARSET.
Return list of byte vectors for STRING using CHARSET.
Replace any <CRLF SPACE> in STRING with <SPACE>.
Write decoded *UNDERSCORE-VALUE* to STREAM according to CHARSET.
| Jump to: | B C D E F I L P Q S U W |
|---|
| Jump to: | B C D E F I L P Q S U W |
|---|
| Jump to: | *
S |
|---|
| Jump to: | *
S |
|---|
| Jump to: | C D E F P S |
|---|
| Jump to: | C D E F P S |
|---|