1 FLIM (Faithful Library about Internet Message) API
7 Each function is described by following notation:
9 [Function] NAME-OF-FUNCTION (SIGNATURE)
13 Each inline function is described by following notation:
15 [Inline function] NAME-OF-FUNCTION (SIGNATURE)
19 Each macro is described by following notation:
21 [Macro] NAME-OF-MACRO (SIGNATURE)
25 Each variable is described by following notation:
27 [Variable] NAME-OF-VARIABLE
31 ILEVEL specifies implementation level:
33 Required: Must implement
34 Suggest: Should implement
37 ULEVEL specifies implementation level:
40 Not Suggest: Should not use
41 Obsolete: Should not use (historical)
51 ** MIME-Entity Creation
53 [Function] mime-open-entity (type location)
54 Open an entity and return it.
56 TYPE is representation-type.
58 LOCATION is location of entity. Specification of it is depended on
62 (Usage: SEMI 1.14 MIME-View)
65 [Function] mime-parse-buffer (&optional buffer representation-type)
66 Parse BUFFER as a MIME message.
68 If buffer is omitted, it parses current-buffer.
70 [Optional]<Not Suggest>
73 ** MIME-Entity Hierarchy
75 [Function] mime-entity-children (entity)
76 Return list of entities included in the ENTITY.
79 (Usage: SEMI 1.14 MIME-View, MIME-PGP)
82 [Function] mime-entity-parent (entity &optional message)
83 Return mother entity of ENTITY.
85 If MESSAGE is specified, it is regarded as root entity.
88 (Usage: SEMI 1.14 MIME-View, MIME-PGP)
91 [Function] mime-find-root-entity (entity)
92 Return root entity of ENTITY.
97 [Function] mime-root-entity-p (entity &optional message)
98 Return t if ENTITY is root-entity (message).
100 If MESSAGE is specified, it is regarded as root entity.
105 [Function] mime-entity-node-id (entity)
106 Return node-id of ENTITY.
109 (Usage: SEMI 1.14 MIME-View, MIME-PGP)
112 [Function] mime-entity-number (entity)
113 Return entity-number of ENTITY.
116 (Usage: SEMI 1.14 MIME-View, MIME-PGP)
119 ** MIME-Entity Search
121 [Function] mime-find-entity-from-node-id (entity-node-id message)
122 Return entity from ENTITY-NODE-ID in MESSAGE.
127 [Function] mime-find-entity-from-number (entity-number message)
128 Return entity from ENTITY-NUMBER in MESSAGE.
133 [Function] mime-find-entity-from-content-id (cid message)
134 Return entity from CID in MESSAGE.
139 ** MIME-Entity Attributes
141 [Function] mime-entity-content-type (entity)
142 Return content-type of ENTITY.
144 (cf. <** Content-Type>)
147 (Usage: SEMI 1.14 MIME-View)
150 [Inline function] mime-entity-media-type (entity)
151 Return primary media-type of ENTITY.
153 [Suggest]<Not Suggest>
154 (Usage: SEMI 1.14 MIME-View)
157 [Inline function] mime-entity-media-subtype (entity)
158 Return media-subtype of ENTITY.
160 [Suggest]<Not Suggest>
161 (Usage: SEMI 1.14 MIME-View)
164 [Inline function] mime-entity-type/subtype (entity)
165 Return media-type/subtype of ENTITY.
168 (Usage: SEMI 1.14 MIME-W3)
171 [Inline function] mime-entity-parameters (entity)
172 Return parameters of Content-Type of ENTITY.
174 [Suggest]<Not Suggest>
175 (Usage: SEMI 1.14 MIME-View)
178 [Function] mime-entity-set-content-type (entity content-type)
179 Set ENTITY's content-type to CONTENT-TYPE.
181 (cf. <** Content-Type>)
184 (Usage: SEMI 1.14 MIME-View)
187 [Function] mime-entity-content-disposition (entity)
188 Return content-disposition of ENTITY.
190 (cf. <** Content-Disposition>)
193 (Usage: SEMI 1.14 MIME-View)
196 [Function] mime-entity-filename (entity)
197 Return filename of ENTITY.
200 (Usage: SEMI 1.14 MIME-View)
203 [Function] mime-entity-encoding (entity &optional default-encoding)
204 Return content-transfer-encoding of ENTITY.
206 If the ENTITY does not have Content-Transfer-Encoding field, this
207 function returns DEFAULT-ENCODING. If it is nil, "7bit" is used as
211 (Usage: SEMI 1.14 MIME-View)
214 [Function] mime-entity-set-encoding (entity encoding)
215 Set ENTITY's content-transfer-encoding to ENCODING.
218 (Usage: SEMI 1.14 MIME-View)
221 [Function] mime-entity-cooked-p (entity)
222 Return non-nil if contents of ENTITY has been already
226 (Usage: SEMI 1.14 MIME-PGP)
229 [Function] mime-entity-name (entity)
230 Return unique name of the ENTITY.
233 (Usage: SEMI 1.14 MIME-View)
236 ** MIME-Entity Header
238 [Function] mime-entity-fetch-field (entity field-name)
239 Return the value of the ENTITY's header field whose type is
242 The results is network representation.
244 If FIELD-NAME field is not found, this function returns nil.
247 (Usage: SEMI 1.14 MIME-View, MIME-BBDB)
250 [Function] mime-entity-read-field (entity field-name)
251 Parse FIELD-NAME field in header of ENTITY, and return the result.
253 Format of result is depended on kind of field. For non-structured
254 field, this function returns string. For structured field, it
255 returns list corresponding with structure of the field.
257 Strings in the result will be converted to internal representation
260 If FIELD-NAME field is not found, this function returns nil.
263 (Usage: SEMI 1.14 MIME-View, MIME-BBDB)
266 ** Text Presentation of MIME-Entity Content
268 [Function] mime-insert-header (entity &optional invisible-fields
270 Insert before point a decoded header of ENTITY.
272 INVISIBLE-FIELDS is list of regexps to match field-name to hide.
273 VISIBLE-FIELDS is list of regexps to match field-name to hide.
275 If a field-name is matched with some elements of INVISIBLE-FIELDS
276 and matched with none of VISIBLE-FIELDS, this function don't insert
279 Each encoded-word in the header is decoded. ``Raw non us-ascii
280 characters'' are also decoded as `default-mime-charset'.
285 [Function] mime-insert-text-content (entity)
286 Insert before point a contents of ENTITY as text entity.
288 Contents of the ENTITY are decoded as MIME charset. If the ENTITY
289 does not have charset parameter of Content-Type field,
290 `default-mime-charset' is used as default value.
295 [Variable] default-mime-charset
296 Symbol to indicate default value of MIME charset.
298 It is used when MIME charset is not specified.
300 It is originally variable of APEL.
305 ** Bytes Representation of MIME-Entity Content
307 [Function] mime-entity-content (entity)
308 Return content of ENTITY as byte sequence (string).
311 (Usage: SEMI 1.14 MIME-View, Postpet)
314 [Function] mime-insert-entity-content (entity)
315 Insert content of ENTITY (byte sequence) at point.
320 [Function] mime-write-entity-content (entity filename)
321 Write content of ENTITY (byte sequence) into FILENAME.
326 ** Network Representation of MIME-Entity
328 [Function] mime-entity-string (entity)
329 Return header and body of ENTITY (string).
331 [Optional]<Not Suggest>
334 [Function] mime-insert-entity (entity)
335 Insert header and body of ENTITY at point.
340 [Function] mime-write-entity (entity filename)
341 Write header and body of ENTITY into FILENAME.
346 [Function] mime-entity-header (entity)
347 Return network representation of ENTITY header (string).
349 [Optional]<Not Suggest>
352 [Function] mime-insert-entity-header (entity)
353 Insert network representation of ENTITY header at point.
355 [Optional]<Not Suggest>
358 [Function] mime-write-entity-header (entity filename)
359 Write network representation of ENTITY header FILENAME.
361 [Optional]<Not Suggest>
364 [Function] mime-entity-body (entity)
365 Return network representation of ENTITY body (string).
367 [Optional]<Not Suggest>
370 [Function] mime-insert-entity-body (entity)
371 Insert network representation of ENTITY body at point.
376 [Function] mime-write-entity-body (entity filename)
377 Write body of ENTITY into FILENAME.
382 * MIME content information
391 [Function] mime-parse-Content-Type (string)
392 Parse STRING as field-body of Content-Type field, and
393 return the result as `mime-content-type' structure.
398 [Function] mime-read-Content-Type ()
399 Read field-body of Content-Type field from current-buffer,
400 and return the parsed result.
402 Format of return value is as same as `mime-parse-Content-Type'.
404 Return `nil' if Content-Type field is not found.
409 [Inline function] mime-content-type-primary-type (content-type)
410 Return primary-type of CONTENT-TYPE.
415 [Inline function] mime-content-type-subtype (content-type)
416 Return subtype of CONTENT-TYPE.
421 [Inline function] mime-content-type-parameter (content-type parameter)
422 Return PARAMETER value of CONTENT-TYPE.
427 [Inline function] mime-content-type-parameters (content-type)
428 Return parameters of CONTENT-TYPE.
433 [Inline function] mime-type/subtype-string (type &optional subtype)
434 Return type/subtype string from TYPE and SUBTYPE.
439 ** Content-Disposition
441 [Function] mime-parse-Content-Disposition (string)
442 Parse STRING as field-body of Content-Disposition field.
447 [Function] mime-read-Content-Disposition ()
448 Read field-body of Content-Disposition field from current-buffer,
449 and return parsed it.
454 [Inline function] mime-content-disposition-type (content-disposition)
455 Return disposition-type of CONTENT-DISPOSITION.
460 [Inline function] mime-content-disposition-parameter
461 (content-disposition parameter)
462 Return PARAMETER value of CONTENT-DISPOSITION.
467 [Inline function] mime-content-disposition-filename (content-disposition)
468 Return filename of CONTENT-DISPOSITION.
473 [Inline function] mime-content-disposition-parameters (content-disposition)
474 Return disposition-parameters of CONTENT-DISPOSITION.
488 [Function] mime-decode-header-in-buffer (&optional code-conversion separator)
489 Decode MIME encoded-words in header fields.
491 If CODE-CONVERSION is nil, it decodes only encoded-words. If it is
492 mime-charset, it decodes non-ASCII bit patterns as the mime-charset.
493 Otherwise it decodes non-ASCII bit patterns as the
494 default-mime-charset.
496 If SEPARATOR is not nil, it is used as header separator.
501 [Function] mime-decode-header-in-region (start end
502 &optional code-conversion)
503 Decode MIME encoded-words in region between START and END.
505 If CODE-CONVERSION is nil, it decodes only encoded-words. If it is
506 mime-charset, it decodes non-ASCII bit patterns as the mime-charset.
507 Otherwise it decodes non-ASCII bit patterns as the
508 default-mime-charset.
513 [Function] mime-decode-field-body (field-body field-name
514 &optional mode max-column)
515 Decode FIELD-BODY as FIELD-NAME in MODE, and return the result.
517 Optional argument MODE must be `plain', `wide', `summary' or `nov'.
518 Default mode is `summary'.
520 If MODE is `wide' and MAX-COLUMN is non-nil, the result is folded
523 Non MIME encoded-word part in FILED-BODY is decoded with
524 `default-mime-charset'.
529 [Function] mime-set-field-decoder (field &rest specs)
530 Set decoder of FIELD.
532 SPECS must be like `MODE1 DECODER1 MODE2 DECODER2 ...'.
534 Each mode must be `nil', `plain', `wide', `summary' or `nov'. If
535 mode is `nil', corresponding decoder is set up for every modes.
540 [Macro] mime-find-field-presentation-method (name)
541 Return field-presentation-method from NAME.
543 NAME must be `plain', `wide', `summary' or `nov'.
548 [Function] mime-find-field-decoder (field &optional mode)
549 Return function to decode field-body of FIELD in MODE.
551 Optional argument MODE must be object or name of
552 field-presentation-method. Name of field-presentation-method must
553 be `plain', `wide', `summary' or `nov'. Default value of MODE is
559 [Function] mime-update-field-decoder-cache (field mode &optional function)
560 Update field decoder cache `mime-field-decoder-cache'.
567 [Function] mime-encode-header-in-buffer (&optional code-conversion)
568 Encode header fields to network representation, such as MIME
571 It refer variable `mime-field-encoding-method-alist'.
576 [Function] mime-encode-field-body (field-body field-name)
577 Encode FIELD-BODY as FIELD-NAME, and return the result.
579 A lexical token includes non-ASCII character is encoded as MIME
580 encoded-word. ASCII token is not encoded.
585 * Content-Transfer-Encoding
594 [Variable] mime-encoding-list
595 List of Content-Transfer-Encoding. Each encoding must be string.
600 [Function] mime-encoding-list (&optional service)
601 Return list of Content-Transfer-Encoding.
603 If SERVICE is specified, it returns available list of
604 Content-Transfer-Encoding for it.
609 [Function] mime-encoding-alist (&optional service)
610 Return table of Content-Transfer-Encoding for completion.
617 [Function] mime-decode-string (string encoding)
618 Decode STRING using ENCODING.
620 ENCODING must be string. If ENCODING is found in
621 `mime-encoding-list', this function decodes the STRING by its value.
626 [Function] mime-decode-region (start end encoding)
627 Decode region START to END of current buffer using ENCODING.
629 ENCODING must be string.
631 [Suggest]<Not Suggest>
634 [Function] mime-write-decoded-region (start end filename encoding)
635 Decode and write current region encoded by ENCODING into FILENAME.
637 START and END are buffer positions.
644 [Function] mime-encode-string (string encoding)
645 Encode STRING using ENCODING.
647 ENCODING must be string.
649 [Optional]<Not Suggest>
652 [Function] mime-encode-region (start end encoding)
653 Encode region START to END of current buffer using ENCODING.
655 ENCODING must be string.
657 [Suggest]<Not Suggest>
660 [Function] mime-insert-encoded-file (filename encoding)
661 Insert file FILENAME encoded by ENCODING format.
668 [Function] encoded-text-decode-string (string encoding)
669 Decode STRING as encoded-text using ENCODING.
671 ENCODING must be string.
676 [Function] encoded-text-encode-string (string encoding &optional mode)
677 Encode STRING as encoded-text using ENCODING.
679 ENCODING must be string.
681 MODE allows `text', `comment', `phrase' or nil. Default value is
687 [Function] base64-encoded-length (string)
688 Return length of B-encoded STRING.
693 [Function] Q-encoded-text-length (string &optional mode)
694 Return length of Q-encoded STRING.
696 MODE allows `text', `comment', `phrase' or nil. Default value is
711 [Function] mime-parse-mailcap-buffer (&optional buffer order)
712 Parse BUFFER as a mailcap, and return the result.
714 If optional argument ORDER is a function, result is sorted by it.
715 If optional argument ORDER is not specified, result is sorted
716 original order. Otherwise result is not sorted.
721 [Variable] mime-mailcap-file
722 File name of user's mailcap file.
724 [Required]<Suggest> (default value may be "~/.mailcap")
727 [Function] mime-parse-mailcap-file (&optional filename order)
728 Parse FILENAME as a mailcap, and return the result.
730 If optional argument ORDER is a function, result is sorted by it.
731 If optional argument ORDER is not specified, result is sorted
732 original order. Otherwise result is not sorted.
739 [Function] mime-format-mailcap-command (mtext situation)
740 Return formated command string from MTEXT and SITUATION.
742 MTEXT is a command text of mailcap specification, such as
745 SITUATION is an association-list about information of entity. Its
748 'type primary media-type
749 'subtype media-subtype
751 STRING parameter of Content-Type field
765 [Variable] mime-field-parser-alist
766 Alist to specify field parser.
769 [Function] mime-parse-Content-Type (string)
770 Parse STRING as field-body of Content-Type field.
773 (PRIMARY-TYPE SUBTYPE (NAME1 . VALUE1)(NAME2 . VALUE2) ...)
774 or nil. PRIMARY-TYPE and SUBTYPE are symbol and NAME_n and VALUE_n
778 [Function] mime-read-Content-Type ()
779 Read field-body of Content-Type field from current-buffer,
780 and return parsed it. Format of return value is as same as
781 `mime-parse-Content-Type'.
784 [Function] mime-parse-Content-Disposition (string)
785 Parse STRING as field-body of Content-Disposition field.
788 [Function] mime-read-Content-Disposition ()
789 Read field-body of Content-Disposition field from current-buffer,
790 and return parsed it.
793 [Function] mime-parse-Content-Transfer-Encoding (string)
794 Parse STRING as field-body of Content-Transfer-Encoding field.
797 [Function] mime-read-Content-Transfer-Encoding (&optional default-encoding)
798 Read field-body of Content-Transfer-Encoding field from
799 current-buffer, and return it.
801 If is is not found, return DEFAULT-ENCODING.
804 [Function] mime-parse-msg-id (tokens)
805 Parse TOKENS as msg-id of Content-Id or Message-Id field.
808 [Function] mime-uri-parse-cid (string)
809 Parse STRING as cid URI.
821 [Function] std11-fetch-field (name)
822 Return the value of the header field NAME.
824 The buffer is expected to be narrowed to just the headers of the message.
827 [Function] std11-narrow-to-header (&optional boundary)
828 Narrow to the message header.
830 If BOUNDARY is not nil, it is used as message header separator.
833 [Function] std11-field-body (name &optional boundary)
834 Return the value of the header field NAME.
836 If BOUNDARY is not nil, it is used as message header separator.
839 [Function] std11-unfold-string (string)
840 Unfold STRING as message header field.
845 [Function] std11-lexical-analyze (string &optional analyzer start)
846 Analyze STRING as lexical tokens of STD 11.
849 [Function] std11-address-string (address)
850 Return string of address part from parsed ADDRESS of RFC 822.
853 [Function] std11-full-name-string (address)
854 Return string of full-name part from parsed ADDRESS of RFC 822.
857 [Function] std11-msg-id-string (msg-id)
858 Return string from parsed MSG-ID of RFC 822.
861 [Function] std11-fill-msg-id-list-string (string &optional column)
862 Fill list of msg-id in STRING, and return the result.
865 [Function] std11-parse-address-string (string)
866 Parse STRING as mail address.
869 [Function] std11-parse-addresses-string (string)
870 Parse STRING as mail address list.
873 [Function] std11-parse-msg-id-string (string)
874 Parse STRING as msg-id.
877 [Function] std11-parse-msg-ids-string (string)
878 Parse STRING as `*(phrase / msg-id)'.
881 [Function] std11-extract-address-components (string)
882 Extract full name and canonical address from STRING.
884 Returns a list of the form (FULL-NAME CANONICAL-ADDRESS). If no
885 name can be extracted, FULL-NAME will be nil.
897 [Function] smtp-send-buffer (sender recipients buffer)
898 (This description will be written by Daiki Ueno <ueno@unixuser.org>)
910 [Function] qmtp-send-buffer (sender recipients buffer)
911 (This description will be written by Daiki Ueno <ueno@unixuser.org>)