Zend_Mail Class Reference

Inheritance diagram for Zend_Mail:

Public Member Functions
	__construct ($charset=null)
	getCharset ()
	setType ($type)
	getType ()
	setMimeBoundary ($boundary)
	getMimeBoundary ()
	getEncodingOfHeaders ()
	getHeaderEncoding ()
	setEncodingOfHeaders ($encoding)
	setHeaderEncoding ($encoding)
	setBodyText ($txt, $charset=null, $encoding=Zend_Mime::ENCODING_QUOTEDPRINTABLE)
	getBodyText ($textOnly=false)
	setBodyHtml ($html, $charset=null, $encoding=Zend_Mime::ENCODING_QUOTEDPRINTABLE)
	getBodyHtml ($htmlOnly=false)
	addAttachment (Zend_Mime_Part $attachment)
	createAttachment ($body, $mimeType=Zend_Mime::TYPE_OCTETSTREAM, $disposition=Zend_Mime::DISPOSITION_ATTACHMENT, $encoding=Zend_Mime::ENCODING_BASE64, $filename=null)
	getPartCount ()
	addTo ($email, $name='')
	addCc ($email, $name='')
	addBcc ($email)
	getRecipients ()
	clearHeader ($headerName)
	clearRecipients ()
	setFrom ($email, $name=null)
	setReplyTo ($email, $name=null)
	getFrom ()
	getReplyTo ()
	clearFrom ()
	clearReplyTo ()
	setFromToDefaultFrom ()
	setReplyToFromDefault ()
	setReturnPath ($email)
	getReturnPath ()
	clearReturnPath ()
	setSubject ($subject)
	getSubject ()
	clearSubject ()
	setDate ($date=null)
	getDate ()
	clearDate ()
	setMessageId ($id=true)
	getMessageId ()
	clearMessageId ()
	createMessageId ()
	addHeader ($name, $value, $append=false)
	getHeaders ()
	send ($transport=null)
Public Member Functions inherited from Zend_Mime_Message
	getParts ()
	setParts ($parts)
	addPart (Zend_Mime_Part $part)
	isMultiPart ()
	setMime (Zend_Mime $mime)
	getMime ()
	generateMessage ($EOL=Zend_Mime::LINEEND)
	getPartHeadersArray ($partnum)
	getPartHeaders ($partnum, $EOL=Zend_Mime::LINEEND)
	getPartContent ($partnum, $EOL=Zend_Mime::LINEEND)

Static Public Member Functions
static	setDefaultTransport (Zend_Mail_Transport_Abstract $transport)
static	getDefaultTransport ()
static	clearDefaultTransport ()
static	setDefaultFrom ($email, $name=null)
static	getDefaultFrom ()
static	clearDefaultFrom ()
static	setDefaultReplyTo ($email, $name=null)
static	getDefaultReplyTo ()
static	clearDefaultReplyTo ()
Static Public Member Functions inherited from Zend_Mime_Message
static	createFromMessage ( $message, $boundary, $EOL=Zend_Mime::LINEEND)

Data Fields
	$hasAttachments = false

Protected Member Functions
	_encodeHeader ($value)
	_storeHeader ($headerName, $value, $append=false)
	_clearHeader ($headerName)
	_addRecipientAndHeader ($headerName, $email, $name)
	_filterEmail ($email)
	_filterName ($name)
	_filterOther ($data)
	_formatAddress ($email, $name)

Protected Attributes
	$_charset = 'iso-8859-1'
	$_headers = array()
	$_headerEncoding = Zend_Mime::ENCODING_QUOTEDPRINTABLE
	$_from = null
	$_to = array()
	$_recipients = array()
	$_replyTo = null
	$_returnPath = null
	$_subject = null
	$_date = null
	$_messageId = null
	$_bodyText = false
	$_bodyHtml = false
	$_mimeBoundary = null
	$_type = null
Protected Attributes inherited from Zend_Mime_Message
	$_parts = array()
	$_mime = null

Static Protected Attributes
static	$_defaultTransport = null
static	$_defaultFrom
static	$_defaultReplyTo

Additional Inherited Members
Static Protected Member Functions inherited from Zend_Mime_Message
static	_disassembleMime ($body, $boundary)

Detailed Description

Definition at line 52 of file Mail.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$charset = null

)

Public constructor

