+ FLIM (Faithful Library about Internet Message) API
+ Version 1.14
+ Draft Release 1
+
* Notation
Each function is described by following notation:
representation-type.
[Required]<Suggest>
+ (Usage: SEMI 1.14 MIME-View)
[Function] mime-parse-buffer (&optional buffer representation-type)
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)
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)
If MESSAGE is specified, it is regarded as root entity.
- [Suggest]
+ [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
[Suggest]<Suggest>
-[Function] mime-find-root-entity (entity)
- Return root entity of ENTITY.
+** MIME-Entity Attributes
+
+[Function] mime-entity-content-type (entity)
+ Return content-type of ENTITY.
+
+ (cf. <** Content-Type>)
[Suggest]
+ (Usage: SEMI 1.14 MIME-View)
-** MIME-Entity Attributes
+[Inline function] mime-entity-media-type (entity)
+ Return primary media-type of ENTITY.
-[Function] mime-entity-content-type (entity)
- Return content-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 &optional default-encoding)
Return content-transfer-encoding of ENTITY.
-If the ENTITY does not have Content-Transfer-Encoding field, this
-function returns DEFAULT-ENCODING. If it is nil, "7bit" is used as
-default value.
+ If the ENTITY does not have Content-Transfer-Encoding field, this
+ function returns DEFAULT-ENCODING. If it is nil, "7bit" is used as
+ default value.
[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)
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
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)
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
Return content of ENTITY as byte sequence (string).
[Required]
+ (Usage: SEMI 1.14 MIME-View, Postpet)
[Function] mime-insert-entity-content (entity)
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'."
+ Format of return value is as same as `mime-parse-Content-Type'.
Return `nil' if Content-Type field is not found.
** 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.
-
-[Function] mime-parse-Content-Disposition (string)
- Parse STRING as field-body of Content-Disposition field.
-
-
-[Function] mime-read-Content-Disposition ()
- Read field-body of Content-Disposition field from current-buffer,
-and return parsed it.
+ [Suggest]
* encoded-word
** decoder
-[Function] mime-decode-header-in-buffer (&optional code-conversion separator)
+[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
[Suggest]
+[Function] [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.
[Suggest]
-** Decoder
+** String
[Function] mime-decode-string (string encoding)
Decode STRING using ENCODING.
[Required]<Suggest>
-[Function] mime-decode-region (start end encoding)
- Decode region START to END of current buffer using ENCODING.
+[Function] mime-encode-string (string encoding)
+ Encode STRING using ENCODING.
ENCODING must be string.
- [Suggest]<Not Suggest>
+ [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]
-[Function] mime-write-decoded-region (start end filename encoding)
+** 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>
-** Encoder
+[Command] mime-insert-encoded-file (filename encoding)
+ Insert file FILENAME encoded by ENCODING format.
-[Function] mime-encode-string (string encoding)
- Encode STRING using ENCODING.
+ [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.
- [Optional]<Not Suggest>
+ [Suggest]<Not Suggest>
-[Function] mime-encode-region (start end encoding)
+[Command] mime-encode-region (start end encoding)
Encode region START to END of current buffer using ENCODING.
ENCODING must be string.
[Suggest]<Not Suggest>
-[Function] mime-insert-encoded-file (filename encoding)
- Insert file FILENAME encoded by ENCODING format.
+[Command] base64-decode-region (BEG END)
+ Base64-decode the region between BEG and END.
- [Required]<Suggest>
+ 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] 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.
+ Returns a list of the form (FULL-NAME CANONICAL-ADDRESS). If no
+ name can be extracted, FULL-NAME will be nil.
* SMTP
(require 'smtp)
-** Level 1 features
+** 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.
-* QMTP
-
-** How to use
-
-(require 'qmtp)
-
+ [Suggest]
-** Level 1 features
+[Function] smtp-via-smtp (sender recipients buffer)
+ Like `smtp-send-buffer', but sucks in any errors.
-[Function] qmtp-send-buffer (sender recipients buffer)
+ [Optional]<Not Suggest>
projects / elisp / flim.git / blobdiff