PEAR Manual
Prev |  | Next

# Mail_Mime::get()

Mail_Mime::get() -- build the message

## Synopsis

    require_once 'Mail/mime.php';

``string &get` (array [$param = `NULL`])`

## Description

This function should be called once you have added the text/html/images/attachments. It builds the message and returns it. It does not send it. To send what this function returns (in conjunction with the headers() -function) you would need to use the Mail::send()-function

## Parameter

- `array $param` - An associative array of parameters. These parameters affect the way the message is built.

  - `$param["text_encoding"]` - Type of encoding to use for the plain text part of the email. Default is "7bit".

  - `$param["html_encoding"]` - Type of encoding for the HTML part of the email. Default is "quoted-printable".

  - `$param["7bit_wrap"]` - Number of characters after which text is wrapped. SMTP stipulates maximum line length of 1000 characters including CRLF. Default is 998 (CRLF is appended to make up to 1000).

  - `$param["head_charset"]` - The character set to use for the headers. Default is "iso-8859-1".

  - `$param["text_charset"]` - The character set to use for the plain text part of the email. Default is "iso-8859-1".

  - `$param["html_charset"]` - The character set to use for the HTML part of the email. Default is "iso-8859-1".

## Return value

`string` - the body of the message

## Note

This function can not be called statically.

## See

Mail_Mime::headers()

Prev | Home | Next
Mail_Mime::addHTMLImage() | Up | Mail_Mime::headers()