Parameters

string

$charset

Definition at line 213 of file Mail.php.

    {
        if ($charset != null) {
            $this->_charset = $charset;
        }
    }

Member Function Documentation

_addRecipientAndHeader()

_addRecipientAndHeader (   $headerName,   $email,   $name  )

protected

Helper function for adding a recipient and the corresponding header

Parameters

string	$headerName
string	$email
string	$name

Definition at line 557 of file Mail.php.

    {
        $email = $this->_filterEmail($email);
        $name  = $this->_filterName($name);
        // prevent duplicates
        $this->_recipients[$email] = 1;
        $this->_storeHeader($headerName, $this->_formatAddress($email, $name), true);
    }

_clearHeader()

_clearHeader (   $headerName )

protected

Clear header from the message

Parameters

string

$headerName

Deprecated:

use public method directly

Definition at line 545 of file Mail.php.

    {
        $this->clearHeader($headerName);
    }

_encodeHeader()

_encodeHeader (   $value )

protected

Encode header fields

Encodes header content according to RFC1522 if it contains non-printable characters.

Parameters

string

$value

Returns

string

Definition at line 502 of file Mail.php.

    {
        if (Zend_Mime::isPrintable($value) === false) {
            if ($this->getHeaderEncoding() === Zend_Mime::ENCODING_QUOTEDPRINTABLE) {
                $value = Zend_Mime::encodeQuotedPrintableHeader($value, $this->getCharset(), Zend_Mime::LINELENGTH, Zend_Mime::LINEEND);
            } else {
                $value = Zend_Mime::encodeBase64Header($value, $this->getCharset(), Zend_Mime::LINELENGTH, Zend_Mime::LINEEND);
            }
        }

        return $value;
    }

_filterEmail()

_filterEmail (   $email )

protected

Filter of email data

Parameters

string

$email

Returns

string

Definition at line 1212 of file Mail.php.

    {
        $rule = array("\r" => '',
                      "\n" => '',
                      "\t" => '',
                      '"'  => '',
                      ','  => '',
                      '<'  => '',
                      '>'  => '',
        );

        return strtr($email, $rule);
    }

_filterName()

_filterName (   $name )

protected

Filter of name data

Parameters

string

$name

Returns

string

Definition at line 1232 of file Mail.php.

    {
        $rule = array("\r" => '',
                      "\n" => '',
                      "\t" => '',
                      '"'  => "'",
                      '<'  => '[',
                      '>'  => ']',
        );

        return trim(strtr($name, $rule));
    }

_filterOther()

_filterOther (   $data )

protected

Filter of other data

Parameters

string

$data

Returns

string

Definition at line 1251 of file Mail.php.

    {
        $rule = array("\r" => '',
                      "\n" => '',
                      "\t" => '',
        );

        return strtr($data, $rule);
    }

_formatAddress()

_formatAddress (   $email,   $name  )

protected

Formats e-mail address

Parameters

string	$email
string	$name

Returns

string

Definition at line 1268 of file Mail.php.

    {
        if ($name === '' || $name === null || $name === $email) {
            return $email;
        } else {
            $encodedName = $this->_encodeHeader($name);
            if ($encodedName === $name  &&  strcspn($name, '()<>[]:;@\\,.') != strlen($name)) {
                $format = '"%s" <%s>';
            } else {
                $format = '%s <%s>';
            }
            return sprintf($format, $encodedName, $email);
        }
    }

_storeHeader()

_storeHeader (   $headerName,   $value,   $append = false  )

protected

Add a header to the message

Adds a header to this message. If append is true and the header already exists, raises a flag indicating that the header should be appended.

Parameters

string	$headerName
string	$value
bool	$append

Definition at line 525 of file Mail.php.

    {
        if (isset($this->_headers[$headerName])) {
            $this->_headers[$headerName][] = $value;
        } else {
            $this->_headers[$headerName] = array($value);
        }

        if ($append) {
            $this->_headers[$headerName]['append'] = true;
        }

    }

addAttachment()

addAttachment

(

Zend_Mime_Part

$attachment

)

Adds an existing attachment to the mail message

Parameters

Zend_Mime_Part

$attachment

Returns

Zend_Mail Provides fluent interface

Definition at line 443 of file Mail.php.

    {
        $this->addPart($attachment);
        $this->hasAttachments = true;

        return $this;
    }

