Wanderlust

https://wanderlust.github.io/wl-docs/
Admin
Wanderlust is an email and news management system for GNU Emacs supporting IMAP4rev1, NNTP, POP, and...
Tokens:19,759
Snippets:184
Trust Score:9.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Content-Type Header Examples

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Examples of Content-Type header formats including media types and parameters.

```text
Content-Type: image/jpeg
```

```text
Content-Type: text/plain; charset=iso-2022-jp
```

--------------------------------

### entity-button display example

Source: https://wanderlust.github.io/wl-docs/mime-ui-en.html

The standard appearance of an entity-button in the buffer.

```text
        [1.3 test (text/plain)]
```

--------------------------------

### image entity-button example

Source: https://wanderlust.github.io/wl-docs/mime-ui-en.html

An example of an entity-button representing an image, which can be triggered to display the content.

```text
        [2  (image/gif)]
```

--------------------------------

### mime-entity-point-min

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Returns the start point of the entity in the buffer that contains it.

```APIDOC
## mime-entity-point-min

### Description
Returns the start point of the entity in the buffer that contains it.

### Function Signature
mime-entity-point-min entity

### Parameters
- **entity** (entity) - Required - The MIME entity.

### Return Value
- The start point of the entity.
```

--------------------------------

### mime-entity-body-start

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Returns the start point of the body of the entity in the buffer that contains it.

```APIDOC
## mime-entity-body-start

### Description
Returns the start point of the body of the entity in the buffer that contains it.

### Function Signature
mime-entity-body-start entity

### Parameters
- **entity** (entity) - Required - The MIME entity.

### Return Value
- The start point of the body.
```

--------------------------------

### mime-entity-header-start

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Returns the start point of the header of the entity in the buffer that contains it.

```APIDOC
## mime-entity-header-start

### Description
Returns the start point of the header of the entity in the buffer that contains it.

### Function Signature
mime-entity-header-start entity

### Parameters
- **entity** (entity) - Required - The MIME entity.

### Return Value
- The start point of the header.
```

--------------------------------

### Define a service with mel-define-service

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Example of defining a generic function as a service for Content-Transfer-Encodings using mel-define-service.

```elisp
(mel-define-service encoded-text-encode-string (string encoding)
  "Encode STRING as encoded-text using ENCODING.
ENCODING must be string.")
```

--------------------------------

### Define a method with mel-define-method

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Example of defining a method function for a specific backend using mel-define-method.

```elisp
(mel-define-method mime-write-decoded-region (start end filename
				    (nil "base64"))
  "Decode and write current region encoded by base64 into FILENAME.
START and END are buffer positions."
  (interactive
   (list (region-beginning) (region-end)
	 (read-file-name "Write decoded region to file: ")))
  (let ((str (buffer-substring start end)))
    (with-temp-buffer
      (insert (decode-base64-string str))
      (write-region-as-binary (point-min) (point-max) filename)
      )))
```

--------------------------------

### Set function definition with mel-define-method-function

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Example of setting a function definition for a specific service and backend using mel-define-method-function.

```elisp
(mel-define-method-function (mime-encode-string string (nil "base64"))
			    'encode-base64-string)
```

--------------------------------

### Set default media type for .rtf files

Source: https://wanderlust.github.io/wl-docs/mime-ui-en.html

Example configuration to set application/rtf as the default media type for files ending in .rtf using set-alist.

```elisp
(eval-after-load
    "mime-edit"
  '(set-alist 'mime-file-types
	      "\\.rtf$"
	      '("application" "rtf" nil nil
		"attachment" (("filename" . file)))
	      ))
```

--------------------------------

### Multi-part beginning tag format

Source: https://wanderlust.github.io/wl-docs/mime-ui-en.html

The format for the beginning tag of a multi-part enclosure.

```text
        --<<TYPE>>-{
```

--------------------------------

### MIME-Edit mode keybindings

