The cl-rfc2047 Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-rfc2047 Reference Manual

This is the cl-rfc2047 Reference Manual, version 0.4, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:31:07 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

cl-rfc2047

Description:

cl-rfc2047 implements the email header encoding method described in RFC 2047. It was originally written by Christian Haselbach.

Documentation:


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 cl-rfc2047

Maintainer

Max Rottenkolber <max@mr.gy>

Author

Christian Haselbach

License

MIT

Description

Implemntation of RFC2047.

Version

0.4

Dependencies
Source

cl-rfc2047.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-rfc2047.asd

Location

cl-rfc2047.asd

Systems

cl-rfc2047 (system)

Packages

cl-rfc2047-asd


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cl-rfc2047/package.lisp

Parent

cl-rfc2047 (system)

Location

package.lisp

Packages

cl-rfc2047


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 cl-rfc2047/constants.lisp

Dependency

package.lisp (file)

Parent

cl-rfc2047 (system)

Location

constants.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 cl-rfc2047/encode.lisp

Dependencies
Parent

cl-rfc2047 (system)

Location

encode.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.5 cl-rfc2047/decode.lisp

Dependencies
Parent

cl-rfc2047 (system)

Location

decode.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

4.1 cl-rfc2047-asd

Source

cl-rfc2047.asd

Use List

Previous: , Up: Packages   [Contents][Index]

4.2 cl-rfc2047

