Mail.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Mail
version: $Id: Mail.php 20783 2010-01-31 08:06:30Z yoshida@zend.co.jp $
Classes: Zend_Mail

Description

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.

Zend_Mail
jump to top

Extends from: Zend_Mime_Message
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Mail
Properties: $_defaultTransport; $_defaultFrom; $_defaultReplyTo; $_charset; $_headers; $_headerEncoding; $_from; $_to; $_recipients; $_replyTo; $_returnPath; $_subject; $_date; $_messageId; $_bodyText; $_bodyHtml; $_mimeBoundary; $_type; $hasAttachments
Methods: setDefaultTransport; getDefaultTransport; clearDefaultTransport; __construct; getCharset; setType; getType; setMimeBoundary; getMimeBoundary; getEncodingOfHeaders; getHeaderEncoding; setEncodingOfHeaders; setHeaderEncoding; setBodyText; getBodyText; setBodyHtml; getBodyHtml; addAttachment; createAttachment; getPartCount; _encodeHeader; _storeHeader; _clearHeader; _addRecipientAndHeader; addTo; addCc; addBcc; getRecipients; clearRecipients; setFrom; setReplyTo; getFrom; getReplyTo; clearFrom; clearReplyTo; setDefaultFrom; getDefaultFrom; clearDefaultFrom; setFromToDefaultFrom; setDefaultReplyTo; getDefaultReplyTo; clearDefaultReplyTo; setReplyToFromDefault; setReturnPath; getReturnPath; clearReturnPath; setSubject; getSubject; clearSubject; setDate; getDate; clearDate; setMessageId; getMessageId; clearMessageId; createMessageId; addHeader; getHeaders; send; _filterEmail; _filterName; _filterOther; _formatAddress

Description

Class for sending an email.

Properties

$_bodyHtml
jump to class

false|Zend_Mime_Part $_bodyHtml = 'false'

text/html MIME part

Details

$_bodyHtml: false|Zend_Mime_Part
visibility: protected
default: false
final: false
static: false

$_bodyText
jump to class

false|Zend_Mime_Part $_bodyText = 'false'

text/plain MIME part

Details

$_bodyText: false|Zend_Mime_Part
visibility: protected
default: false
final: false
static: false

$_charset
jump to class

string $_charset = 'null'

Mail character set

Details

$_charset: string
visibility: protected
default: null
final: false
static: false

$_date
jump to class

string $_date = 'null'

Date: header

Details

$_date: string
visibility: protected
default: null
final: false
static: false

$_defaultFrom
jump to class

array $_defaultFrom = ''

Details

$_defaultFrom: array
visibility: protected
default
final: false
static: true
static

$_defaultReplyTo
jump to class

array $_defaultReplyTo = ''

Details

$_defaultReplyTo: array
visibility: protected
default
final: false
static: true
static

$_defaultTransport
jump to class

Zend_Mail_Transport_Abstract $_defaultTransport = 'null'

Details

$_defaultTransport: Zend_Mail_Transport_Abstract
visibility: protected
default: null
final: false
static: true
static

$_from
jump to class

string $_from = 'null'

From: address

Details

$_from: string
visibility: protected
default: null
final: false
static: false

$_headerEncoding
jump to class

string $_headerEncoding = 'Zend_Mime'

Encoding of Mail headers

Details

$_headerEncoding: string
visibility: protected
default: Zend_Mime
final: false
static: false

$_headers
jump to class

array $_headers = 'array'

Mail headers

Details

$_headers: array
visibility: protected
default: array
final: false
static: false

$_messageId
jump to class

string $_messageId = 'null'

Message-ID: header

Details

$_messageId: string
visibility: protected
default: null
final: false
static: false

$_mimeBoundary
jump to class

string $_mimeBoundary = 'null'

MIME boundary string

Details

$_mimeBoundary: string
visibility: protected
default: null
final: false
static: false

$_recipients
jump to class

array $_recipients = 'array'

Array of all recipients

Details

$_recipients: array
visibility: protected
default: array
final: false
static: false

$_replyTo
jump to class

string $_replyTo = 'null'

Reply-To header

Details

$_replyTo: string
visibility: protected
default: null
final: false
static: false

$_returnPath
jump to class

string $_returnPath = 'null'