Source: https://wanderlust.github.io/wl-docs/mime-ui-en.html

A list of keyboard shortcuts for composing MIME messages in MIME-Edit mode.

```text
From: morioka@jaist.ac.jp (MORIOKA Tomohiko)
Subject: Re: question?
Newsgroups: zxr.message.mime
Date: 22 Oct 93 11:02:44
Mime-Version: 1.0
Organization: Japan Advanced Institute of Science and Technology,
        Ishikawa, Japan

[1  (text/plain)]
  How to compose MIME message in MIME-Edit mode.

  C-c C-x ? shows its help.

C-c C-x C-t	insert a text message.
C-c C-x TAB	insert a (binary) file.
C-c C-x C-e	insert a reference to external body.
C-c C-x C-v	insert a voice message.
C-c C-x C-y	insert a mail or news message.
C-c C-x RET	insert a mail message.
C-c C-x C-s	insert a signature file at end.
C-c C-x t	insert a new MIME tag.
C-c C-m C-a	enclose as multipart/alternative.
C-c C-m C-p	enclose as multipart/parallel.
C-c C-m C-m	enclose as multipart/mixed.
C-c C-m C-d	enclose as multipart/digest.
C-c C-m C-s	enclose as PGP signed.
C-c C-m C-e	enclose as PGP encrypted.
C-c C-x C-k	insert PGP public key.
C-c C-x p	preview editing MIME message.
...

therefore, you should type C-c C-x C-i and specify the binary file
which you want to insert.

  You should select Base64 as MIME encoding for binary file.

[2  (image/gif)]

[3  (text/plain)]

  Like above, you can compose the message with image.

==================== Take A Cup Of Russian Tea  ======================
=========  ** Not With Jam Nor Marmalade But With Honey **  ==========
=========                 MORIOKA TOMOHIKO                  ==========
==============  Internet E-mail: <morioka@jaist.ac.jp>  ==============
```

--------------------------------

### Define a mm-backend with mm-define-backend

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Defines a new backend type, optionally inheriting from parent representation-types.

```lisp
(mm-define-backend chao (generic))
```

--------------------------------

### Define a method for a backend with mm-define-method

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Defines a method function for a specific backend, where the specialized parameter in the argument list identifies the backend.

```lisp
(mm-define-method entity-cooked-p ((entity chao)) nil)
```

--------------------------------

### mm-define-backend

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Defines a new mm-backend with a given representation-type. Optionally inherits from parent representation-types.

```APIDOC
## mm-define-backend

### Description
Define type as a mm-backend. If PARENTS is specified, type inherits parents.

### Macro Signature
mm-define-backend type &optional parents

### Parameters
- **type** - The representation-type to define as a backend.
- **parents** (optional) - List of parent representation-types to inherit from.

### Example
(mm-define-backend chao (generic))
```

--------------------------------

### make-mime-content-type

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Constructor for mime-content-type structure. Creates a new content-type object with the given type, subtype, and optional parameters.

```APIDOC
## Function: make-mime-content-type

### Description
Constructor for mime-content-type structure. Creates a new content-type object with the given type, subtype, and optional parameters.

### Signature
make-mime-content-type type subtype &optional parameters

### Parameters
- **type** (symbol) - Required - Primary type of media-type.
- **subtype** (symbol) - Required - Subtype of media-type.
- **parameters** (association-list) - Optional - Parameters of Content-Type field.

### Returns
A mime-content-type structure.
```

--------------------------------

### mime-entity-content

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Returns the content of the entity as a byte sequence.

```APIDOC
## mime-entity-content

### Description
Returns the content of the entity as a byte sequence.

### Function Signature
mime-entity-content entity

### Parameters
- **entity** (entity) - Required - The MIME entity whose content is to be returned.

### Return Value
- Byte sequence of the entity content.
```

--------------------------------

### mime-encoding-alist

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Returns a table of Content-Transfer-Encoding for completion, optionally filtered by service.