addBcc()

addBcc

(

$email

)

Adds Bcc recipient, $email can be an array, or a single string address

Parameters

string | array

$email

Returns

Zend_Mail Provides fluent interface

Definition at line 615 of file Mail.php.

    {
        if (!is_array($email)) {
            $email = array($email);
        }

        foreach ($email as $recipient) {
            $this->_addRecipientAndHeader('Bcc', $recipient, '');
        }

        return $this;
    }

addCc()

addCc	(		$email,
			$name = ''
	)

Adds Cc-header and recipient, $email can be an array, or a single string address

Parameters

string | array	$email
string	$name

Returns

Zend_Mail Provides fluent interface

Definition at line 596 of file Mail.php.

    {
        if (!is_array($email)) {
            $email = array($name => $email);
        }

        foreach ($email as $n => $recipient) {
            $this->_addRecipientAndHeader('Cc', $recipient, is_int($n) ? '' : $n);
        }

        return $this;
    }

addHeader()

addHeader	(		$name,
			$value,
			$append = false
	)

Add a custom header to the message

Parameters

string	$name
string	$value
boolean	$append

Returns

Zend_Mail Provides fluent interface

Exceptions

Zend_Mail_Exception

on attempts to create standard headers

See also

Zend_Mail_Exception

Definition at line 1139 of file Mail.php.

    {
        $prohibit = array('to', 'cc', 'bcc', 'from', 'subject',
                          'reply-to', 'return-path',
                          'date', 'message-id',
                         );
        if (in_array(strtolower($name), $prohibit)) {
            #require_once 'Zend/Mail/Exception.php';
            throw new Zend_Mail_Exception('Cannot set standard header from addHeader()');
        }

        $value = $this->_filterOther($value);
        $value = $this->_encodeHeader($value);
        $this->_storeHeader($name, $value, $append);

        return $this;
    }

addTo()

addTo	(		$email,
			$name = ''
	)

Adds To-header and recipient, $email can be an array, or a single string address

Parameters

string | array	$email
string	$name

Returns

Zend_Mail Provides fluent interface

Definition at line 574 of file Mail.php.

    {
        if (!is_array($email)) {
            $email = array($name => $email);
        }

        foreach ($email as $n => $recipient) {
            $this->_addRecipientAndHeader('To', $recipient, is_int($n) ? '' : $n);
            $this->_to[] = $recipient;
        }

        return $this;
    }

clearDate()

clearDate

(

)

Clears the formatted date from the message

Returns

Zend_Mail Provides fluent interface

Definition at line 1030 of file Mail.php.

    {
        $this->_date = null;
        $this->clearHeader('Date');

        return $this;
    }

clearDefaultFrom()

static clearDefaultFrom ( )

static

Clears the default sender from the mail

Returns

void

Definition at line 794 of file Mail.php.

    {
        self::$_defaultFrom = null;
    }

clearDefaultReplyTo()

static clearDefaultReplyTo ( )

static

Clears the default ReplyTo-address and -name from the mail

Returns

void

Definition at line 845 of file Mail.php.

    {
        self::$_defaultReplyTo = null;
    }

clearDefaultTransport()

static clearDefaultTransport ( )

static

Clear the default transport property

Definition at line 203 of file Mail.php.

    {
        self::$_defaultTransport = null;
    }

clearFrom()

clearFrom

(

)

Clears the sender from the mail

Returns

Zend_Mail Provides fluent interface

Definition at line 746 of file Mail.php.

    {
        $this->_from = null;
        $this->clearHeader('From');

        return $this;
    }

clearHeader()

clearHeader

(

$headerName

)

Clear header from the message

Parameters

string

$headerName

Returns

Zend_Mail Provides fluent inter

Definition at line 644 of file Mail.php.

    {
        if (isset($this->_headers[$headerName])){
            unset($this->_headers[$headerName]);
        }
        return $this;
    }

clearMessageId()

clearMessageId

(

)

Clears the Message-ID from the message

Returns

Zend_Mail Provides fluent interface

Definition at line 1088 of file Mail.php.

    {
        $this->_messageId = null;
        $this->clearHeader('Message-Id');

        return $this;
    }

clearRecipients()

clearRecipients

(

)

Clears list of recipient email addresses

Returns