Return-Path header

Details

$_returnPath: string
visibility: protected
default: null
final: false
static: false

$_subject
jump to class

string $_subject = 'null'

Subject: header

Details

$_subject: string
visibility: protected
default: null
final: false
static: false

$_to
jump to class

array $_to = 'array'

To: addresses

Details

$_to: array
visibility: protected
default: array
final: false
static: false

$_type
jump to class

string $_type = 'null'

Content type of the message

Details

$_type: string
visibility: protected
default: null
final: false
static: false

$hasAttachments
jump to class

boolean $hasAttachments = 'false'

Flag: whether or not email has attachments

Details

$hasAttachments: boolean
visibility: public
default: false
final: false
static: false

Methods

__construct
jump to class

__construct(
          string $charset
              =
              iso-8859-1
          )
        
        :

Public constructor

Arguments

$charset: string

Details

visibility: public
final: false
static: false

_addRecipientAndHeader
jump to class

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

Helper function for adding a recipient and the corresponding header

Arguments

$headerName: string
$email: string
$name: string

Details

visibility: protected
final: false
static: false

_clearHeader
jump to class

_clearHeader(
          string $headerName
          )
        
        :

Clear header from the message

Arguments

$headerName: string

Details

visibility: protected
final: false
static: false

_encodeHeader
jump to class

_encodeHeader(
          string $value
          )
        
        :
        string

Encode header fields

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

Arguments

$value: string

Output

string

Details

visibility: protected
final: false
static: false

_filterEmail
jump to class

_filterEmail(
          string $email
          )
        
        :
        string

Filter of email data

Arguments

$email: string

Output

string

Details

visibility: protected
final: false
static: false

_filterName
jump to class

_filterName(
          string $name
          )
        
        :
        string

Filter of name data

Arguments

$name: string

Output

string

Details

visibility: protected
final: false
static: false

_filterOther
jump to class

_filterOther(
          string $data
          )
        
        :
        string

Filter of other data

Arguments

$data: string

Output

string

Details

visibility: protected
final: false
static: false

_formatAddress
jump to class

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

Formats e-mail address

Arguments

$email: string
$name: string

Output

string

Details

visibility: protected
final: false
static: false

_storeHeader
jump to class

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

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.

Arguments

$headerName: string
$value: string
$append: bool

Details

visibility: protected
final: false
static: false

addAttachment
jump to class

addAttachment(
          Zend_Mime_Part $attachment
          )
        
        :
        Zend_Mail

Adds an existing attachment to the mail message

Arguments

$attachment: Zend_Mime_Part

Output

Zend_Mail: Provides fluent interface

Details

visibility: public
final: false
static: false

addBcc
jump to class

addBcc(
          string|array $email
          )
        
        :
        Zend_Mail

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

Arguments

$email: stringarray

Output

Zend_Mail: Provides fluent interface

Details

visibility: public
final: false
static: false

addCc
jump to class

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

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

Arguments

$email: stringarray
$name: string

Output

Zend_Mail: Provides fluent interface

Details

visibility: public
final: false
static: false

addHeader
jump to class

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

Add a custom header to the message

Arguments

$name: string
$value: string
$append: boolean

Output

Zend_Mail: Provides fluent interface

Details

visibility: public
final: false
static: false
throws: on attempts to create standard headers

addTo
jump to class

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

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

Arguments

$email: stringarray
$name: string

Output

Zend_Mail: Provides fluent interface

Details

visibility: public
final: false
static: false

clearDate
jump to class

clearDate(
          
          )
        
        :
        Zend_Mail

Clears the formatted date from the message

Output

Zend_Mail: Provides fluent interface

Details

visibility: public
final: false
static: false

clearDefaultFrom
jump to class

clearDefaultFrom(
          
          )
        
        :
        void

Clears the default sender from the mail

Details

visibility: public
final: false
static: true

clearDefaultReplyTo
jump to class

clearDefaultReplyTo(
          
          )
        
        :
        void

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

Details

visibility: public
final: false
static: true

clearDefaultTransport
jump to class

clearDefaultTransport(
          
          )
        
        :

Clear the default transport property

Details

visibility: public
final: false
static: true

clearFrom
jump to class

clearFrom(
          
          )
        
        :
        Zend_Mail