```APIDOC
## mime-encoding-alist

### Description
Return table of Content-Transfer-Encoding for completion. If service is specified, it returns available list of Content-Transfer-Encoding for it.

### Function
mime-encoding-alist &optional SERVICE

### Parameters
- SERVICE (optional) - Optional - Service to filter encodings.

### Returns
Table (alist) of Content-Transfer-Encoding.
```

--------------------------------

### mime-preview-buffer entity layout

Source: https://wanderlust.github.io/wl-docs/mime-ui-en.html

The visual structure of an entity within the mime-preview-buffer.

```text
	[entity-button]
	(header)
	
	(body)
	(separator)
```

--------------------------------

### Load MIME features

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Evaluate this expression to enable the MIME features provided by the FLIM library.

```elisp
(require 'mime)
```

--------------------------------

### MIME Message Tree Structure Diagram

Source: https://wanderlust.github.io/wl-docs/mime-en.html

A visual representation of the MIME message tree hierarchy using entity numbers.

```text

                              +-------+
                              |  nil  |
                              +---+---+
              +-------------------+-------------------+
            +-+-+               +-+-+               +-+-+
            | 0 |               | 1 |               | 2 |
            +-+-+               +-+-+               +-+-+
              |         +---------+---------+         |
           +--+--+   +--+--+   +--+--+   +--+--+   +--+--+
           | 0.0 |   | 1.0 |   | 1.1 |   | 1.2 |   | 2.0 |
           +-----+   +-----+   +-----+   +-----+   +-----+

```

--------------------------------

### mime-encoding-list

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Returns a list of available Content-Transfer-Encoding values, optionally filtered by service.

```APIDOC
## mime-encoding-list

### Description
Return list of Content-Transfer-Encoding. If service is specified, it returns available list of Content-Transfer-Encoding for it.

### Function
mime-encoding-list &optional SERVICE

### Parameters
- SERVICE (optional) - Optional - Service to filter encodings.

### Returns
List of Content-Transfer-Encoding strings.
```

--------------------------------

### mime-open-entity

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Opens an entity and returns it. The type is the representation-type, and location is the location of the entity, which depends on the representation-type.

```APIDOC
## mime-open-entity

### Description
Open an entity and return it.

### Function Signature
mime-open-entity &optional type location

### Parameters
- **type** (representation-type) - Optional - The representation-type of the entity.
- **location** (location) - Optional - The location of the entity. Specification depends on representation-type.

### Returns
Returns the opened mime-entity.
```

--------------------------------

### mime-type/subtype-string

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Returns a type/subtype string from the given type and optional subtype.

```APIDOC
## Function: mime-type/subtype-string

### Description
Returns a type/subtype string from the given type and optional subtype.

### Signature
mime-type/subtype-string type &optional subtype

### Parameters
- **type** (symbol) - Required - The primary type.
- **subtype** (symbol) - Optional - The subtype.

### Returns
A string in the format "type/subtype".
```

--------------------------------

### mime-content-disposition-filename

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Returns the filename from a mime-content-disposition structure.

```APIDOC
## Function: mime-content-disposition-filename

### Description
Returns the filename from a mime-content-disposition structure.

### Signature
mime-content-disposition-filename content-disposition

### Parameters
- **content-disposition** (mime-content-disposition) - Required - The content-disposition structure.

### Returns
The filename string.
```

--------------------------------

### mime-entity-point-max

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Returns the end point of the entity in the buffer that contains it.

```APIDOC
## mime-entity-point-max

### Description
Returns the end point of the entity in the buffer that contains it.

### Function Signature
mime-entity-point-max entity

### Parameters
- **entity** (entity) - Required - The MIME entity.

### Return Value
- The end point of the entity.
```

--------------------------------

### mime-content-disposition-parameter

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Returns the value of a specified parameter from a mime-content-disposition structure.