Implementation of the Email header encoding defined in [RFC 2047](http://tools.ietf.org/html/rfc2047).

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

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.

Package

cl-rfc2047

Source

decode.lisp (file)

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.

Package

cl-rfc2047

Source

decode.lisp (file)

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.

Package

cl-rfc2047

Source

encode.lisp (file)

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_.

Package

cl-rfc2047

Source

encode.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *ascii-boundary*

ASCII boundary.

Package

cl-rfc2047

Source

constants.lisp (file)

Special Variable: *ascii-equals*

ASCII equals sign character code.

Package

cl-rfc2047

Source

constants.lisp (file)

Special Variable: *ascii-newline*

ASCII newline character code.

Package

cl-rfc2047

Source

constants.lisp (file)

Special Variable: *ascii-question-mark*

ASCII question mark character code.

Package

cl-rfc2047

Source

constants.lisp (file)

Special Variable: *ascii-return*

ASCII return character code.

Package

cl-rfc2047

Source

constants.lisp (file)

Special Variable: *ascii-space*

ASCII space character code.

Package

cl-rfc2047

Source

constants.lisp (file)

Special Variable: *ascii-underscore*

ASCII underscore character code.

Package

cl-rfc2047

Source

constants.lisp (file)

Special Variable: *crlfsp*

<CRLFSP>

Package

cl-rfc2047

Source

constants.lisp (file)

Special Variable: *encoded-word-length*

Maximum length of an encoded word.

Package

cl-rfc2047

Source

constants.lisp (file)

Special Variable: *encoded-word-length-overhead*

Number of syntax overhead characters for encoded words.

Package

cl-rfc2047

Source

constants.lisp (file)

Special Variable: *underscore-value*

RFC2047 mandaed value for underscore character in q encoded strings.

Package

cl-rfc2047

Source

constants.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Functions

Function: b-encode STRING CHARSET

Return list of base64 encoded words for STRING using CHARSET.

Package

cl-rfc2047

Source

encode.lisp (file)

Function: b-split STRING CHARSET

Return STRING split up in parts for b-encoding according to CHARSET.

Package

cl-rfc2047

Source

encode.lisp (file)

Function: character-ascii CHARACTER

Return ASCII code for CHARACTER or NIL.

Package

cl-rfc2047

Source

encode.lisp (file)

Function: decode-bytes ENCODED-BYTES CHARSET

Decode ENCODED-BYTES according to CHARSET.

Package

cl-rfc2047

Source

decode.lisp (file)

Function: decode-word ENCODED-WORD

Decode ENCODED-WORD.

Package

cl-rfc2047

Source

decode.lisp (file)

Function: decode-word* STRING

Decode mixed STRING.

Package

cl-rfc2047

Source

decode.lisp (file)

Function: encoded-word ENCODING CHARSET STRING

Return encoded word for ENCODING, CHARSET and STRING.

Package

cl-rfc2047

Source

encode.lisp (file)

Function: encoded-word-content-bytes CHARSET

Return number of maximum bytes per b-encoded word using CHARSET.

Package

cl-rfc2047

Source

encode.lisp (file)

Function: encoded-word-content-length CHARSET

Return maximum length of encoded word contents for CHARSET.

Package

cl-rfc2047

Source

encode.lisp (file)

Function: encoded-word-to STRING FROM

Find end of encoded word in STRING starting at FROM.

Package

cl-rfc2047

Source

decode.lisp (file)

Function: encoded-words ENCODING CHARSET STRINGS

Return encoded words for ENCODING, CHARSET and STRINGS.

Package

cl-rfc2047

Source

encode.lisp (file)

Function: intern* STRING

Intern STRING upcased in KEYWORD package.

Package

cl-rfc2047

Source

decode.lisp (file)

Function: limited-words PIECES LENGTH WORD-TYPE

Return list of words no longer than LENGTH concatenated from PIECES destructively.

Package

cl-rfc2047

Source

encode.lisp (file)

Function: lwsp-character-p CHARACTER

Predicate to test if CHARACTER is a LWSP-char.

Package

cl-rfc2047

Source

decode.lisp (file)

Function: parse-encoded-word ENCODED-WORD

Parse encoding, charset and encoded string of ENCODED-WORD.

Package

cl-rfc2047

Source

decode.lisp (file)

Function: q-decode ENCODED-STRING CHARSET

Decode ENCODED-STRING according to CHARSET.

Package

cl-rfc2047

Source

decode.lisp (file)

Function: q-encode STRING CHARSET

Return list of q encoded words for STRING using CHARSET.

Package

cl-rfc2047

Source

encode.lisp (file)

Function: q-encode-characters STRING CHARSET

Return list of q encoded characters for STRING using CHARSET.

Package

cl-rfc2047

Source

encode.lisp (file)

Function: q-encode-p CHARACTER

Predicate to test if CHARACTER needs to be q-encoded.

Package

cl-rfc2047

Source

encode.lisp (file)

Function: q-encode-string STRING CHARSET

Return q encoded STRING using CHARSET.

Package

cl-rfc2047

Source

encode.lisp (file)

Function: string-to-grouped-bytes STRING CHARSET

Return list of byte vectors for STRING using CHARSET.

Package

cl-rfc2047

Source

encode.lisp (file)

Function: unfold-crlfsp STRING

Replace any <CRLF SPACE> in STRING with <SPACE>.

Package

cl-rfc2047

Source

decode.lisp (file)

Function: write-decoded-underscore-value CHARSET STREAM

Write decoded *UNDERSCORE-VALUE* to STREAM according to CHARSET.

Package

cl-rfc2047

Source

decode.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-rfc2047.asd: The cl-rfc2047<dot>asd file
cl-rfc2047/constants.lisp: The cl-rfc2047/constants<dot>lisp file
cl-rfc2047/decode.lisp: The cl-rfc2047/decode<dot>lisp file
cl-rfc2047/encode.lisp: The cl-rfc2047/encode<dot>lisp file
cl-rfc2047/package.lisp: The cl-rfc2047/package<dot>lisp file

F
File, Lisp, cl-rfc2047.asd: The cl-rfc2047<dot>asd file
File, Lisp, cl-rfc2047/constants.lisp: The cl-rfc2047/constants<dot>lisp file
File, Lisp, cl-rfc2047/decode.lisp: The cl-rfc2047/decode<dot>lisp file
File, Lisp, cl-rfc2047/encode.lisp: The cl-rfc2047/encode<dot>lisp file
File, Lisp, cl-rfc2047/package.lisp: The cl-rfc2047/package<dot>lisp file

L
Lisp File, cl-rfc2047.asd: The cl-rfc2047<dot>asd file
Lisp File, cl-rfc2047/constants.lisp: The cl-rfc2047/constants<dot>lisp file
Lisp File, cl-rfc2047/decode.lisp: The cl-rfc2047/decode<dot>lisp file
Lisp File, cl-rfc2047/encode.lisp: The cl-rfc2047/encode<dot>lisp file
Lisp File, cl-rfc2047/package.lisp: The cl-rfc2047/package<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   B   C   D   E   F   I   L   P   Q   S   U   W  
Index Entry  Section

B
b-encode: Internal functions
b-split: Internal functions

C
character-ascii: Internal functions

D
decode: Exported functions
decode*: Exported functions
decode-bytes: Internal functions
decode-word: Internal functions
decode-word*: Internal functions

E
encode: Exported functions
encoded-word: Internal functions
encoded-word-content-bytes: Internal functions
encoded-word-content-length: Internal functions
encoded-word-to: Internal functions
encoded-words: Internal functions

F
Function, b-encode: Internal functions
Function, b-split: Internal functions
Function, character-ascii: Internal functions
Function, decode: Exported functions
Function, decode*: Exported functions
Function, decode-bytes: Internal functions
Function, decode-word: Internal functions
Function, decode-word*: Internal functions
Function, encode: Exported functions
Function, encoded-word: Internal functions
Function, encoded-word-content-bytes: Internal functions
Function, encoded-word-content-length: Internal functions
Function, encoded-word-to: Internal functions
Function, encoded-words: Internal functions
Function, intern*: Internal functions
Function, limited-words: Internal functions
Function, lwsp-character-p: Internal functions
Function, parse-encoded-word: Internal functions
Function, q-decode: Internal functions
Function, q-encode: Internal functions
Function, q-encode-characters: Internal functions
Function, q-encode-p: Internal functions
Function, q-encode-string: Internal functions
Function, should-encode-p: Exported functions
Function, string-to-grouped-bytes: Internal functions
Function, unfold-crlfsp: Internal functions
Function, write-decoded-underscore-value: Internal functions

I
intern*: Internal functions

L
limited-words: Internal functions
lwsp-character-p: Internal functions

P
parse-encoded-word: Internal functions

Q
q-decode: Internal functions
q-encode: Internal functions
q-encode-characters: Internal functions
q-encode-p: Internal functions
q-encode-string: Internal functions

S
should-encode-p: Exported functions
string-to-grouped-bytes: Internal functions

U
unfold-crlfsp: Internal functions

W
write-decoded-underscore-value: Internal functions

Jump to:   B   C   D   E   F   I   L   P   Q   S   U   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*ascii-boundary*: Internal special variables
*ascii-equals*: Internal special variables
*ascii-newline*: Internal special variables
*ascii-question-mark*: Internal special variables
*ascii-return*: Internal special variables
*ascii-space*: Internal special variables
*ascii-underscore*: Internal special variables
*crlfsp*: Internal special variables
*encoded-word-length*: Internal special variables
*encoded-word-length-overhead*: Internal special variables
*underscore-value*: Internal special variables

S
Special Variable, *ascii-boundary*: Internal special variables
Special Variable, *ascii-equals*: Internal special variables
Special Variable, *ascii-newline*: Internal special variables
Special Variable, *ascii-question-mark*: Internal special variables
Special Variable, *ascii-return*: Internal special variables
Special Variable, *ascii-space*: Internal special variables
Special Variable, *ascii-underscore*: Internal special variables
Special Variable, *crlfsp*: Internal special variables
Special Variable, *encoded-word-length*: Internal special variables
Special Variable, *encoded-word-length-overhead*: Internal special variables
Special Variable, *underscore-value*: Internal special variables

Jump to:   *  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
cl-rfc2047: The cl-rfc2047 system
cl-rfc2047: The cl-rfc2047 package
cl-rfc2047-asd: The cl-rfc2047-asd package

P
Package, cl-rfc2047: The cl-rfc2047 package
Package, cl-rfc2047-asd: The cl-rfc2047-asd package

S
System, cl-rfc2047: The cl-rfc2047 system

Jump to:   C   P   S