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.

Mail_Mime::get() has to be called before Mail_Mime::headers().

Mail_Mime::addHTMLImage() (Previous) Mail_Mime::headers() (Next)
Last updated: Tue, 02 Jun 2009 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

Note by: justinasu@gmail.com
I noticed that get method does not encode the built message in the specified encoding.

if you set transfer encoding and html encoding the returned body is unencoded in say 7bit encoding.
Note by: kguest
this must be called before the headers() method