```APIDOC
## Function: mime-content-disposition-parameter

### Description
Returns the value of a specified parameter from a mime-content-disposition structure.

### Signature
mime-content-disposition-parameter content-disposition parameter

### Parameters
- **content-disposition** (mime-content-disposition) - Required - The content-disposition structure.
- **parameter** (symbol) - Required - The parameter name.

### Returns
The value of the parameter.
```

--------------------------------

### mime-entity-filename

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Returns the file name of the given entity.

```APIDOC
## mime-entity-filename

### Description
Return file name of entity.

### Function Signature
mime-entity-filename entity

### Parameters
- **entity** - The entity whose file name is to be returned.

### Return Value
The file name of the entity.
```

--------------------------------

### mime-entity-buffer

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Returns the buffer that contains the entity.

```APIDOC
## mime-entity-buffer

### Description
Returns the buffer that contains the entity.

### Function Signature
mime-entity-buffer entity

### Parameters
- **entity** (entity) - Required - The MIME entity.

### Return Value
- The buffer containing the entity.
```

--------------------------------

### mime-add-condition

Source: https://wanderlust.github.io/wl-docs/mime-ui-en.html

Adds a condition to the database specified by target-type. The target-type must be 'preview' or 'action'. Optional arguments control strictness and default rules, and a file can be loaded when the condition is activated.

```APIDOC
## Function: mime-add-condition

### Description
Adds a condition to the database specified by target-type. The target-type must be 'preview' or 'action'. Optional arguments control strictness and default rules, and a file can be loaded when the condition is activated.

### Signature
mime-add-condition target-type condition &optional mode file

### Parameters
- **target-type** (string) - Required - Must be 'preview' or 'action'.
- **condition** (any) - Required - The condition to add.
- **mode** (string) - Optional - If 'strict' or nil (omitted), condition is added strictly. If 'with-default', condition is added with default rule.
- **file** (string) - Optional - If specified, it is loaded when condition is activated.
```

--------------------------------

### mel-define-service

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Defines a service for Content-Transfer-Encodings, optionally as a generic function.

```APIDOC
## mel-define-service

### Description
Define name as a service for Content-Transfer-Encodings. If args is specified, name is defined as a generic function for the service.

### Macro
mel-define-service name &optional args doc-string

### Parameters
- name (symbol) - Required - Name of the service.
- args (list) - Optional - Argument list for generic function.
- doc-string (string) - Optional - Documentation string.

### Example
(mel-define-service encoded-text-encode-string (string encoding)
  "Encode STRING as encoded-text using ENCODING.
ENCODING must be string.")
```

--------------------------------

### default-mime-charset

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Variable that holds the default MIME charset symbol used when no charset is specified. Originally from APEL.

```APIDOC
## default-mime-charset

### Description
Symbol indicating the default MIME charset. Used when the MIME charset is not specified. Originally a variable of APEL.

### Type
Variable
```

--------------------------------

### mime-decode-string

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Decodes a string that is encoded in the specified encoding and returns the result.

```APIDOC
## mime-decode-string

### Description
Decode string which is encoded in encoding, and return the result.

### Function
mime-decode-string string encoding

### Parameters
- string (string) - Required - The string to decode.
- encoding (string) - Required - The encoding used.

### Returns
The decoded string.
```

--------------------------------

### mime-insert-entity-content

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Inserts the content of the entity at the current point.

```APIDOC
## mime-insert-entity-content

### Description
Inserts the content of the entity at the current point.

### Function Signature
mime-insert-entity-content entity

### Parameters
- **entity** (entity) - Required - The MIME entity whose content is to be inserted.
```

--------------------------------

### mm-define-method

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Defines a method function for a specific backend. The method is associated with the backend specified in the specialized parameter.

```APIDOC
## mm-define-method

### Description
Define name as a method function of (nth 1 (car args)) backend.

### Macro Signature
mm-define-method name args &rest body

### Parameters
- **name** - The name of the method function.
- **args** - Argument list like lambda, but (car args) must be a specialized parameter. (car (car args)) is variable name, (nth 1 (car args)) is backend name.
- **body** - The body of the method.

### Example
(mm-define-method entity-cooked-p ((entity chao)) nil)
```