Zend_Mail Provides fluent interface

Definition at line 657 of file Mail.php.

    {
        $this->_recipients = array();
        $this->_to = array();

        $this->clearHeader('To');
        $this->clearHeader('Cc');
        $this->clearHeader('Bcc');

        return $this;
    }

clearReplyTo()

clearReplyTo

(

)

Clears the current Reply-To address from the message

Returns

Zend_Mail Provides fluent interface

Definition at line 759 of file Mail.php.

    {
        $this->_replyTo = null;
        $this->clearHeader('Reply-To');

        return $this;
    }

clearReturnPath()

clearReturnPath

(

)

Clears the current Return-Path address from the message

Returns

Zend_Mail Provides fluent interface

Definition at line 913 of file Mail.php.

    {
        $this->_returnPath = null;
        $this->clearHeader('Return-Path');

        return $this;
    }

clearSubject()

clearSubject

(

)

Clears the encoded subject from the message

Returns

Zend_Mail Provides fluent interface

Definition at line 959 of file Mail.php.

    {
        $this->_subject = null;
        $this->clearHeader('Subject');

        return $this;
    }

createAttachment()

createAttachment	(		$body,
			$mimeType = Zend_Mime::TYPE_OCTETSTREAM,
			$disposition = Zend_Mime::DISPOSITION_ATTACHMENT,
			$encoding = Zend_Mime::ENCODING_BASE64,
			$filename = null
	)

Creates a Zend_Mime_Part attachment

Attachment is automatically added to the mail object after creation. The attachment object is returned to allow for further manipulation.

Parameters

string	$body
string	$mimeType
string	$disposition
string	$encoding
string	$filename	OPTIONAL A filename for the attachment

Returns

Zend_Mime_Part Newly created Zend_Mime_Part object (to allow advanced settings)

Definition at line 465 of file Mail.php.

    {

        $mp = new Zend_Mime_Part($body);
        $mp->encoding = $encoding;
        $mp->type = $mimeType;
        $mp->disposition = $disposition;
        $mp->filename = $filename;

        $this->addAttachment($mp);

        return $mp;
    }

createMessageId()

createMessageId

(

)

Creates the Message-ID

Returns

string

Definition at line 1101 of file Mail.php.

                                      {

        $time = time();

        if ($this->_from !== null) {
            $user = $this->_from;
        } elseif (isset($_SERVER['REMOTE_ADDR'])) {
            $user = $_SERVER['REMOTE_ADDR'];
        } else {
            $user = getmypid();
        }

        $rand = mt_rand();

        if ($this->_recipients !== array()) {
            $recipient = array_rand($this->_recipients);
        } else {
            $recipient = 'unknown';
        }

        if (isset($_SERVER["SERVER_NAME"])) {
            $hostName = $_SERVER["SERVER_NAME"];
        } else {
            $hostName = php_uname('n');
        }

        return sha1($time . $user . $rand . $recipient) . '@' . $hostName;
    }

getBodyHtml()

getBodyHtml

(

$htmlOnly = false

)

Return Zend_Mime_Part representing body HTML

Parameters

bool

$htmlOnly

Whether to return the body HTML only, or the MIME part; defaults to false, the MIME part

Returns

false|Zend_Mime_Part|string

Definition at line 427 of file Mail.php.

    {
        if ($htmlOnly && $this->_bodyHtml) {
            $body = $this->_bodyHtml;
            return $body->getContent();
        }

        return $this->_bodyHtml;
    }

getBodyText()

getBodyText

(

$textOnly = false

)

Return text body Zend_Mime_Part or string

Parameters

bool

$textOnly

Whether to return just the body text content or the MIME part; defaults to false, the MIME part

Returns

false|Zend_Mime_Part|string

Definition at line 386 of file Mail.php.

    {
        if ($textOnly && $this->_bodyText) {
            $body = $this->_bodyText;
            return $body->getContent();
        }

        return $this->_bodyText;
    }

getCharset()

getCharset

(

)

Return charset string

Returns

string

Definition at line 225 of file Mail.php.

    {
        return $this->_charset;
    }

getDate()

getDate

(

)

Returns the formatted date of the message

Returns

string

Definition at line 1020 of file Mail.php.

    {
        return $this->_date;
    }

getDefaultFrom()

static getDefaultFrom ( )

static

