Mail.php

Show:

inherited

Classes
- \Zend_Mail

Table of Contents

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 [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Mail
Version: $Id: Mail.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Mail
jump to top

Package: Zend\Mail

Class for sending an email.

Parent(s): \Zend_Mime_Message
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

false|\Zend_Mime_Part $_bodyHtml = false

text/html MIME part

Default valuefalseDetails

Type: false | \Zend_Mime_Part

false|\Zend_Mime_Part $_bodyText = false

text/plain MIME part

Default valuefalseDetails

Type: false | \Zend_Mime_Part

string $_charset = 'iso-8859-1'

Mail character set

Default value'iso-8859-1'Details

Type: string

string $_date = null

Date: header

Default valuenullDetails

Type: string

array $_defaultFrom =

static

Details

Type: array
Static

array $_defaultReplyTo =

static

Details

Type: array
Static

\Zend_Mail_Transport_Abstract $_defaultTransport = null

static

Default valuenullDetails

Type: \Zend_Mail_Transport_Abstract
Static

string $_from = null

From: address

Default valuenullDetails

Type: string

string $_headerEncoding = \Zend_Mime::ENCODING_QUOTEDPRINTABLE

Encoding of Mail headers

Default value\Zend_Mime::ENCODING_QUOTEDPRINTABLEDetails

Type: string

array $_headers = array()

Mail headers

Default valuearray()Details

Type: array

string $_messageId = null

Message-ID: header

Default valuenullDetails

Type: string

$_mime = null

inheritedInherited from: \Zend_Mime_Message::$$_mime

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Mime_Message::$$_mime

string $_mimeBoundary = null

MIME boundary string

Default valuenullDetails

Type: string

$_parts = array()

inheritedInherited from: \Zend_Mime_Message::$$_parts

Default valuearray()Details

Type: n/a
Inherited_from: \Zend_Mime_Message::$$_parts

array $_recipients = array()

Array of all recipients

Default valuearray()Details

Type: array

string $_replyTo = null

Reply-To header

Default valuenullDetails

Type: string

string $_returnPath = null

Return-Path header

Default valuenullDetails

Type: string

string $_subject = null

Subject: header

Default valuenullDetails

Type: string

array $_to = array()

To: addresses

Default valuearray()Details

Type: array

string $_type = null

Content type of the message

Default valuenullDetails

Type: string

boolean $hasAttachments = false

Flag: whether or not email has attachments

Default valuefalseDetails

Type: boolean

Methods

__construct(string $charset = null) : void

Public constructor

Parameters

Name	Type	Description
$charset	string

_addRecipientAndHeader(string $headerName, string $email, string $name) : void

Helper function for adding a recipient and the corresponding header

Parameters

Name	Type	Description
$headerName	string
$email	string
$name	string

_clearHeader(string $headerName) : void

Clear header from the message

Parameters

Name	Type	Description
$headerName	string

Details

Deprecated: use public method directly

_disassembleMime(string $body, string $boundary) : array

staticinherited

Explode MIME multipart string into seperate parts

Inherited from: \Zend_Mime_Message::_disassembleMime()

Parts consist of the header and the body of each MIME part.

Parameters

Name	Type	Description
$body	string
$boundary	string

Returns

Type	Description
array

_encodeHeader(string $value) : string

Encode header fields

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

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
string

_filterEmail(string $email) : string

Filter of email data

Parameters

Name	Type	Description
$email	string

Returns

Type	Description
string

_filterName(string $name) : string

Filter of name data

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
string

_filterOther(string $data) : string

Filter of other data

Parameters

Name	Type	Description
$data	string

Returns

Type	Description
string

_formatAddress(string $email, string $name) : string

Formats e-mail address

Parameters

Name	Type	Description
$email	string
$name	string

Returns

Type	Description
string

_storeHeader(string $headerName, string $value, bool $append = false) : void

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

Name	Type	Description
$headerName	string
$value	string
$append	bool

addAttachment(\Zend_Mime_Part $attachment) : \Zend_Mail

Adds an existing attachment to the mail message

Parameters

Name	Type	Description
$attachment	\Zend_Mime_Part

Returns

Type	Description
\Zend_Mail	Provides fluent interface

addBcc(string | array $email) : \Zend_Mail

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

Parameters

Name	Type	Description
$email	string \| array

Returns

Type	Description
\Zend_Mail	Provides fluent interface

addCc(string | array $email, string $name = '') : \Zend_Mail

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

Parameters

Name	Type	Description
$email	string \| array
$name	string

Returns

Type	Description
\Zend_Mail	Provides fluent interface

addHeader(string $name, string $value, boolean $append = false) : \Zend_Mail

Add a custom header to the message

Parameters

Name	Type	Description
$name	string
$value	string
$append	boolean

Returns

Type	Description
\Zend_Mail	Provides fluent interface

Throws

Exception	Description
\Zend_Mail_Exception	on attempts to create standard headers

addPart(\Zend_Mime_Part $part) : void

inherited

Append a new Zend_Mime_Part to the current message

Inherited from: \Zend_Mime_Message::addPart()

Parameters

Name	Type	Description
$part	\Zend_Mime_Part

addTo(string | array $email, string $name = '') : \Zend_Mail

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

Parameters

Name	Type	Description
$email	string \| array
$name	string

Returns

Type	Description
\Zend_Mail	Provides fluent interface

clearDate() : \Zend_Mail

Clears the formatted date from the message

Returns

Type	Description
\Zend_Mail	Provides fluent interface

clearDefaultFrom() : void

static

Clears the default sender from the mail

clearDefaultReplyTo() : void

static

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

clearDefaultTransport() : void

static

Clear the default transport property

clearFrom() : \Zend_Mail

Clears the sender from the mail

Returns

Type	Description
\Zend_Mail	Provides fluent interface

clearHeader(string $headerName) : \Zend_Mail

Clear header from the message

Parameters

Name	Type	Description
$headerName	string

Returns

Type	Description
\Zend_Mail	Provides fluent inter

clearMessageId() : \Zend_Mail

Clears the Message-ID from the message

Returns

Type	Description
\Zend_Mail	Provides fluent interface

clearRecipients() : \Zend_Mail

Clears list of recipient email addresses

Returns

Type	Description
\Zend_Mail	Provides fluent interface

clearReplyTo() : \Zend_Mail

Clears the current Reply-To address from the message

Returns

Type	Description
\Zend_Mail	Provides fluent interface

clearReturnPath() : \Zend_Mail

Clears the current Return-Path address from the message

Returns

Type	Description
\Zend_Mail	Provides fluent interface

clearSubject() : \Zend_Mail

Clears the encoded subject from the message

Returns

Type	Description
\Zend_Mail	Provides fluent interface

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

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

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

Returns

Type	Description
\Zend_Mime_Part	Newly created Zend_Mime_Part object (to allow advanced settings)

createFromMessage(string $message, string $boundary, string $EOL = \Zend_Mime::LINEEND) : \Zend_Mime_Message

staticinherited

Decodes a MIME encoded string and returns a Zend_Mime_Message object with all the MIME parts set according to the given string

Inherited from: \Zend_Mime_Message::createFromMessage()

Parameters

Name	Type	Description
$message	string
$boundary	string
$EOL	string	EOL string; defaults to {@link Zend_Mime::LINEEND}

Returns

Type	Description
\Zend_Mime_Message

createMessageId() : string

Creates the Message-ID

Returns

Type	Description
string

generateMessage(string $EOL = \Zend_Mime::LINEEND) : string

inherited

Generate MIME-compliant message from the current configuration

Inherited from: \Zend_Mime_Message::generateMessage()

This can be a multipart message if more than one MIME part was added. If only one part is present, the content of this part is returned. If no part had been added, an empty string is returned.

Parts are seperated by the mime boundary as defined in Zend_Mime. If setMime() has been called before this method, the Zend_Mime object set by this call will be used. Otherwise, a new Zend_Mime object is generated and used.

Parameters

Name	Type	Description
$EOL	string	EOL string; defaults to {@link Zend_Mime::LINEEND}

Returns

Type	Description
string

getBodyHtml(bool $htmlOnly = false) : false | \Zend_Mime_Part | string

Return Zend_Mime_Part representing body HTML

Parameters

Name	Type	Description
$htmlOnly	bool	Whether to return the body HTML only, or the MIME part; defaults to false, the MIME part

Returns

Type	Description
false \| \Zend_Mime_Part \| string

getBodyText(bool $textOnly = false) : false | \Zend_Mime_Part | string

Return text body Zend_Mime_Part or string

Parameters

Name	Type	Description
$textOnly	bool	textOnly Whether to return just the body text content or the MIME part; defaults to false, the MIME part

Returns

Type	Description
false \| \Zend_Mime_Part \| string

getCharset() : string

Return charset string

Returns

Type	Description
string

getDate() : string

Returns the formatted date of the message

Returns

Type	Description
string

getDefaultFrom() : null | array

static

Returns the default sender of the mail

Returns

Type	Description
null \| array	Null if none was set.

getDefaultReplyTo() : null | array

static

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

Returns

Type	Description
null \| array	Null if none was set.

getDefaultTransport() : void

static

Gets the default mail transport for all following uses of unittests

Details

Todo: Allow passing a string to indicate the transport to load
Todo: Allow passing in optional options for the transport to load

getEncodingOfHeaders() : string

Return encoding of mail headers

Returns

Type	Description
string

Details

Deprecated: use {@link getHeaderEncoding()} instead

getFrom() : string

Returns the sender of the mail

Returns

Type	Description
string

getHeaderEncoding() : string

Return the encoding of mail headers

Either Zend_Mime::ENCODING_QUOTEDPRINTABLE or Zend_Mime::ENCODING_BASE64

Returns

Type	Description
string

getHeaders() : void

Return mail headers

getMessageId() : string

Returns the Message-ID of the message

Returns

Type	Description
string

getMime() : \Zend_Mime

inherited

Returns the Zend_Mime object in use by the message

Inherited from: \Zend_Mime_Message::getMime()

If the object was not present, it is created and returned. Can be used to determine the boundary used in this message.

Returns

Type	Description
\Zend_Mime

getMimeBoundary() : string

Return the boundary string used for the message

Returns

Type	Description
string

getPartContent(int $partnum, $EOL = \Zend_Mime::LINEEND) : string

inherited

Get the (encoded) content of a given part as a string

Inherited from: \Zend_Mime_Message::getPartContent()

Parameters

Name	Type	Description
$partnum	int
$EOL

Returns

Type	Description
string

getPartCount() : integer

Return a count of message parts

Returns

Type	Description
integer

getPartHeaders(int $partnum, $EOL = \Zend_Mime::LINEEND) : string

inherited

Get the headers of a given part as a string

Inherited from: \Zend_Mime_Message::getPartHeaders()

Parameters

Name	Type	Description
$partnum	int
$EOL

Returns

Type	Description
string

getPartHeadersArray(int $partnum) : array

inherited

Get the headers of a given part as an array

Inherited from: \Zend_Mime_Message::getPartHeadersArray()

Parameters

Name	Type	Description
$partnum	int

Returns

Type	Description
array

getParts() : array

inherited

Returns the list of all Zend_Mime_Parts in the message

Inherited from: \Zend_Mime_Message::getParts()

Returns

Type	Description
array	of Zend_Mime_Part

getRecipients() : array

Return list of recipient email addresses

Returns

Type	Description
array	(of strings)

getReplyTo() : string | null

Returns the current Reply-To address of the message

Returns

Type	Description
string \| null	Reply-To address, null when not set

getReturnPath() : string

Returns the current Return-Path address of the message

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

Returns

Type	Description
string

getSubject() : string

Returns the encoded subject of the message

Returns

Type	Description
string

getType() : string

Get content type of the message

Returns

Type	Description
string

isMultiPart() : boolean

inherited

Check if message needs to be sent as multipart MIME message or if it has only one part.

Inherited from: \Zend_Mime_Message::isMultiPart()

Returns

Type	Description
boolean

send(\Zend_Mail_Transport_Abstract $transport = null) : \Zend_Mail

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

Name	Type	Description
$transport	\Zend_Mail_Transport_Abstract

Returns

Type	Description
\Zend_Mail	Provides fluent interface

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

Sets the HTML body for the message

Parameters

Name	Type	Description
$html	string
$charset	string
$encoding	string

Returns

Type	Description
\Zend_Mail	Provides fluent interface

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

Sets the text body for the message.

Parameters

Name	Type	Description
$txt	string
$charset	string
$encoding	string

Returns

Type	Description
\Zend_Mail	Provides fluent interface

setDate(\timestamp | string | \Zend_Date $date = null) : \Zend_Mail

Sets Date-header

Parameters

Name	Type	Description
$date	\timestamp \| string \| \Zend_Date

Returns

Type	Description
\Zend_Mail	Provides fluent interface

Throws

Exception	Description
\Zend_Mail_Exception	if called subsequent times or wrong date format.

setDefaultFrom(string $email, string $name = null) : void

static

Sets Default From-email and name of the message

Parameters

Name	Type	Description
$email	string
$name	string	Optional $name

setDefaultReplyTo(string $email, string $name = null) : void

static

Sets Default ReplyTo-address and -name of the message

Parameters

Name	Type	Description
$email	string
$name	string	Optional $name

setDefaultTransport(\Zend_Mail_Transport_Abstract $transport) : void

static

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

Parameters

Name	Type	Description
$transport	\Zend_Mail_Transport_Abstract

Details

Todo: Allow passing a string to indicate the transport to load
Todo: Allow passing in optional options for the transport to load

setEncodingOfHeaders(string $encoding) : \Zend_Mail

Set the encoding of mail headers

Parameters

Name	Type	Description
$encoding	string

Returns

Type	Description
\Zend_Mail

Details

Deprecated: Use {@link setHeaderEncoding()} instead.

setFrom(string $email, string $name = null) : \Zend_Mail

Sets From-header and sender of the message

Parameters

Name	Type	Description
$email	string
$name	string

Returns

Type	Description
\Zend_Mail	Provides fluent interface

Throws

Exception	Description
\Zend_Mail_Exception	if called subsequent times

setFromToDefaultFrom() : \Zend_Mail

Sets From-name and -email based on the defaults

Returns

Type	Description
\Zend_Mail	Provides fluent interface

setHeaderEncoding(string $encoding) : \Zend_Mail

Set the encoding of mail headers

Parameters

Name	Type	Description
$encoding	string	Zend_Mime::ENCODING_QUOTEDPRINTABLE or Zend_Mime::ENCODING_BASE64

Returns

Type	Description
\Zend_Mail	Provides fluent interface

setMessageId(boolean | string $id = true) : \Zend_Mail

Sets the Message-ID of the message

Parameters

Name	Type	Description
$id	boolean \| string	true :Auto false :No set null :No set string:Sets given string (Angle brackets is not necessary)

Returns

Type	Description
\Zend_Mail	Provides fluent interface

Throws

Exception	Description
\Zend_Mail_Exception

setMime(\Zend_Mime $mime) : void

inherited

Set Zend_Mime object for the message

Inherited from: \Zend_Mime_Message::setMime()

This can be used to set the boundary specifically or to use a subclass of Zend_Mime for generating the boundary.

Parameters

Name	Type	Description
$mime	\Zend_Mime

setMimeBoundary(string $boundary) : \Zend_Mail

Set an arbitrary mime boundary for the message

If not set, Zend_Mime will generate one.

Parameters

Name	Type	Description
$boundary	string

Returns

Type	Description
\Zend_Mail	Provides fluent interface

setParts(array $parts) : void

inherited

Sets the given array of Zend_Mime_Parts as the array for the message

Inherited from: \Zend_Mime_Message::setParts()

Parameters

Name	Type	Description
$parts	array

setReplyTo(string $email, string $name = null) : \Zend_Mail

Set Reply-To Header

Parameters

Name	Type	Description
$email	string
$name	string

Returns

Type	Description
\Zend_Mail

Throws

Exception	Description
\Zend_Mail_Exception	if called more than one time

setReplyToFromDefault() : \Zend_Mail

Sets ReplyTo-name and -email based on the defaults

Returns

Type	Description
\Zend_Mail	Provides fluent interface

setReturnPath(string $email) : \Zend_Mail

Sets the Return-Path header of the message

Parameters

Name	Type	Description
$email	string

Returns

Type	Description
\Zend_Mail	Provides fluent interface

Throws

Exception	Description
\Zend_Mail_Exception	if set multiple times

setSubject(string $subject) : \Zend_Mail

Sets the subject of the message

Parameters

Name	Type	Description
$subject	string

Returns

Type	Description
\Zend_Mail	Provides fluent interface

Throws

Exception	Description
\Zend_Mail_Exception

setType(string $type) : \Zend_Mail

Set content type

Should only be used for manually setting multipart content types.

Parameters

Name	Type	Description
$type	string	Content type

Returns

Type	Description
\Zend_Mail	Implements fluent interface

Throws

Exception	Description
\Zend_Mail_Exception	for types not supported by Zend_Mime

Mail.php

\Zend_Mailjump to top

Properties

Methods

\Zend_Mail
jump to top