--------------------------------

### mime-write-entity-content

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Writes the content of the entity to a specified filename.

```APIDOC
## mime-write-entity-content

### Description
Writes the content of the entity to the specified filename.

### Function Signature
mime-write-entity-content entity filename

### Parameters
- **entity** (entity) - Required - The MIME entity whose content is to be written.
- **filename** (string) - Required - The path of the file to write to.
```

--------------------------------

### mime-entity-content-disposition

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Returns the content-disposition of the given entity.

```APIDOC
## mime-entity-content-disposition

### Description
Return content-disposition of entity. (cf. mime-content-disposition structure)

### Function Signature
mime-entity-content-disposition entity

### Parameters
- **entity** - The entity whose content-disposition is to be returned.

### Return Value
The content-disposition of the entity.
```

--------------------------------

### Define mime-file-types structure

Source: https://wanderlust.github.io/wl-docs/mime-ui-en.html

The structure of the list used to define default MIME tag values for inserted files.

```elisp
(FILE_PAT TYPE SUBTYPE PARAMS ENCODING
 DISPOSITION_TYPE DISPOSITION_PARAMS)
```

--------------------------------

### mime-content-type-parameter

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Returns the value of a specified parameter from a mime-content-type structure.

```APIDOC
## Function: mime-content-type-parameter

### Description
Returns the value of a specified parameter from a mime-content-type structure.

### Signature
mime-content-type-parameter content-type parameter

### Parameters
- **content-type** (mime-content-type) - Required - The content-type structure.
- **parameter** (symbol) - Required - The parameter name.

### Returns
The value of the parameter.
```

--------------------------------

### mime-entity-header-end

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Returns the end point of the header of the entity in the buffer that contains it.

```APIDOC
## mime-entity-header-end

### Description
Returns the end point of the header of the entity in the buffer that contains it.

### Function Signature
mime-entity-header-end entity

### Parameters
- **entity** (entity) - Required - The MIME entity.

### Return Value
- The end point of the header.
```

--------------------------------

### mime-insert-text-content

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Inserts the contents of the entity as a text entity before the point, decoding the content according to the MIME charset. If no charset is specified, `default-mime-charset` is used.

```APIDOC
## mime-insert-text-content

### Description
Inserts the contents of the entity as a text entity before the point. The content is decoded using the MIME charset specified in the Content-Type field, or `default-mime-charset` if not specified.

### Function Signature
mime-insert-text-content entity

### Parameters
- **entity** (entity) - Required - The MIME entity whose text content is to be inserted.
```

--------------------------------

### mime-entity-body-end

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Returns the end point of the body of the entity in the buffer that contains it.

```APIDOC
## mime-entity-body-end

### Description
Returns the end point of the body of the entity in the buffer that contains it.

### Function Signature
mime-entity-body-end entity

### Parameters
- **entity** (entity) - Required - The MIME entity.

### Return Value
- The end point of the body.
```

--------------------------------

### mime-field-encoding-method-alist

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Association list to specify field encoding method. Each element looks like (FIELD . METHOD). The METHOD determines how the field is encoded.

```APIDOC
## mime-field-encoding-method-alist

### Description
Association list to specify field encoding method. Each element looks like (FIELD . METHOD). If METHOD is mime, the FIELD will be encoded into MIME format (encoded-word). If METHOD is nil, the FIELD will not be encoded. If METHOD is a MIME charset, the FIELD will be encoded as that charset when it must be converted into network-code. Otherwise, the FIELD will be encoded as the variable default-mime-charset when it must be converted into network-code.

### Variable Type
Association list

### Elements
- **FIELD** - The header field name.
- **METHOD** - The encoding method: mime, nil, a MIME charset, or other (defaults to default-mime-charset).
```