Returns the default sender of the mail

Returns

null|array Null if none was set.

Definition at line 784 of file Mail.php.

    {
        return self::$_defaultFrom;
    }

getDefaultReplyTo()

static getDefaultReplyTo ( )

static

Returns the default Reply-To Address and Name of the mail

Returns

null|array Null if none was set.

Definition at line 835 of file Mail.php.

    {
        return self::$_defaultReplyTo;
    }

getDefaultTransport()

static getDefaultTransport ( )

static

Gets the default mail transport for all following uses of unittests

Todo:

Allow passing a string to indicate the transport to load

Allow passing in optional options for the transport to load

Definition at line 195 of file Mail.php.

    {
        return self::$_defaultTransport;
    }

getEncodingOfHeaders()

getEncodingOfHeaders

(

)

Return encoding of mail headers

Deprecated:

use getHeaderEncoding() instead

Returns

string

Definition at line 299 of file Mail.php.

    {
        return $this->getHeaderEncoding();
    }

getFrom()

getFrom

(

)

Returns the sender of the mail

Returns

string

Definition at line 726 of file Mail.php.

    {
        return $this->_from;
    }

getHeaderEncoding()

getHeaderEncoding

(

)

Return the encoding of mail headers

Either Zend_Mime::ENCODING_QUOTEDPRINTABLE or Zend_Mime::ENCODING_BASE64

Returns

string

Definition at line 311 of file Mail.php.

    {
        return $this->_headerEncoding;
    }

getHeaders()

getHeaders

(

)

Return mail headers

Returns

array

Definition at line 1165 of file Mail.php.

    {
        return $this->_headers;
    }

getMessageId()

getMessageId

(

)

Returns the Message-ID of the message

Returns

string

Definition at line 1077 of file Mail.php.

    {
        return $this->_messageId;
    }

getMimeBoundary()

getMimeBoundary

(

)

Return the boundary string used for the message

Returns

string

Definition at line 288 of file Mail.php.

    {
        return $this->_mimeBoundary;
    }

getPartCount()

getPartCount

(

)

Return a count of message parts

Returns

integer

Definition at line 488 of file Mail.php.

    {
        return count($this->_parts);
    }

getRecipients()

getRecipients

(

)

Return list of recipient email addresses

Returns

array (of strings)

Definition at line 633 of file Mail.php.

    {
        return array_keys($this->_recipients);
    }

getReplyTo()

getReplyTo

(

)

Returns the current Reply-To address of the message

Returns

string|null Reply-To address, null when not set

Definition at line 736 of file Mail.php.

    {
        return $this->_replyTo;
    }

getReturnPath()

getReturnPath

(

)

Returns the current Return-Path address of the message

If no Return-Path header is set, returns the value of $_from.

Returns

string

Definition at line 899 of file Mail.php.

    {
        if (null !== $this->_returnPath) {
            return $this->_returnPath;
        }

        return $this->_from;
    }

getSubject()

getSubject

(

)

Returns the encoded subject of the message

Returns

string

Definition at line 949 of file Mail.php.

    {
        return $this->_subject;
    }

getType()

getType

(

)

Get content type of the message

Returns

string

Definition at line 263 of file Mail.php.

    {
        return $this->_type;
    }

send()

send

(

$transport = null

)

Sends this email using the given transport or a previously set DefaultTransport or the internal mail function if no default transport had been set.

Parameters

Zend_Mail_Transport_Abstract

$transport

Returns

Zend_Mail Provides fluent interface

Definition at line 1178 of file Mail.php.

    {
        if ($transport === null) {
            if (! self::$_defaultTransport instanceof Zend_Mail_Transport_Abstract) {
                #require_once 'Zend/Mail/Transport/Sendmail.php';
                $transport = new Zend_Mail_Transport_Sendmail();
            } else {
                $transport = self::$_defaultTransport;
            }
        }

        if ($this->_date === null) {
            $this->setDate();
        }

        if(null === $this->_from && null !== self::getDefaultFrom()) {
            $this->setFromToDefaultFrom();
        }

        if(null === $this->_replyTo && null !== self::getDefaultReplyTo()) {
            $this->setReplyToFromDefault();
        }

        $transport->send($this);

        return $this;
    }

setBodyHtml()

setBodyHtml	(		$html,
			$charset = null,
			$encoding = Zend_Mime::ENCODING_QUOTEDPRINTABLE
	)

