1054 lines
22 KiB
Plaintext
1054 lines
22 KiB
Plaintext
FLIM (Faithful Library about Internet Message) API
|
|
Version 1.14
|
|
Draft Release 3
|
|
|
|
* Notation
|
|
|
|
Each function is described by following notation:
|
|
|
|
[Function] NAME-OF-FUNCTION (SIGNATURE)
|
|
DESCRIPTIONS
|
|
[ILEVEL]<ULEVEL>
|
|
|
|
Each inline function is described by following notation:
|
|
|
|
[Inline function] NAME-OF-FUNCTION (SIGNATURE)
|
|
DESCRIPTIONS
|
|
[ILEVEL]<ULEVEL>
|
|
|
|
Each macro is described by following notation:
|
|
|
|
[Macro] NAME-OF-MACRO (SIGNATURE)
|
|
DESCRIPTIONS
|
|
[ILEVEL]<ULEVEL>
|
|
|
|
Each variable is described by following notation:
|
|
|
|
[Variable] NAME-OF-VARIABLE
|
|
DESCRIPTIONS
|
|
[ILEVEL]<ULEVEL>
|
|
|
|
ILEVEL specifies implementation level:
|
|
|
|
Required: Must implement
|
|
Suggest: Should implement
|
|
Optional: Optional
|
|
|
|
ULEVEL specifies implementation level:
|
|
|
|
Suggest: Should use
|
|
Not Suggest: Should not use
|
|
Obsolete: Should not use (historical)
|
|
|
|
|
|
* MIME entity
|
|
|
|
** How to use
|
|
|
|
(require 'mime)
|
|
|
|
|
|
** MIME-Entity Creation
|
|
|
|
[Function] mime-open-entity (type location)
|
|
Open an entity and return it.
|
|
|
|
TYPE is representation-type.
|
|
|
|
LOCATION is location of entity. Specification of it is depended on
|
|
representation-type.
|
|
|
|
[Required]<Suggest>
|
|
(Usage: SEMI 1.14 MIME-View)
|
|
|
|
|
|
[Function] mime-parse-buffer (&optional buffer representation-type)
|
|
Parse BUFFER as a MIME message.
|
|
|
|
If buffer is omitted, it parses current-buffer.
|
|
|
|
[Optional]<Not Suggest>
|
|
|
|
|
|
** MIME-Entity Hierarchy
|
|
|
|
[Function] mime-entity-children (entity)
|
|
Return list of entities included in the ENTITY.
|
|
|
|
[Required]<Suggest>
|
|
(Usage: SEMI 1.14 MIME-View, MIME-PGP)
|
|
|
|
|
|
[Function] mime-entity-parent (entity &optional message)
|
|
Return mother entity of ENTITY.
|
|
|
|
If MESSAGE is specified, it is regarded as root entity.
|
|
|
|
[Suggest]
|
|
(Usage: SEMI 1.14 MIME-View, MIME-PGP)
|
|
|
|
|
|
[Function] mime-find-root-entity (entity)
|
|
Return root entity of ENTITY.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] mime-root-entity-p (entity &optional message)
|
|
Return t if ENTITY is root-entity (message).
|
|
|
|
If MESSAGE is specified, it is regarded as root entity.
|
|
|
|
[Suggest]<Suggest>
|
|
|
|
|
|
[Function] mime-entity-node-id (entity)
|
|
Return node-id of ENTITY.
|
|
|
|
[Suggest]
|
|
(Usage: SEMI 1.14 MIME-View, MIME-PGP)
|
|
|
|
|
|
[Function] mime-entity-number (entity)
|
|
Return entity-number of ENTITY.
|
|
|
|
[Optional]
|
|
(Usage: SEMI 1.14 MIME-View, MIME-PGP)
|
|
|
|
|
|
** MIME-Entity Search
|
|
|
|
[Function] mime-find-entity-from-node-id (entity-node-id message)
|
|
Return entity from ENTITY-NODE-ID in MESSAGE.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] mime-find-entity-from-number (entity-number message)
|
|
Return entity from ENTITY-NUMBER in MESSAGE.
|
|
|
|
[Optional]
|
|
|
|
|
|
[Function] mime-find-entity-from-content-id (cid message)
|
|
Return entity from CID in MESSAGE.
|
|
|
|
[Suggest]<Suggest>
|
|
|
|
|
|
** MIME-Entity Attributes
|
|
|
|
[Function] mime-entity-content-type (entity)
|
|
Return content-type of ENTITY.
|
|
|
|
(cf. <** Content-Type>)
|
|
|
|
[Suggest]
|
|
(Usage: SEMI 1.14 MIME-View)
|
|
|
|
|
|
[Inline function] mime-entity-media-type (entity)
|
|
Return primary media-type of ENTITY.
|
|
|
|
[Suggest]<Not Suggest>
|
|
(Usage: SEMI 1.14 MIME-View)
|
|
|
|
|
|
[Inline function] mime-entity-media-subtype (entity)
|
|
Return media-subtype of ENTITY.
|
|
|
|
[Suggest]<Not Suggest>
|
|
(Usage: SEMI 1.14 MIME-View)
|
|
|
|
|
|
[Inline function] mime-entity-type/subtype (entity)
|
|
Return media-type/subtype of ENTITY.
|
|
|
|
[Suggest]
|
|
(Usage: SEMI 1.14 MIME-W3)
|
|
|
|
|
|
[Inline function] mime-entity-parameters (entity)
|
|
Return parameters of Content-Type of ENTITY.
|
|
|
|
[Suggest]<Not Suggest>
|
|
(Usage: SEMI 1.14 MIME-View)
|
|
|
|
|
|
[Function] mime-entity-set-content-type (entity content-type)
|
|
Set ENTITY's content-type to CONTENT-TYPE.
|
|
|
|
(cf. <** Content-Type>)
|
|
|
|
[Suggest]
|
|
(Usage: SEMI 1.14 MIME-View)
|
|
|
|
|
|
[Function] mime-entity-content-disposition (entity)
|
|
Return content-disposition of ENTITY.
|
|
|
|
(cf. <** Content-Disposition>)
|
|
|
|
[Suggest]
|
|
(Usage: SEMI 1.14 MIME-View)
|
|
|
|
|
|
[Function] mime-entity-filename (entity)
|
|
Return filename of ENTITY.
|
|
|
|
[Suggest]
|
|
(Usage: SEMI 1.14 MIME-View)
|
|
|
|
|
|
[Function] mime-entity-encoding (entity)
|
|
Return content-transfer-encoding of ENTITY.
|
|
|
|
If the ENTITY does not have valid Content-Transfer-Encoding field,
|
|
return nil.
|
|
|
|
[Suggest]
|
|
(Usage: SEMI 1.14 MIME-View)
|
|
|
|
|
|
[Function] mime-entity-set-encoding (entity encoding)
|
|
Set ENTITY's content-transfer-encoding to ENCODING.
|
|
|
|
[Suggest]
|
|
(Usage: SEMI 1.14 MIME-View)
|
|
|
|
|
|
[Function] mime-entity-cooked-p (entity)
|
|
Return non-nil if contents of ENTITY has been already
|
|
code-converted.
|
|
|
|
[Suggest]
|
|
(Usage: SEMI 1.14 MIME-PGP)
|
|
|
|
|
|
[Function] mime-entity-name (entity)
|
|
Return unique name of the ENTITY.
|
|
|
|
[Suggest]
|
|
(Usage: SEMI 1.14 MIME-View)
|
|
|
|
|
|
** MIME-Entity Header
|
|
|
|
[Function] mime-entity-fetch-field (entity field-name)
|
|
Return the value of the ENTITY's header field whose type is
|
|
FIELD-NAME.
|
|
|
|
The results is network representation.
|
|
|
|
If FIELD-NAME field is not found, this function returns nil.
|
|
|
|
[Required]<Suggest>
|
|
(Usage: SEMI 1.14 MIME-View, MIME-BBDB)
|
|
|
|
|
|
[Function] mime-entity-read-field (entity field-name)
|
|
Parse FIELD-NAME field in header of ENTITY, and return the result.
|
|
|
|
Format of result is depended on kind of field. For non-structured
|
|
field, this function returns string. For structured field, it
|
|
returns list corresponding with structure of the field.
|
|
|
|
Strings in the result will be converted to internal representation
|
|
of Emacs.
|
|
|
|
If FIELD-NAME field is not found, this function returns nil.
|
|
|
|
[Suggest]
|
|
(Usage: SEMI 1.14 MIME-View, MIME-BBDB)
|
|
|
|
|
|
** Text Presentation of MIME-Entity Content
|
|
|
|
[Function] mime-insert-header (entity &optional invisible-fields
|
|
visible-fields)
|
|
Insert before point a decoded header of ENTITY.
|
|
|
|
INVISIBLE-FIELDS is list of regexps to match field-name to hide.
|
|
VISIBLE-FIELDS is list of regexps to match field-name to hide.
|
|
|
|
If a field-name is matched with some elements of INVISIBLE-FIELDS
|
|
and matched with none of VISIBLE-FIELDS, this function don't insert
|
|
the field.
|
|
|
|
Each encoded-word in the header is decoded. ``Raw non us-ascii
|
|
characters'' are also decoded as `default-mime-charset'.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] mime-insert-text-content (entity)
|
|
Insert before point a contents of ENTITY as text entity.
|
|
|
|
Contents of the ENTITY are decoded as MIME charset. If the ENTITY
|
|
does not have charset parameter of Content-Type field,
|
|
`default-mime-charset' is used as default value.
|
|
|
|
[Required]
|
|
|
|
|
|
[Variable] default-mime-charset
|
|
Symbol to indicate default value of MIME charset.
|
|
|
|
It is used when MIME charset is not specified.
|
|
|
|
It is originally variable of APEL.
|
|
|
|
[Required]
|
|
|
|
|
|
** Bytes Representation of MIME-Entity Content
|
|
|
|
[Function] mime-entity-content (entity)
|
|
Return content of ENTITY as byte sequence (string).
|
|
|
|
[Required]
|
|
(Usage: SEMI 1.14 MIME-View, Postpet)
|
|
|
|
|
|
[Function] mime-insert-entity-content (entity)
|
|
Insert content of ENTITY (byte sequence) at point.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] mime-write-entity-content (entity filename)
|
|
Write content of ENTITY (byte sequence) into FILENAME.
|
|
|
|
[Required]
|
|
|
|
|
|
** Network Representation of MIME-Entity
|
|
|
|
[Function] mime-entity-string (entity)
|
|
Return header and body of ENTITY (string).
|
|
|
|
[Optional]<Not Suggest>
|
|
|
|
|
|
[Function] mime-insert-entity (entity)
|
|
Insert header and body of ENTITY at point.
|
|
|
|
[Required]
|
|
|
|
|
|
[Function] mime-write-entity (entity filename)
|
|
Write header and body of ENTITY into FILENAME.
|
|
|
|
[Required]
|
|
|
|
|
|
[Function] mime-entity-header (entity)
|
|
Return network representation of ENTITY header (string).
|
|
|
|
[Optional]<Not Suggest>
|
|
|
|
|
|
[Function] mime-insert-entity-header (entity)
|
|
Insert network representation of ENTITY header at point.
|
|
|
|
[Optional]<Not Suggest>
|
|
|
|
|
|
[Function] mime-write-entity-header (entity filename)
|
|
Write network representation of ENTITY header FILENAME.
|
|
|
|
[Optional]<Not Suggest>
|
|
|
|
|
|
[Function] mime-entity-body (entity)
|
|
Return network representation of ENTITY body (string).
|
|
|
|
[Optional]<Not Suggest>
|
|
|
|
|
|
[Function] mime-insert-entity-body (entity)
|
|
Insert network representation of ENTITY body at point.
|
|
|
|
[Required]
|
|
|
|
|
|
[Function] mime-write-entity-body (entity filename)
|
|
Write body of ENTITY into FILENAME.
|
|
|
|
[Required]
|
|
|
|
|
|
* MIME content information
|
|
|
|
** How to use
|
|
|
|
(require 'mime)
|
|
|
|
|
|
** Content-Type
|
|
|
|
[Function] mime-parse-Content-Type (string)
|
|
Parse STRING as field-body of Content-Type field, and
|
|
return the result as `mime-content-type' structure.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] mime-read-Content-Type ()
|
|
Read field-body of Content-Type field from current-buffer,
|
|
and return the parsed result.
|
|
|
|
Format of return value is as same as `mime-parse-Content-Type'.
|
|
|
|
Return `nil' if Content-Type field is not found.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Inline function] mime-content-type-primary-type (content-type)
|
|
Return primary-type of CONTENT-TYPE.
|
|
|
|
[Required]
|
|
|
|
|
|
[Inline function] mime-content-type-subtype (content-type)
|
|
Return subtype of CONTENT-TYPE.
|
|
|
|
[Required]
|
|
|
|
|
|
[Inline function] mime-content-type-parameter (content-type parameter)
|
|
Return PARAMETER value of CONTENT-TYPE.
|
|
|
|
[Required]
|
|
|
|
|
|
[Inline function] mime-content-type-parameters (content-type)
|
|
Return parameters of CONTENT-TYPE.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Inline function] mime-type/subtype-string (type &optional subtype)
|
|
Return type/subtype string from TYPE and SUBTYPE.
|
|
|
|
[Suggest]
|
|
|
|
|
|
** Content-Disposition
|
|
|
|
[Function] mime-parse-Content-Disposition (string)
|
|
Parse STRING as field-body of Content-Disposition field.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] mime-read-Content-Disposition ()
|
|
Read field-body of Content-Disposition field from current-buffer,
|
|
and return parsed it.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Inline function] mime-content-disposition-type (content-disposition)
|
|
Return disposition-type of CONTENT-DISPOSITION.
|
|
|
|
[Required]
|
|
|
|
|
|
[Inline function] mime-content-disposition-parameter
|
|
(content-disposition parameter)
|
|
Return PARAMETER value of CONTENT-DISPOSITION.
|
|
|
|
[Required]
|
|
|
|
|
|
[Inline function] mime-content-disposition-filename (content-disposition)
|
|
Return filename of CONTENT-DISPOSITION.
|
|
|
|
[Suggest]<Suggest>
|
|
|
|
|
|
[Inline function] mime-content-disposition-parameters (content-disposition)
|
|
Return disposition-parameters of CONTENT-DISPOSITION.
|
|
|
|
[Suggest]
|
|
|
|
|
|
* encoded-word
|
|
|
|
** How to use
|
|
|
|
(require 'mime)
|
|
|
|
|
|
** decoder
|
|
|
|
[Function] mime-decode-header-in-buffer (&optional code-conversion
|
|
separator)
|
|
Decode MIME encoded-words in header fields.
|
|
|
|
If CODE-CONVERSION is nil, it decodes only encoded-words. If it is
|
|
mime-charset, it decodes non-ASCII bit patterns as the mime-charset.
|
|
Otherwise it decodes non-ASCII bit patterns as the
|
|
default-mime-charset.
|
|
|
|
If SEPARATOR is not nil, it is used as header separator.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] eword-decode-header (&optional code-conversion separator)
|
|
As same as `mime-decode-header-in-buffer', q.v.
|
|
|
|
Note that
|
|
|
|
(require 'eword-decode)
|
|
|
|
is necessary to use this function.
|
|
|
|
[Optional]<Obsolete> (Usage: cmail 2.61)
|
|
|
|
|
|
[Function] mime-decode-header-in-region (start end
|
|
&optional code-conversion)
|
|
Decode MIME encoded-words in region between START and END.
|
|
|
|
If CODE-CONVERSION is nil, it decodes only encoded-words. If it is
|
|
mime-charset, it decodes non-ASCII bit patterns as the mime-charset.
|
|
Otherwise it decodes non-ASCII bit patterns as the
|
|
default-mime-charset.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] mime-decode-field-body (field-body field-name
|
|
&optional mode max-column)
|
|
Decode FIELD-BODY as FIELD-NAME in MODE, and return the result.
|
|
|
|
Optional argument MODE must be `plain', `wide', `summary' or `nov'.
|
|
Default mode is `summary'.
|
|
|
|
If MODE is `wide' and MAX-COLUMN is non-nil, the result is folded
|
|
with MAX-COLUMN.
|
|
|
|
Non MIME encoded-word part in FILED-BODY is decoded with
|
|
`default-mime-charset'.
|
|
|
|
[Required]<Suggest>
|
|
|
|
|
|
[Function] mime-set-field-decoder (field &rest specs)
|
|
Set decoder of FIELD.
|
|
|
|
SPECS must be like `MODE1 DECODER1 MODE2 DECODER2 ...'.
|
|
|
|
Each mode must be `nil', `plain', `wide', `summary' or `nov'. If
|
|
mode is `nil', corresponding decoder is set up for every modes.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Macro] mime-find-field-presentation-method (name)
|
|
Return field-presentation-method from NAME.
|
|
|
|
NAME must be `plain', `wide', `summary' or `nov'.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] mime-find-field-decoder (field &optional mode)
|
|
Return function to decode field-body of FIELD in MODE.
|
|
|
|
Optional argument MODE must be object or name of
|
|
field-presentation-method. Name of field-presentation-method must
|
|
be `plain', `wide', `summary' or `nov'. Default value of MODE is
|
|
`summary'.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] mime-update-field-decoder-cache (field mode &optional function)
|
|
Update field decoder cache `mime-field-decoder-cache'.
|
|
|
|
[Suggest]
|
|
|
|
|
|
** encoder
|
|
|
|
[Function] mime-encode-header-in-buffer (&optional code-conversion)
|
|
Encode header fields to network representation, such as MIME
|
|
encoded-word.
|
|
|
|
It refer variable `mime-field-encoding-method-alist'.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] mime-encode-field-body (field-body field-name)
|
|
Encode FIELD-BODY as FIELD-NAME, and return the result.
|
|
|
|
A lexical token includes non-ASCII character is encoded as MIME
|
|
encoded-word. ASCII token is not encoded.
|
|
|
|
[Required]<Suggest>
|
|
|
|
|
|
* Content-Transfer-Encoding
|
|
|
|
** How to use
|
|
|
|
(require 'mel)
|
|
|
|
|
|
** Encoding Name
|
|
|
|
[Variable] mime-encoding-list
|
|
List of Content-Transfer-Encoding. Each encoding must be string.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] mime-encoding-list (&optional service)
|
|
Return list of Content-Transfer-Encoding.
|
|
|
|
If SERVICE is specified, it returns available list of
|
|
Content-Transfer-Encoding for it.
|
|
|
|
[Required]<Suggest>
|
|
|
|
|
|
[Function] mime-encoding-alist (&optional service)
|
|
Return table of Content-Transfer-Encoding for completion.
|
|
|
|
[Suggest]
|
|
|
|
|
|
** String
|
|
|
|
[Function] mime-decode-string (string encoding)
|
|
Decode STRING using ENCODING.
|
|
|
|
ENCODING must be string. If ENCODING is found in
|
|
`mime-encoding-list', this function decodes the STRING by its value.
|
|
|
|
[Required]<Suggest>
|
|
|
|
|
|
[Function] mime-encode-string (string encoding)
|
|
Encode STRING using ENCODING.
|
|
|
|
ENCODING must be string.
|
|
|
|
[Required]<Suggest>
|
|
|
|
|
|
[Function] base64-decode-string (STRING)
|
|
Base64-decode STRING and return the result.
|
|
|
|
[Required]
|
|
|
|
|
|
[Function] base64-encode-string (STRING &optional NO-LINE-BREAK)
|
|
Base64-encode STRING and return the result.
|
|
|
|
Optional second argument NO-LINE-BREAK means do not break long lines
|
|
into shorter lines.
|
|
|
|
[Required]
|
|
|
|
|
|
** File
|
|
|
|
[Command] mime-write-decoded-region (start end filename encoding)
|
|
Decode and write current region encoded by ENCODING into FILENAME.
|
|
|
|
START and END are buffer positions.
|
|
|
|
[Required]<Suggest>
|
|
|
|
|
|
[Command] mime-insert-encoded-file (filename encoding)
|
|
Insert file FILENAME encoded by ENCODING format.
|
|
|
|
[Required]<Suggest>
|
|
|
|
|
|
[Command] 7bit-write-decoded-region (start end filename)
|
|
Decode and write current region encoded by "7bit" into FILENAME.
|
|
|
|
START and END are buffer positions.
|
|
|
|
[Optional]
|
|
|
|
|
|
[Command] 7bit-insert-encoded-file (filename)
|
|
Insert file FILENAME encoded by "7bit" format.
|
|
|
|
[Optional]
|
|
|
|
|
|
[Command] 8bit-write-decoded-region (start end filename)
|
|
Decode and write current region encoded by "8bit" into FILENAME.
|
|
|
|
START and END are buffer positions.
|
|
|
|
[Optional]
|
|
|
|
|
|
[Command] 8bit-insert-encoded-file (filename)
|
|
Insert file FILENAME encoded by "8bit" format.
|
|
|
|
[Optional]
|
|
|
|
|
|
[Command] binary-write-decoded-region (start end filename)
|
|
Decode and write current region encoded by "binary" into FILENAME.
|
|
|
|
START and END are buffer positions.
|
|
|
|
[Required]
|
|
|
|
|
|
[Command] binary-insert-encoded-file (filename)
|
|
Insert file FILENAME encoded by "binary" format.
|
|
|
|
[Required]
|
|
|
|
|
|
[Command] base64-write-decoded-region (start end filename)
|
|
Decode and write current region encoded by "base64" into FILENAME.
|
|
|
|
START and END are buffer positions.
|
|
|
|
[Optional]
|
|
|
|
|
|
[Command] base64-insert-encoded-file (filename)
|
|
Insert file FILENAME encoded by "base64" format.
|
|
|
|
[Optional]
|
|
|
|
|
|
[Command] quoted-printable-write-decoded-region (start end filename)
|
|
Decode and write current region encoded by "quoted-printable" into
|
|
FILENAME.
|
|
|
|
START and END are buffer positions.
|
|
|
|
[Optional]
|
|
|
|
|
|
[Command] quoted-printable-insert-encoded-file (filename)
|
|
Insert file FILENAME encoded by "quoted-printable" format.
|
|
|
|
[Optional]
|
|
|
|
|
|
** Region
|
|
|
|
[Command] mime-decode-region (start end encoding)
|
|
Decode region START to END of current buffer using ENCODING.
|
|
|
|
ENCODING must be string.
|
|
|
|
[Suggest]<Not Suggest>
|
|
|
|
|
|
[Command] mime-encode-region (start end encoding)
|
|
Encode region START to END of current buffer using ENCODING.
|
|
|
|
ENCODING must be string.
|
|
|
|
[Suggest]<Not Suggest>
|
|
|
|
|
|
[Command] base64-decode-region (BEG END)
|
|
Base64-decode the region between BEG and END.
|
|
|
|
Return the length of the decoded text.
|
|
|
|
If the region can't be decoded, return nil and don't modify the
|
|
buffer.
|
|
|
|
[Suggest]<Not Suggest>
|
|
|
|
|
|
[Command] base64-encode-region (BEG END &optional NO-LINE-BREAK)
|
|
Base64-encode the region between BEG and END.
|
|
|
|
Return the length of the encoded text.
|
|
|
|
Optional third argument NO-LINE-BREAK means do not break long lines
|
|
into shorter lines.
|
|
|
|
[Suggest]<Not Suggest>
|
|
|
|
|
|
** encoded-text
|
|
|
|
[Function] encoded-text-decode-string (string encoding)
|
|
Decode STRING as encoded-text using ENCODING.
|
|
|
|
ENCODING must be string.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] encoded-text-encode-string (string encoding &optional mode)
|
|
Encode STRING as encoded-text using ENCODING.
|
|
|
|
ENCODING must be string.
|
|
|
|
MODE allows `text', `comment', `phrase' or nil. Default value is
|
|
`phrase'.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] base64-encoded-length (string)
|
|
Return length of B-encoded STRING.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] Q-encoded-text-length (string &optional mode)
|
|
Return length of Q-encoded STRING.
|
|
|
|
MODE allows `text', `comment', `phrase' or nil. Default value is
|
|
`phrase'.
|
|
|
|
[Suggest]
|
|
|
|
|
|
* Mailcap
|
|
|
|
** How to use
|
|
|
|
(require 'mime-conf)
|
|
|
|
|
|
** Parsing
|
|
|
|
[Function] mime-parse-mailcap-buffer (&optional buffer order)
|
|
Parse BUFFER as a mailcap, and return the result.
|
|
|
|
If optional argument ORDER is a function, result is sorted by it.
|
|
If optional argument ORDER is not specified, result is sorted
|
|
original order. Otherwise result is not sorted.
|
|
|
|
[Required]<Suggest>
|
|
|
|
|
|
[Variable] mime-mailcap-file
|
|
File name of user's mailcap file.
|
|
|
|
[Required]<Suggest> (default value may be "~/.mailcap")
|
|
|
|
|
|
[Function] mime-parse-mailcap-file (&optional filename order)
|
|
Parse FILENAME as a mailcap, and return the result.
|
|
|
|
If optional argument ORDER is a function, result is sorted by it.
|
|
If optional argument ORDER is not specified, result is sorted
|
|
original order. Otherwise result is not sorted.
|
|
|
|
[Required]<Suggest>
|
|
|
|
|
|
** Apply
|
|
|
|
[Function] mime-format-mailcap-command (mtext situation)
|
|
Return formated command string from MTEXT and SITUATION.
|
|
|
|
MTEXT is a command text of mailcap specification, such as
|
|
view-command.
|
|
|
|
SITUATION is an association-list about information of entity. Its
|
|
key may be:
|
|
|
|
'type primary media-type
|
|
'subtype media-subtype
|
|
'filename filename
|
|
STRING parameter of Content-Type field
|
|
|
|
[Required]<Suggest>
|
|
|
|
|
|
* MIME Field
|
|
|
|
** How to use
|
|
|
|
(require 'mime)
|
|
|
|
|
|
** Parsing
|
|
|
|
[Variable] mime-field-parser-alist
|
|
Alist to specify field parser.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] mime-parse-msg-id (tokens)
|
|
Parse TOKENS as msg-id of Content-Id or Message-Id field.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] mime-uri-parse-cid (string)
|
|
Parse STRING as cid URI.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] mime-parse-Content-Transfer-Encoding (string)
|
|
Parse STRING as field-body of Content-Transfer-Encoding field.
|
|
If STRING is not a valid Content-Transfer-Encoding field,
|
|
return nil.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] mime-read-Content-Transfer-Encoding ()
|
|
Read field-body of Content-Transfer-Encoding field from
|
|
current-buffer, and return it.
|
|
|
|
[Suggest]
|
|
|
|
|
|
* STD 11
|
|
|
|
** How to use
|
|
|
|
(require 'std11)
|
|
|
|
|
|
** Header
|
|
|
|
[Function] std11-narrow-to-header (&optional boundary)
|
|
Narrow to the message header.
|
|
|
|
If BOUNDARY is not nil, it is used as message header separator.
|
|
|
|
[Required]
|
|
|
|
|
|
** Field
|
|
|
|
[Function] std11-fetch-field (name)
|
|
Return the value of the header field NAME.
|
|
|
|
The buffer is expected to be narrowed to just the headers of the
|
|
message.
|
|
|
|
[Required]
|
|
|
|
|
|
[Function] std11-field-body (name &optional boundary)
|
|
Return the value of the header field NAME.
|
|
|
|
If BOUNDARY is not nil, it is used as message header separator.
|
|
|
|
[Required]
|
|
|
|
|
|
[Function] std11-unfold-string (string)
|
|
Unfold STRING as message header field.
|
|
|
|
[Required]
|
|
|
|
|
|
** Lexical Analysis
|
|
|
|
[Function] std11-lexical-analyze (string &optional analyzer start)
|
|
Analyze STRING as lexical tokens of STD 11.
|
|
|
|
[Suggest]
|
|
|
|
|
|
** Address
|
|
|
|
[Function] std11-address-string (address)
|
|
Return string of address part from parsed ADDRESS of RFC 822.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] std11-full-name-string (address)
|
|
Return string of full-name part from parsed ADDRESS of RFC 822.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] std11-parse-address-string (string)
|
|
Parse STRING as mail address.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] std11-parse-addresses-string (string)
|
|
Parse STRING as mail address list.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] std11-extract-address-components (string)
|
|
Extract full name and canonical address from STRING.
|
|
|
|
Returns a list of the form (FULL-NAME CANONICAL-ADDRESS). If no
|
|
name can be extracted, FULL-NAME will be nil.
|
|
|
|
[Suggest]
|
|
|
|
|
|
** Message-ID
|
|
|
|
[Function] std11-msg-id-string (msg-id)
|
|
Return string from parsed MSG-ID of RFC 822.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] std11-parse-msg-id-string (string)
|
|
Parse STRING as msg-id.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] std11-parse-msg-ids-string (string)
|
|
Parse STRING as `*(phrase / msg-id)'.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] std11-fill-msg-id-list-string (string &optional column)
|
|
Fill list of msg-id in STRING, and return the result.
|
|
|
|
[Suggest]
|
|
|
|
|
|
* SMTP
|
|
|
|
** How to use
|
|
|
|
(require 'smtp)
|
|
|
|
|
|
** Features
|
|
|
|
[Function] smtp-send-buffer (sender recipients buffer)
|
|
Send a message.
|
|
|
|
SENDER is an envelope sender address.
|
|
RECIPIENTS is a list of envelope recipient addresses.
|
|
BUFFER may be a buffer or a buffer name which contains mail message.
|
|
|
|
[Suggest]
|
|
|
|
|
|
[Function] smtp-via-smtp (sender recipients buffer)
|
|
Like `smtp-send-buffer', but sucks in any errors.
|
|
|
|
[Optional]<Not Suggest>
|