--------------------------------

### mime-insert-entity

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Inserts the header and body of the entity at the current point.

```APIDOC
## mime-insert-entity

### Description
Inserts the header and body of the entity at the current point.

### Function Signature
mime-insert-entity entity

### Parameters
- **entity** (entity) - Required - The MIME entity to insert.
```

--------------------------------

### mime-parse-Content-Transfer-Encoding

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Parses a string as a field-body of Content-Transfer-Encoding field and returns the result.

```APIDOC
## mime-parse-Content-Transfer-Encoding

### Description
Parse string as a field-body of Content-Transfer-Encoding field, and return the result.

### Function
mime-parse-Content-Transfer-Encoding string

### Parameters
- string (string) - Required - The string to parse.

### Returns
The parsed result.
```

--------------------------------

### mime-read-Content-Disposition

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Parses the Content-Disposition field of the current buffer and returns a mime-content-disposition structure, or nil if not found.

```APIDOC
## mime-read-Content-Disposition

### Description
Parse Content-Disposition field of the current buffer, and return the result as mime-content-disposition structure. Return nil if Content-Disposition field is not found.

### Function
mime-read-Content-Disposition

### Parameters
None.

### Returns
- mime-content-disposition structure or nil
```

--------------------------------

### Default Content-Type Header

Source: https://wanderlust.github.io/wl-docs/mime-en.html

The default Content-Type header used when an entity lacks a specified field.

```text
Content-Type: text/plain; charset=us-ascii
```

--------------------------------

### mime-write-entity

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Writes the network representation of the entity to a specified filename.

```APIDOC
## mime-write-entity

### Description
Writes the network representation of the entity to the specified filename.

### Function Signature
mime-write-entity entity filename

### Parameters
- **entity** (entity) - Required - The MIME entity to write.
- **filename** (string) - Required - The path of the file to write to.
```

--------------------------------

### mime-parse-Content-Disposition

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Parses a string as the field-body of a Content-Disposition field and returns a mime-content-disposition structure.

```APIDOC
## Function: mime-parse-Content-Disposition

### Description
Parses a string as the field-body of a Content-Disposition field and returns a mime-content-disposition structure.

### Signature
mime-parse-Content-Disposition string

### Parameters
- **string** (string) - Required - The field-body string to parse.

### Returns
A mime-content-disposition structure.
```

--------------------------------

### mime-entity-encoding

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Returns the content-transfer-encoding of the given entity. If the entity does not have a Content-Transfer-Encoding field, returns the default-encoding parameter, or '7bit' if that is nil.

```APIDOC
## mime-entity-encoding

### Description
Return content-transfer-encoding of entity. (cf. Encoding Method) 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.

### Function Signature
mime-entity-encoding entity &optional default-encoding

### Parameters
- **entity** - The entity whose encoding is to be returned.
- **default-encoding** (optional) - The default encoding to use if the entity has no Content-Transfer-Encoding field. If nil, "7bit" is used.

### Return Value
The content-transfer-encoding of the entity.
```

--------------------------------

### mime-write-entity-body

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Writes the body of the entity to a specified filename.

```APIDOC
## mime-write-entity-body

### Description
Writes the body of the entity to the specified filename.

### Function Signature
mime-write-entity-body entity filename

### Parameters
- **entity** (entity) - Required - The MIME entity whose body is to be written.
- **filename** (string) - Required - The path of the file to write to.
```

--------------------------------

### mime-entity-cooked-p

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Checks whether the contents of the given entity have already been code-converted.

```APIDOC
## mime-entity-cooked-p

### Description
Return non-nil if contents of entity has been already code-converted.

### Function Signature
mime-entity-cooked-p entity

### Parameters
- **entity** - The entity to check.

### Return Value
Non-nil if the contents have been code-converted, nil otherwise.
```

--------------------------------

### Single-part tag format

