(qmtp-open-connection-function): Revert initial value to
[elisp/flim.git] / FLIM-API.en
index 3222cdd..2334d62 100644 (file)
@@ -59,6 +59,7 @@ ULEVEL specifies implementation level:
   representation-type.
 
   [Required]<Suggest>
+  (Usage: SEMI 1.14 MIME-View)
 
 
 [Function] mime-parse-buffer (&optional buffer representation-type)
@@ -75,6 +76,7 @@ ULEVEL specifies implementation level:
   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)
@@ -83,6 +85,7 @@ ULEVEL specifies implementation level:
   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)
@@ -103,12 +106,14 @@ ULEVEL specifies implementation level:
   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
@@ -139,6 +144,35 @@ ULEVEL specifies implementation level:
   (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)
@@ -147,6 +181,7 @@ ULEVEL specifies implementation level:
   (cf. <** Content-Type>)
 
   [Suggest]
+  (Usage: SEMI 1.14 MIME-View)
 
 
 [Function] mime-entity-content-disposition (entity)
@@ -155,12 +190,14 @@ ULEVEL specifies implementation level:
   (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)
@@ -171,12 +208,14 @@ ULEVEL specifies implementation level:
   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)
@@ -184,12 +223,14 @@ ULEVEL specifies implementation level:
   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
@@ -203,6 +244,7 @@ ULEVEL specifies implementation level:
   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)
@@ -218,6 +260,7 @@ ULEVEL specifies implementation level:
   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
@@ -265,6 +308,7 @@ ULEVEL specifies implementation level:
   Return content of ENTITY as byte sequence (string).
 
   [Required]
+  (Usage: SEMI 1.14 MIME-View, Postpet)
 
 
 [Function] mime-insert-entity-content (entity)
@@ -441,7 +485,8 @@ and return parsed it.
 
 ** 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
@@ -454,6 +499,19 @@ and return parsed it.
   [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.
@@ -568,7 +626,7 @@ and return parsed it.
   [Suggest]
 
 
-** Decoder
+** String
 
 [Function] mime-decode-string (string encoding)
   Decode STRING using ENCODING.
@@ -579,15 +637,32 @@ and return parsed it.
   [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.
@@ -595,17 +670,94 @@ and return parsed it.
   [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.
@@ -613,10 +765,26 @@ and return parsed it.
   [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
@@ -851,17 +1019,15 @@ If BOUNDARY is not nil, it is used as message header separator.
 ** Features
 
 [Function] smtp-send-buffer (sender recipients buffer)
-  (This description will be written by Daiki Ueno <ueno@unixuser.org>)
+  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]
 
-** Features
+[Function] smtp-via-smtp (sender recipients buffer)
+  Like `smtp-send-buffer', but sucks in any errors.
 
-[Function] qmtp-send-buffer (sender recipients buffer)
-  (This description will be written by Daiki Ueno <ueno@unixuser.org>)
+  [Optional]<Not Suggest>