Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Class for sending eMails via the PHP internal mail() function

__construct(
string|array|\Zend_Config $parameters
=
null
)
:
void
Constructor.
Name | Type | Description |
---|---|---|
$parameters | string|array|\Zend_Config | OPTIONAL (Default: null) |

_buildBody(
)
:
void
Generate MIME compliant message from the current configuration
Inherited from: \Zend_Mail_Transport_Abstract::_buildBody()If both a text and HTML body are present, generates a multipart/alternative Zend_Mime_Part containing the headers and contents of each. Otherwise, uses whichever of the text or HTML parts present.
The content part is then prepended to the list of Zend_Mime_Parts for this message.

_formatHeader(
string $item, string $key, string $prefix
)
:
void
Prepend header name to header value
Inherited from: \Zend_Mail_Transport_Abstract::_formatHeader()Name | Type | Description |
---|---|---|
$item | string | |
$key | string | |
$prefix | string |

_getHeaders(
string $boundary
)
:
array
Return all mail headers as an array
Inherited from: \Zend_Mail_Transport_Abstract::_getHeaders()If a boundary is given, a multipart header is generated with a Content-Type of either multipart/alternative or multipart/mixed depending on the mail parts present in the {@link $_mail Zend_Mail object} present.
Name | Type | Description |
---|---|---|
$boundary | string |
Type | Description |
---|---|
array |

_handleMailErrors(
int $errno, string $errstr, string $errfile
=
null, string $errline
=
null, array $errcontext
=
null
)
:
true
Temporary error handler for PHP native mail().
Name | Type | Description |
---|---|---|
$errno | int | |
$errstr | string | |
$errfile | string | |
$errline | string | |
$errcontext | array |
Type | Description |
---|---|
true |

_prepareHeaders(
array $headers
)
:
void
Format and fix headers
mail() uses its $to and $subject arguments to set the To: and Subject: headers, respectively. This method strips those out as a sanity check to prevent duplicate header entries.
Name | Type | Description |
---|---|---|
$headers | array |
Exception | Description |
---|---|
\Zend_Mail_Transport_Exception |

_sendMail(
)
:
void
Send mail using PHP native mail()
The requisite information for the email will be found in the following properties:
Exception | Description |
---|---|
\Zend_Mail_Transport_Exception | if parameters is set but not a string |
\Zend_Mail_Transport_Exception | on mail() failure |

send(
\Zend_Mail $mail
)
:
void
Send a mail using this transport
Inherited from: \Zend_Mail_Transport_Abstract::send()Name | Type | Description |
---|---|---|
\Zend_Mail |
Exception | Description |
---|---|
\Zend_Mail_Transport_Exception | if mail is empty |