Docs For Class Zend_Mail_Transport

Description

Abstract for sending eMails through different ways of transport

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
abstract:
license: New BSD License

Located in /Mail/Transport/Abstract.php (line 40)

Direct descendents

Class	Description
Zend_Mail_Transport_Sendmail	Class for sending eMails via the PHP internal mail() function
Zend_Mail_Transport_Smtp	SMTP connection object

Variable Summary

string $body

string $boundary

string $EOL

string $header

string $recipients

array $_headers

boolean $_isMultipart

false|Zend_Mail $_mail

array $_parts

Method Summary

static void _formatHeader ( &$item, string $key, string $prefix, string $item)

void send (Zend_Mail $mail)

void _buildBody ()

array _getHeaders (string $boundary)

void _prepareHeaders (mixed $headers)

void _sendMail ()

Variables

string $body = '' (line 47)

Mail body

access: public

string $boundary = '' (line 54)

MIME boundary

access: public

string $EOL = "\r\n" (line 103)

EOL character string used by transport

access: public

Redefined in descendants as:

Zend_Mail_Transport_Sendmail::$EOL : EOL character string
Zend_Mail_Transport_Smtp::$EOL : EOL character string used by transport

string $header = '' (line 61)

Mail header string

access: public

string $recipients = '' (line 96)

Recipients string

access: public

array $_headers = array() (line 68)

Array of message headers

access: protected

boolean $_isMultipart = false (line 75)

Message is a multipart message

access: protected

false|Zend_Mail $_mail = false (line 82)

Zend_Mail object

access: protected

array $_parts = array() (line 89)

Array of message parts

access: protected

Methods

static _formatHeader (line 165)

Prepend header name to header value

access: protected

static void _formatHeader ( &$item, string $key, string $prefix, string $item)

string $item
string $key
string $prefix
&$item

send (line 305)

Send a mail using this transport

throws: Zend_Mail_Transport_Exception if mail is empty
access: public

void send (Zend_Mail $mail)

Zend_Mail $mail

_buildBody (line 233)

Generate MIME compliant message from the current configuration

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.

access: protected

void _buildBody ()

_getHeaders (line 127)

Return all mail headers as an array

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 Zend_Mail object present.

access: protected

array _getHeaders (string $boundary)

string $boundary

_prepareHeaders (line 181)

Prepare header string for use in transport

Prepares and generates $header based on the headers provided.

throws: Zend_Mail_Transport_Exception if any header lines exceed 998 characters
access: protected

void _prepareHeaders (mixed $headers)

mixed $headers

Redefined in descendants as:

Zend_Mail_Transport_Sendmail::_prepareHeaders() : Format and fix headers
Zend_Mail_Transport_Smtp::_prepareHeaders() : Format and fix headers

_sendMail (line 115)

Send an email independent from the used transport

The requisite information for the email will be found in the following properties:

$recipients - list of recipients (string)
$header - message header
$body - message body

abstract:
access: protected

void _sendMail ()

Redefined in descendants as:

Zend_Mail_Transport_Sendmail::_sendMail() : Send mail using PHP native mail()
Zend_Mail_Transport_Smtp::_sendMail() : Send an email via the SMTP connection protocol

Zend_Mail_Transport_Abstract