Sets the HTML body for the message

Parameters

string	$html
string	$charset
string	$encoding

Returns

Zend_Mail Provides fluent interface

Definition at line 404 of file Mail.php.

    {
        if ($charset === null) {
            $charset = $this->_charset;
        }

        $mp = new Zend_Mime_Part($html);
        $mp->encoding = $encoding;
        $mp->type = Zend_Mime::TYPE_HTML;
        $mp->disposition = Zend_Mime::DISPOSITION_INLINE;
        $mp->charset = $charset;

        $this->_bodyHtml = $mp;

        return $this;
    }

setBodyText()

setBodyText	(		$txt,
			$charset = null,
			$encoding = Zend_Mime::ENCODING_QUOTEDPRINTABLE
	)

Sets the text body for the message.

Parameters

string	$txt
string	$charset
string	$encoding

Returns

Zend_Mail Provides fluent interface

Definition at line 362 of file Mail.php.

    {
        if ($charset === null) {
            $charset = $this->_charset;
        }

        $mp = new Zend_Mime_Part($txt);
        $mp->encoding = $encoding;
        $mp->type = Zend_Mime::TYPE_TEXT;
        $mp->disposition = Zend_Mime::DISPOSITION_INLINE;
        $mp->charset = $charset;

        $this->_bodyText = $mp;

        return $this;
    }

setDate()

setDate

(

$date = null

)

Sets Date-header

Parameters

int | string | Zend_Date

$date

Returns

Zend_Mail Provides fluent interface

Exceptions

Zend_Mail_Exception

if called subsequent times or wrong date format.

See also

Zend_Mail_Exception

Zend_Mail_Exception

Zend_Mail_Exception

Definition at line 975 of file Mail.php.

    {
        if ($this->_date === null) {
            if ($date === null) {
                $date = date('r');
            } else if (is_int($date)) {
                $date = date('r', $date);
            } else if (is_string($date)) {
                $date = strtotime($date);
                if ($date === false || $date < 0) {
                    #require_once 'Zend/Mail/Exception.php';
                    throw new Zend_Mail_Exception('String representations of Date Header must be ' .
                                                  'strtotime()-compatible');
                }
                $date = date('r', $date);
            } else if ($date instanceof Zend_Date) {
                $date = $date->get(Zend_Date::RFC_2822);
            } else {
                #require_once 'Zend/Mail/Exception.php';
                throw new Zend_Mail_Exception(__METHOD__ . ' only accepts UNIX timestamps, Zend_Date objects, ' .
                                              ' and strtotime()-compatible strings');
            }
            $this->_date = $date;
            $this->_storeHeader('Date', $date);
        } else {
            #require_once 'Zend/Mail/Exception.php';
            throw new Zend_Mail_Exception('Date Header set twice');
        }
        return $this;
    }

setDefaultFrom()

static setDefaultFrom (   $email,   $name = null  )

static

Sets Default From-email and name of the message

Parameters

string	$email
string	$name	optional

Returns

void

Definition at line 774 of file Mail.php.

    {
        self::$_defaultFrom = array('email' => $email, 'name' => $name);
    }

setDefaultReplyTo()

static setDefaultReplyTo (   $email,   $name = null  )

static

Sets Default ReplyTo-address and -name of the message

Parameters

string	$email
string	$name	optional

Returns

void

Definition at line 825 of file Mail.php.

    {
        self::$_defaultReplyTo = array('email' => $email, 'name' => $name);
    }

setDefaultTransport()

static setDefaultTransport ( Zend_Mail_Transport_Abstract  $transport )

static

Sets the default mail transport for all following uses of Zend_Mail::send();

Todo:

Allow passing a string to indicate the transport to load

Allow passing in optional options for the transport to load

Parameters

Zend_Mail_Transport_Abstract

$transport

Definition at line 183 of file Mail.php.

    {
        self::$_defaultTransport = $transport;
    }

setEncodingOfHeaders()

setEncodingOfHeaders

(

$encoding

)

Set the encoding of mail headers

Deprecated:

Use setHeaderEncoding() instead.

Parameters

string

$encoding

Returns

Zend_Mail

Definition at line 323 of file Mail.php.

    {
        return $this->setHeaderEncoding($encoding);
    }

