You are here

public function MailMIME::getMessage in Mail MIME 6

Same name and namespace in other branches
  1. 8.2 mailmime.inc \MailMIME::getMessage()
  2. 6.2 mailmime.inc \MailMIME::getMessage()
  3. 7.2 mailmime.inc \MailMIME::getMessage()
  4. 7 mailmime.inc \MailMIME::getMessage()

Returns the complete e-mail, ready to send.

Parameters

$separation: (optional) The string used to separate header and body parts.

$params: (optional) Build parameters for the MailMimeInterface::get() method.

$headers: (optional) The extra headers that should be passed to the MailMIME::headers() method.

$overwrite: TRUE if $headers parameter should overwrite previous data.

Return value

The complete message as a string if successful; otherwise FALSE.

File

./mailmime.inc, line 331
Provides the MailMIME class for creating MIME-formatted email messages.

Class

MailMIME
The MailMIME class is used to create MIME email messages.

Code

public function getMessage($separation = NULL, $params = NULL, $headers = NULL, $overwrite = FALSE) {
  return MailMIME::successful(parent::getMessage($separation, $params, $headers, $overwrite));
}