Source: https://wanderlust.github.io/wl-docs/mime-ui-en.html

The format for defining a single-part tag in mime-edit-mode.

```text
        --[[TYPE/SUBTYPE;PARAMETERS
        OPTIONAL-FIELDS][ENCODING]]
```

--------------------------------

### mime-insert-encoded-file

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Inserts a file encoded by the specified encoding into the current buffer.

```APIDOC
## mime-insert-encoded-file

### Description
Insert file FILENAME encoded by ENCODING format.

### Function
mime-insert-encoded-file filename encoding

### Parameters
- filename (string) - Required - The file to insert.
- encoding (string) - Required - The encoding format.

### Returns
None.
```

--------------------------------

### mime-read-Content-Transfer-Encoding

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Parses the Content-Transfer-Encoding field of the current buffer and returns the result, or a default encoding if not found.

```APIDOC
## mime-read-Content-Transfer-Encoding

### Description
Parse Content-Transfer-Encoding field of the current buffer, and return the result. Return default-encoding if Content-Transfer-Encoding field is not found. If it is not specified, nil is used as the default value.

### Function
mime-read-Content-Transfer-Encoding &optional default-encoding

### Parameters
- default-encoding (optional) - Optional - Default encoding to return if field not found.

### Returns
The parsed result or default-encoding.
```

--------------------------------

### mime-parse-Content-Type

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Parses a string as the field-body of a Content-Type field and returns a mime-content-type structure.

```APIDOC
## Function: mime-parse-Content-Type

### Description
Parses a string as the field-body of a Content-Type field and returns a mime-content-type structure.

### Signature
mime-parse-Content-Type string

### Parameters
- **string** (string) - Required - The field-body string to parse.

### Returns
A mime-content-type structure.
```

--------------------------------

### mel-define-method

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Defines a method function for a specific backend (encoding) using a specialized parameter.

```APIDOC
## mel-define-method

### Description
Define name as a method function of (nth 1 (car (last args))) backend. args is like an argument list of lambda, but (car (last args)) must be specialized parameter. (car (car (last args))) is name of variable and (nth 1 (car (last args))) is name of backend (encoding).

### Macro
mel-define-method name args &rest body

### Parameters
- name (symbol) - Required - Name of the method.
- args (list) - Required - Argument list with specialized parameter.
- body (rest) - Required - Body of the method.

### Example
(mel-define-method mime-write-decoded-region (start end filename (nil "base64"))
  "Decode and write current region encoded by base64 into FILENAME.
START and END are buffer positions."
  (interactive
   (list (region-beginning) (region-end)
         (read-file-name "Write decoded region to file: ")))
  (let ((str (buffer-substring start end)))
    (with-temp-buffer
      (insert (decode-base64-string str))
      (write-region-as-binary (point-min) (point-max) filename))))
```

--------------------------------

### mime-entity-content-type

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Returns the content-type of the given entity.

```APIDOC
## mime-entity-content-type

### Description
Return content-type of entity. (cf. mime-content-type structure)

### Function Signature
mime-entity-content-type entity

### Parameters
- **entity** - The entity whose content-type is to be returned.

### Return Value
The content-type of the entity.
```

--------------------------------

### Multi-part ending tag format

Source: https://wanderlust.github.io/wl-docs/mime-ui-en.html

The format for the ending tag of a multi-part enclosure.

```text
        --}-<<TYPE>>
```

--------------------------------

### mime-read-Content-Type

Source: https://wanderlust.github.io/wl-docs/mime-en.html

Parses the Content-Type field from the current buffer and returns a mime-content-type structure. Returns nil if the field is not found.

```APIDOC
## Function: mime-read-Content-Type

### Description
Parses the Content-Type field from the current buffer and returns a mime-content-type structure. Returns nil if the field is not found.

### Signature
mime-read-Content-Type

### Parameters
None.

### Returns
A mime-content-type structure, or nil if not found.
```
Tokens:
Raw