FLIM (Faithful Library about Internet Message) API
Version 1.14
- Draft Release 1
+ Draft Release 3
* Notation
(Usage: SEMI 1.14 MIME-View)
-[Function] mime-entity-encoding (entity &optional default-encoding)
+[Function] mime-entity-encoding (entity)
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 valid Content-Transfer-Encoding field,
+ return nil.
[Suggest]
(Usage: SEMI 1.14 MIME-View)
** 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] 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.
-[Function] mime-write-decoded-region (start end filename encoding)
+ [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>
-** 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
[Required]<Suggest>
-* MIME Field parsing
+* MIME Field
** How to use
(require 'mime)
-** Level 2 features
+** Parsing
[Variable] mime-field-parser-alist
Alist to specify field parser.
+ [Suggest]
-[Function] mime-parse-Content-Type (string)
- Parse STRING as field-body of Content-Type field.
-
-Return value is
- (PRIMARY-TYPE SUBTYPE (NAME1 . VALUE1)(NAME2 . VALUE2) ...)
-or nil. PRIMARY-TYPE and SUBTYPE are symbol and NAME_n and VALUE_n
-are string.
+[Function] mime-parse-msg-id (tokens)
+ Parse TOKENS as msg-id of Content-Id or Message-Id field.
-[Function] mime-read-Content-Type ()
- Read field-body of Content-Type field from current-buffer,
-and return parsed it. Format of return value is as same as
-`mime-parse-Content-Type'.
+ [Suggest]
-[Function] mime-parse-Content-Disposition (string)
- Parse STRING as field-body of Content-Disposition field.
-
+[Function] mime-uri-parse-cid (string)
+ Parse STRING as cid URI.
-[Function] mime-read-Content-Disposition ()
- Read field-body of Content-Disposition field from current-buffer,
-and return parsed it.
+ [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 (&optional default-encoding)
+
+[Function] mime-read-Content-Transfer-Encoding ()
Read field-body of Content-Transfer-Encoding field from
-current-buffer, and return it.
+ current-buffer, and return it.
-If is is not found, return DEFAULT-ENCODING.
+ [Suggest]
-[Function] mime-parse-msg-id (tokens)
- Parse TOKENS as msg-id of Content-Id or Message-Id field.
+* STD 11
+** How to use
-[Function] mime-uri-parse-cid (string)
- Parse STRING as cid URI.
+(require 'std11)
-* STD 11 parsing
+** Header
-** How to use
+[Function] std11-narrow-to-header (&optional boundary)
+ Narrow to the message header.
-(require 'std11)
+ If BOUNDARY is not nil, it is used as message header separator.
+
+ [Required]
-** Level 1 features
+** 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.
-
-
-[Function] std11-narrow-to-header (&optional boundary)
- Narrow to the message header.
+ The buffer is expected to be narrowed to just the headers of the
+ message.
-If BOUNDARY is not nil, it is used as message header separator.
+ [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.
+ 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]
-** Level 2 features
+
+** 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.
-
-[Function] std11-msg-id-string (msg-id)
- Return string from parsed MSG-ID of RFC 822.
-
-
-[Function] std11-fill-msg-id-list-string (string &optional column)
- Fill list of msg-id in STRING, and return the result.
+ [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-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.
+[Function] std11-fill-msg-id-list-string (string &optional column)
+ Fill list of msg-id in STRING, and return the result.
+
+ [Suggest]
* SMTP
[Suggest]
+
[Function] smtp-via-smtp (sender recipients buffer)
Like `smtp-send-buffer', but sucks in any errors.