setFrom()

setFrom	(		$email,
			$name = null
	)

Sets From-header and sender of the message

Parameters

string	$email
string	$name

Returns

Zend_Mail Provides fluent interface

Exceptions

Zend_Mail_Exception

if called subsequent times

See also

Zend_Mail_Exception

Definition at line 677 of file Mail.php.

    {
        if (null !== $this->_from) {
            #require_once 'Zend/Mail/Exception.php';
            throw new Zend_Mail_Exception('From Header set twice');
        }

        $email = $this->_filterEmail($email);
        $name  = $this->_filterName($name);
        $this->_from = $email;
        $this->_storeHeader('From', $this->_formatAddress($email, $name), true);

        return $this;
    }

setFromToDefaultFrom()

setFromToDefaultFrom

(

)

Sets From-name and -email based on the defaults

Returns

Zend_Mail Provides fluent interface

Exceptions

Zend_Mail_Exception

Definition at line 805 of file Mail.php.

                                           {
        $from = self::getDefaultFrom();
        if($from === null) {
            #require_once 'Zend/Mail/Exception.php';
            throw new Zend_Mail_Exception(
                'No default From Address set to use');
        }

        $this->setFrom($from['email'], $from['name']);

        return $this;
    }

setHeaderEncoding()

setHeaderEncoding

(

$encoding

)

Set the encoding of mail headers

Parameters

string

$encoding

Zend_Mime::ENCODING_QUOTEDPRINTABLE or Zend_Mime::ENCODING_BASE64

Returns

Zend_Mail Provides fluent interface

Exceptions

Zend_Mail_Exception

See also

Zend_Mail_Exception

Definition at line 336 of file Mail.php.

    {
        $allowed = array(
            Zend_Mime::ENCODING_BASE64,
            Zend_Mime::ENCODING_QUOTEDPRINTABLE
        );
        if (!in_array($encoding, $allowed)) {
            #require_once 'Zend/Mail/Exception.php';
            throw new Zend_Mail_Exception('Invalid encoding "' . $encoding . '"');
        }
        $this->_headerEncoding = $encoding;

        return $this;
    }

setMessageId()

setMessageId

(

$id = true

)

Sets the Message-ID of the message

Parameters

boolean | string

$id

true :Auto false :No set null :No set string:Sets given string (Angle brackets is not necessary)

Returns

Zend_Mail Provides fluent interface

Exceptions

Zend_Mail_Exception

See also

Zend_Mail_Exception

Definition at line 1049 of file Mail.php.

    {
        if ($id === null || $id === false) {
            return $this;
        } elseif ($id === true) {
            $id = $this->createMessageId();
        }

        if ($this->_messageId === null) {
            $id = $this->_filterOther($id);
            $this->_messageId = $id;
            $this->_storeHeader('Message-Id', '<' . $this->_messageId . '>');
        } else {
            #require_once 'Zend/Mail/Exception.php';
            throw new Zend_Mail_Exception('Message-ID set twice');
        }

        return $this;
    }

setMimeBoundary()

setMimeBoundary

(

$boundary

)

Set an arbitrary mime boundary for the message

If not set, Zend_Mime will generate one.

Parameters

string

$boundary

Returns

Zend_Mail Provides fluent interface

Definition at line 276 of file Mail.php.

    {
        $this->_mimeBoundary = $boundary;

        return $this;
    }

setReplyTo()

setReplyTo	(		$email,
			$name = null
	)

Set Reply-To Header

Parameters

string	$email
string	$name

Returns

Zend_Mail

Exceptions

Zend_Mail_Exception

if called more than one time

See also

Zend_Mail_Exception

Definition at line 703 of file Mail.php.

    {
        if (null !== $this->_replyTo) {
            #require_once 'Zend/Mail/Exception.php';
            throw new Zend_Mail_Exception('Reply-To Header set twice');
        }

        $email = $this->_filterEmail($email);
        $name  = $this->_filterName($name);
        $this->_replyTo = $email;
        $this->_storeHeader('Reply-To', $this->_formatAddress($email, $name), true);

        return $this;
    }

setReplyToFromDefault()

setReplyToFromDefault

(

)

Sets ReplyTo-name and -email based on the defaults

Returns

Zend_Mail Provides fluent interface

Exceptions

Zend_Mail_Exception