Clears the sender from the mail

Output

Zend_Mail: Provides fluent interface

Details

visibility: public
final: false
static: false

clearMessageId
jump to class

clearMessageId(
          
          )
        
        :
        Zend_Mail

Clears the Message-ID from the message

Output

Zend_Mail: Provides fluent interface

Details

visibility: public
final: false
static: false

clearRecipients
jump to class

clearRecipients(
          
          )
        
        :
        Zend_Mail

Clears list of recipient email addresses

Output

Zend_Mail: Provides fluent interface

Details

visibility: public
final: false
static: false

clearReplyTo
jump to class

clearReplyTo(
          
          )
        
        :
        Zend_Mail

Clears the current Reply-To address from the message

Output

Zend_Mail: Provides fluent interface

Details

visibility: public
final: false
static: false

clearReturnPath
jump to class

clearReturnPath(
          
          )
        
        :
        Zend_Mail

Clears the current Return-Path address from the message

Output

Zend_Mail: Provides fluent interface

Details

visibility: public
final: false
static: false

clearSubject
jump to class

clearSubject(
          
          )
        
        :
        Zend_Mail

Clears the encoded subject from the message

Output

Zend_Mail: Provides fluent interface

Details

visibility: public
final: false
static: false

createAttachment
jump to class

createAttachment(
          string $body, string $mimeType
              =
              Zend_Mime, string $disposition
              =
              Zend_Mime, string $encoding
              =
              Zend_Mime, 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.

Arguments

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

Output

Zend_Mime_Part: Newly created Zend_Mime_Part object (to allow advanced settings)

Details

visibility: public
final: false
static: false

createMessageId
jump to class

createMessageId(
          
          )
        
        :
        string

Creates the Message-ID

Output

string

Details

visibility: public
final: false
static: false

getBodyHtml
jump to class

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

Return Zend_Mime_Part representing body HTML

Arguments

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

Output

false|Zend_Mime_Part|string

Details

visibility: public
final: false
static: false

getBodyText
jump to class

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

Return text body Zend_Mime_Part or string

Arguments

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

Output

false|Zend_Mime_Part|string

Details

visibility: public
final: false
static: false

getCharset
jump to class

getCharset(
          
          )
        
        :
        string

Return charset string

Output

string

Details

visibility: public
final: false
static: false

getDate
jump to class

getDate(
          
          )
        
        :
        string

Returns the formatted date of the message

Output

string

Details

visibility: public
final: false
static: false

getDefaultFrom
jump to class

getDefaultFrom(
          
          )
        
        :
        null|array

Returns the default sender of the mail

Output

null|array: Null if none was set.

Details

visibility: public
final: false
static: true

getDefaultReplyTo
jump to class

getDefaultReplyTo(
          
          )
        
        :
        null|array

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

Output

null|array: Null if none was set.

Details

visibility: public
final: false
static: true

getDefaultTransport
jump to class

getDefaultTransport(
          
          )
        
        :

Gets the default mail transport for all following uses of unittests

Details

visibility: public
final: false
static: true
todo: Allow passing a string to indicate the transport to load
todo: Allow passing in optional options for the transport to load

getEncodingOfHeaders
jump to class

getEncodingOfHeaders(
          
          )
        
        :
        string

Return encoding of mail headers

Output

string

Details

visibility: public
final: false
static: false
deprecated: use {@link getHeaderEncoding()} instead

getFrom
jump to class

getFrom(
          
          )
        
        :
        string

Returns the sender of the mail

Output

string

Details

visibility: public
final: false
static: false

getHeaderEncoding
jump to class

getHeaderEncoding(
          
          )
        
        :
        string

Return the encoding of mail headers

Either Zend_Mime::ENCODING_QUOTEDPRINTABLE or Zend_Mime::ENCODING_BASE64

Output

string

Details

visibility: public
final: false
static: false

getHeaders
jump to class

getHeaders(
          
          )
        
        :
        void

Return mail headers

Details

visibility: public
final: false
static: false

getMessageId
jump to class

getMessageId(
          
          )
        
        :
        string

Returns the Message-ID of the message

Output

string

Details

visibility: public
final: false
static: false

getMimeBoundary
jump to class

getMimeBoundary(
          
          )
        
        :
        string

Return the boundary string used for the message

Output

string

Details

visibility: public
final: false
static: false

getPartCount
jump to class

getPartCount(
          
          )
        
        :
        integer

Return a count of message parts

Output

integer

Details

visibility: public
final: false
static: false

getRecipients
jump to class

getRecipients(
          
          )
        
        :
        array

Return list of recipient email addresses

Output

array: (of strings)

Details

visibility: public
final: false
static: false

getReplyTo
jump to class

getReplyTo(
          
          )
        
        :
        string|null

Returns the current Reply-To address of the message

Output

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

Details

visibility: public
final: false
static: false

getReturnPath
jump to class

getReturnPath(
          
          )
        
        :
        string

Returns the current Return-Path address of the message

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

Output

string

Details

visibility: public
final: false
static: false

getSubject
jump to class

getSubject(
          
          )
        
        :
        string

Returns the encoded subject of the message

Output

string

Details

visibility: public
final: false
static: false

getType
jump to class

getType(
          
          )
        
        :
        string

Get content type of the message

Output

string

Details

visibility: public
final: false
static: false

send
jump to class

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.

Arguments

$transport: Zend_Mail_Transport_Abstract

Output

Zend_Mail: Provides fluent interface

Details

visibility: public
final: false
static: false

setBodyHtml
jump to class

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

Sets the HTML body for the message

Arguments

$html: string
$charset: string
$encoding: string

Output

Zend_Mail: Provides fluent interface

Details

visibility: public
final: false
static: false

setBodyText
jump to class

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

Sets the text body for the message.

Arguments

$txt: string
$charset: string
$encoding: string

Output

Zend_Mail: Provides fluent interface

Details

visibility: public
final: false
static: false

setDate
jump to class

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

Sets Date-header

Arguments

$date: timestampstringZend_Date

Output

Zend_Mail: Provides fluent interface

Details

visibility: public
final: false
static: false
throws: if called subsequent times or wrong date format.

setDefaultFrom
jump to class

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

Sets Default From-email and name of the message

Arguments

$email: string
$name: string
Optional $name

Details

visibility: public
final: false
static: true

setDefaultReplyTo
jump to class

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

Sets Default ReplyTo-address and -name of the message

Arguments

$email: string
$name: string
Optional $name

Details

visibility: public
final: false
static: true

setDefaultTransport
jump to class

setDefaultTransport(
          Zend_Mail_Transport_Abstract $transport
          )
        
        :

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

Arguments

$transport: Zend_Mail_Transport_Abstract

Details

visibility: public
final: false
static: true
todo: Allow passing a string to indicate the transport to load
todo: Allow passing in optional options for the transport to load

setEncodingOfHeaders
jump to class

setEncodingOfHeaders(
          string $encoding
          )
        
        :
        Zend_Mail

Set the encoding of mail headers

Arguments

$encoding: string

Output

Zend_Mail

Details

visibility: public
final: false
static: false
deprecated: Use {@link setHeaderEncoding()} instead.

setFrom
jump to class

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

Sets From-header and sender of the message

Arguments

$email: string
$name: string

Output

Zend_Mail: Provides fluent interface

Details

visibility: public
final: false
static: false
throws: if called subsequent times

setFromToDefaultFrom
jump to class

setFromToDefaultFrom(
          
          )
        
        :
        Zend_Mail

Sets From-name and -email based on the defaults

Output

Zend_Mail: Provides fluent interface

Details

visibility: public
final: false
static: false

setHeaderEncoding
jump to class

setHeaderEncoding(
          string $encoding
          )
        
        :
        Zend_Mail

Set the encoding of mail headers

Arguments

$encoding: string
Zend_Mime::ENCODING_QUOTEDPRINTABLE or Zend_Mime::ENCODING_BASE64

Output

Zend_Mail: Provides fluent interface

Details

visibility: public
final: false
static: false

setMessageId
jump to class

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

Sets the Message-ID of the message

Arguments

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

Output

Zend_Mail: Provides fluent interface

Details

visibility: public
final: false
static: false
throws

setMimeBoundary
jump to class

setMimeBoundary(
          string $boundary
          )
        
        :
        Zend_Mail

Set an arbitrary mime boundary for the message

If not set, Zend_Mime will generate one.

Arguments

$boundary: string

Output

Zend_Mail: Provides fluent interface

Details

visibility: public
final: false
static: false

setReplyTo
jump to class

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

Set Reply-To Header

Arguments

$email: string
$name: string

Output

Zend_Mail

Details

visibility: public
final: false
static: false
throws: if called more than one time

setReplyToFromDefault
jump to class

setReplyToFromDefault(
          
          )
        
        :
        Zend_Mail

Sets ReplyTo-name and -email based on the defaults

Output

Zend_Mail: Provides fluent interface

Details

visibility: public
final: false
static: false

setReturnPath
jump to class

setReturnPath(
          string $email
          )
        
        :
        Zend_Mail

Sets the Return-Path header of the message

Arguments

$email: string

Output

Zend_Mail: Provides fluent interface

Details

visibility: public
final: false
static: false
throws: if set multiple times

setSubject
jump to class

setSubject(
          string $subject
          )
        
        :
        Zend_Mail

Sets the subject of the message

Arguments

$subject: string

Output

Zend_Mail: Provides fluent interface

Details

visibility: public
final: false
static: false
throws

setType
jump to class

setType(
          string $type
          )
        
        :
        Zend_Mail

Set content type

Should only be used for manually setting multipart content types.

Arguments

$type: string
Content type

Output

Zend_Mail: Implements fluent interface

Details

visibility: public
final: false
static: false
throws: for types not supported by Zend_Mime

API Documentation

Mail.php

Description

Zend_Mailjump to top

Description

Properties

$_bodyHtmljump to class

Details

$_bodyTextjump to class

Details

$_charsetjump to class

Details

$_datejump to class

Details

$_defaultFromjump to class

Details

$_defaultReplyTojump to class

Details

$_defaultTransportjump to class

Details

$_fromjump to class

Details

$_headerEncodingjump to class

Details

$_headersjump to class

Details

$_messageIdjump to class

Details

$_mimeBoundaryjump to class

Details

$_recipientsjump to class

Details

$_replyTojump to class

Details

$_returnPathjump to class

Details

$_subjectjump to class

Details

$_tojump to class

Details

$_typejump to class

Details

$hasAttachmentsjump to class

Details

Methods

__constructjump to class

Arguments

Details

_addRecipientAndHeaderjump to class

Arguments

Details

_clearHeaderjump to class

Arguments

Details

_encodeHeaderjump to class

Arguments

Output

Details

_filterEmailjump to class

Arguments

Output

Details

_filterNamejump to class

Arguments

Output

Details

_filterOtherjump to class

Arguments

Output

Details

_formatAddressjump to class

Arguments

Output

Details

_storeHeaderjump to class

Arguments

Details

addAttachmentjump to class

Arguments

Output

Zend_Mail
jump to top

$_bodyHtml
jump to class

$_bodyText
jump to class

$_charset
jump to class

$_date
jump to class

$_defaultFrom
jump to class

$_defaultReplyTo
jump to class

$_defaultTransport
jump to class

$_from
jump to class

$_headerEncoding
jump to class

$_headers
jump to class

$_messageId
jump to class

$_mimeBoundary
jump to class

$_recipients
jump to class

$_replyTo
jump to class

$_returnPath
jump to class

$_subject
jump to class

$_to
jump to class

$_type
jump to class

$hasAttachments
jump to class

__construct
jump to class

_addRecipientAndHeader
jump to class

_clearHeader
jump to class

_encodeHeader
jump to class

_filterEmail
jump to class

_filterName
jump to class

_filterOther
jump to class

_formatAddress
jump to class

_storeHeader
jump to class

addAttachment
jump to class

addBcc
jump to class

addCc
jump to class

addHeader
jump to class

addTo
jump to class

clearDate
jump to class

clearDefaultFrom
jump to class

clearDefaultReplyTo
jump to class

clearDefaultTransport
jump to class

clearFrom
jump to class

clearMessageId
jump to class

clearRecipients
jump to class

clearReplyTo
jump to class

clearReturnPath
jump to class

clearSubject
jump to class

createAttachment
jump to class

createMessageId
jump to class

getBodyHtml
jump to class

getBodyText
jump to class

getCharset
jump to class

getDate
jump to class

getDefaultFrom
jump to class

getDefaultReplyTo
jump to class