To contents Next section

14.11.2.1 Public fields

VARIABLE
MIME.Message.body_parts - Multipart sub-messages

SYNTAX
array(object) msg->body_parts;

DESCRIPTION
If the message is of type multipart, this is an array containing one Message object for each part of the message. If the message is not a multipart, this field is 0.

SEE ALSO
MIME.Message->type and MIME.Message->boundary

VARIABLE
MIME.Message.boundary - Boundary string for multipart messages

SYNTAX
string msg->boundary;

DESCRIPTION
For multipart messages, this Content-Type parameter gives a delimiter string for separating the individual messages. As multiparts are handled internally by the module, you should not need to access this field.

SEE ALSO
MIME.Message->setboundary

VARIABLE
MIME.Message.charset - Character encoding for text bodies

SYNTAX
string msg->charset;

DESCRIPTION
One of the possible parameters of the Content-Type header is the charset attribute. It determines the character encoding used in bodies of type text. If there is no Content-Type header, the value of this field is "us-ascii".

SEE ALSO
MIME.Message->type

VARIABLE
MIME.Message.disposition - Multipart subpart disposition

SYNTAX
string msg->disposition;

DESCRIPTION
The first part of the Content-Disposition header, hinting on how this part of a multipart message should be presented in an interactive application. If there is no Content-Disposition header, this field is 0.

VARIABLE
MIME.Message.disp_params - Content-Disposition parameters

SYNTAX
mapping(string:string) msg->disp_params;

DESCRIPTION
A mapping containing all the additional parameters to the Content-Disposition header.

SEE ALSO
MIME.Message->setdisp_param and MIME.Message->get_filename

VARIABLE
MIME.Message.headers - All header fields of the message

SYNTAX
mapping(string:string) msg->headers;

DESCRIPTION
This mapping contains all the headers of the message. The key is the header name (in lower case) and the value is the header value. Although the mapping contains all headers, some particular headers get special treatment by the module and should not be accessed through this mapping. These fields are currently: The contents of these fields can be accessed and/or modified through a set of variables and methods available for this purpose.

SEE ALSO
MIME.Message->type, MIME.Message->subtype, MIME.Message->charset, MIME.Message->boundary, MIME.Message->transfer_encoding, MIME.Message->params, MIME.Message->disposition, MIME.Message->disp_params, MIME.Message->setencoding, MIME.Message->setparam, MIME.Message->setdisp_param, MIME.Message->setcharset and MIME.Message->setboundary

VARIABLE
MIME.Message.params - Content-Type parameters

SYNTAX
mapping(string:string) msg->params;

DESCRIPTION
A mapping containing all the additional parameters to the Content-Type header. Some of these parameters have fields of their own, which should be accessed instead of this mapping wherever applicable.

SEE ALSO
MIME.Message->charset, MIME.Message->boundary and MIME.Message->setparam

VARIABLE
MIME.Message.subtype - The subtype attribute of the Content-Type header

SYNTAX
string msg->subtype;

DESCRIPTION
The Content-Type header contains a type, a subtype, and optionally some parameters. This field contains the subtype attribute extracted from the header. If there is no Content-Type header, the value of this field is "plain".

SEE ALSO
MIME.Message->type and MIME.Message->params

VARIABLE
MIME.Message.transfer_encoding - Body encoding method

SYNTAX
string msg->transfer_encoding;

DESCRIPTION
The contents of the Content-Transfer-Encoding header. If no Content-Transfer-Encoding header is given, this field is 0. Transfer encoding and decoding is done transparently by the module, so this field should be interesting only to applications wishing to do auto conversion of certain transfer encodings.

SEE ALSO
MIME.Message->setencoding

VARIABLE
MIME.Message.type - The type attribute of the Content-Type header

SYNTAX
string msg->type;

DESCRIPTION
The Content-Type header contains a type, a subtype, and optionally some parameters. This field contains the type attribute extracted from the header. If there is no Content-Type header, the value of this field is "text".

SEE ALSO
MIME.Message->subtype and MIME.Message->params
To contents Next section