Definition at line 856 of file Mail.php.

                                            {
        $replyTo = self::getDefaultReplyTo();
        if($replyTo === null) {
            #require_once 'Zend/Mail/Exception.php';
            throw new Zend_Mail_Exception(
                'No default Reply-To Address set to use');
        }

        $this->setReplyTo($replyTo['email'], $replyTo['name']);

        return $this;
    }

setReturnPath()

setReturnPath

(

$email

)

Sets the Return-Path header of the message

Parameters

string

$email

Returns

Zend_Mail Provides fluent interface

Exceptions

Zend_Mail_Exception

if set multiple times

See also

Zend_Mail_Exception

Definition at line 876 of file Mail.php.

    {
        if ($this->_returnPath === null) {
            $email = $this->_filterEmail($email);
            $this->_returnPath = $email;
            $this->_storeHeader('Return-Path', $email, false);
        } else {
            #require_once 'Zend/Mail/Exception.php';
            throw new Zend_Mail_Exception('Return-Path Header set twice');
        }
        return $this;
    }

setSubject()

setSubject

(

$subject

)

Sets the subject of the message

Parameters

string

$subject

Returns

Zend_Mail Provides fluent interface

Exceptions

Zend_Mail_Exception

See also

Zend_Mail_Exception

Definition at line 928 of file Mail.php.

    {
        if ($this->_subject === null) {
            $subject = $this->_filterOther($subject);
            $this->_subject = $this->_encodeHeader($subject);
            $this->_storeHeader('Subject', $this->_subject);
        } else {
            #require_once 'Zend/Mail/Exception.php';
            throw new Zend_Mail_Exception('Subject set twice');
        }
        return $this;
    }

setType()

setType

(

$type

)

Set content type

Should only be used for manually setting multipart content types.

Parameters

string

$type

Content type

Returns

Zend_Mail Implements fluent interface

Exceptions

Zend_Mail_Exception

for types not supported by Zend_Mime

See also

Zend_Mail_Exception

Definition at line 239 of file Mail.php.

    {
        $allowed = array(
            Zend_Mime::MULTIPART_ALTERNATIVE,
            Zend_Mime::MULTIPART_MIXED,
            Zend_Mime::MULTIPART_RELATED,
        );
        if (!in_array($type, $allowed)) {
            #require_once 'Zend/Mail/Exception.php';
            throw new Zend_Mail_Exception('Invalid content type "' . $type . '"');
        }

        $this->_type = $type;
        return $this;
    }

Field Documentation

$_bodyHtml

$_bodyHtml = false

protected

Definition at line 152 of file Mail.php.

$_bodyText

$_bodyText = false

protected

Definition at line 146 of file Mail.php.

$_charset

$_charset = 'iso-8859-1'

protected

Definition at line 80 of file Mail.php.

$_date

$_date = null

protected

Definition at line 134 of file Mail.php.

$_defaultFrom

$_defaultFrom

staticprotected

Definition at line 68 of file Mail.php.

$_defaultReplyTo

$_defaultReplyTo

staticprotected

Definition at line 74 of file Mail.php.

$_defaultTransport

$_defaultTransport = null

staticprotected

Definition at line 62 of file Mail.php.

$_from

$_from = null

protected

Definition at line 98 of file Mail.php.

$_headerEncoding

$_headerEncoding = Zend_Mime::ENCODING_QUOTEDPRINTABLE

protected

Definition at line 92 of file Mail.php.

$_headers

$_headers = array()

protected

Definition at line 86 of file Mail.php.

$_messageId

$_messageId = null

protected

Definition at line 140 of file Mail.php.

$_mimeBoundary

$_mimeBoundary = null

protected

Definition at line 158 of file Mail.php.

$_recipients

$_recipients = array()

protected

Definition at line 110 of file Mail.php.

$_replyTo

$_replyTo = null

protected

Definition at line 116 of file Mail.php.

$_returnPath

$_returnPath = null

protected

Definition at line 122 of file Mail.php.

$_subject

$_subject = null

protected

Definition at line 128 of file Mail.php.

$_to

$_to = array()

protected

Definition at line 104 of file Mail.php.

$_type

$_type = null

protected

Definition at line 164 of file Mail.php.

$hasAttachments

$hasAttachments = false

Definition at line 172 of file Mail.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Mail.php