Class for sending an email.
category | Zend |
---|---|
package | Zend_Mail |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
inherited_from | \Zend_Mime_Message |
__construct(string $charset = null
) : void
string
addAttachment(\Zend_Mime_Part $attachment) : \Zend_Mail
\Zend_Mime_Part
\Zend_Mail
Provides fluent interfaceaddBcc(string|array $email) : \Zend_Mail
string
array
\Zend_Mail
Provides fluent interfaceaddCc(string|array $email, string $name = ''
) : \Zend_Mail
string
array
string
\Zend_Mail
Provides fluent interfaceaddHeader(string $name, string $value, boolean $append = false
) : \Zend_Mail
string
string
boolean
\Zend_Mail_Exception |
on attempts to create standard headers |
---|
\Zend_Mail
Provides fluent interfaceaddPart(\Zend_Mime_Part $part)
\Zend_Mime_Part
addTo(string|array $email, string $name = ''
) : \Zend_Mail
string
array
string
\Zend_Mail
Provides fluent interfaceclearDate() : \Zend_Mail
\Zend_Mail
Provides fluent interfaceclearDefaultFrom() : void
clearDefaultReplyTo() : void
clearDefaultTransport()
clearFrom() : \Zend_Mail
\Zend_Mail
Provides fluent interfaceclearHeader(string $headerName) : \Zend_Mail
string
\Zend_Mail
Provides fluent interclearMessageId() : \Zend_Mail
\Zend_Mail
Provides fluent interfaceclearRecipients() : \Zend_Mail
\Zend_Mail
Provides fluent interfaceclearReplyTo() : \Zend_Mail
\Zend_Mail
Provides fluent interfaceclearReturnPath() : \Zend_Mail
\Zend_Mail
Provides fluent interfaceclearSubject() : \Zend_Mail
\Zend_Mail
Provides fluent interfacecreateAttachment(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
Attachment is automatically added to the mail object after creation. The attachment object is returned to allow for further manipulation.
string
string
string
string
string
OPTIONAL A filename for the attachment
\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
string
string
string
EOL string; defaults to {@link Zend_Mime::LINEEND}
\Zend_Exception |
---|
\Zend_Mime_Message
createMessageId() : string
string
generateMessage(string $EOL = \Zend_Mime::LINEEND
) : string
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.
string
EOL string; defaults to {@link Zend_Mime::LINEEND}
string
getBodyHtml(boolean $htmlOnly = false
) : false | \Zend_Mime_Part | string
boolean
Whether to return the body HTML only, or the MIME part; defaults to false, the MIME part
false
\Zend_Mime_Part
string
getBodyText($textOnly = false
) : false | \Zend_Mime_Part | string
false
\Zend_Mime_Part
string
getCharset() : string
string
getDate() : string
string
getDefaultFrom() : null | array
null
array
Null if none was set.getDefaultReplyTo() : null | array
null
array
Null if none was set.getDefaultTransport()
todo | Allow passing a string to indicate the transport to load |
---|---|
todo | Allow passing in optional options for the transport to load |
getEncodingOfHeaders() : string
deprecated | use {@link getHeaderEncoding()} instead |
---|
string
getFrom() : string
string
getHeaderEncoding() : string
Either Zend_Mime::ENCODING_QUOTEDPRINTABLE or Zend_Mime::ENCODING_BASE64
string
getHeaders() : void
getMessageId() : string
string
getMime() : \Zend_Mime
If the object was not present, it is created and returned. Can be used to determine the boundary used in this message.
\Zend_Mime
getMimeBoundary() : string
string
getPartContent(integer $partnum, string $EOL = \Zend_Mime::LINEEND
) : string
integer
string
string
getPartCount() : integer
integer
getPartHeaders(integer $partnum, string $EOL = \Zend_Mime::LINEEND
) : string
integer
string
string
getPartHeadersArray(integer $partnum) : array
integer
array
getParts() : array
array
of Zend_Mime_PartgetRecipients() : array
array
(of strings)getReplyTo() : string | null
string
null
Reply-To address, null when not setgetReturnPath() : string
If no Return-Path header is set, returns the value of \$_from.
string
getSubject() : string
string
getType() : string
string
isMultiPart() : boolean
boolean
send(\Zend_Mail_Transport_Abstract $transport = null
) : \Zend_Mail
\Zend_Mail_Transport_Abstract
\Zend_Mail
Provides fluent interfacesetBodyHtml(string $html, string $charset= null
, string $encoding= \Zend_Mime::ENCODING_QUOTEDPRINTABLE
) : \Zend_Mail
string
string
string
\Zend_Mail
Provides fluent interfacesetBodyText(string $txt, string $charset= null
, string $encoding= \Zend_Mime::ENCODING_QUOTEDPRINTABLE
) : \Zend_Mail
string
string
string
\Zend_Mail
Provides fluent interfacesetDate(\timestamp|string|\Zend_Date $date = null
) : \Zend_Mail
\timestamp
string
\Zend_Date
\Zend_Mail_Exception |
if called subsequent times or wrong date format. |
---|
\Zend_Mail
Provides fluent interfacesetDefaultFrom(string $email, $name = null
) : void
string
setDefaultReplyTo(string $email, $name = null
) : void
string
setDefaultTransport(\Zend_Mail_Transport_Abstract $transport)
todo | Allow passing a string to indicate the transport to load |
---|---|
todo | Allow passing in optional options for the transport to load |
\Zend_Mail_Transport_Abstract
setEncodingOfHeaders(string $encoding) : \Zend_Mail
deprecated | Use {@link setHeaderEncoding()} instead. |
---|
string
\Zend_Mail
setFrom(string $email, string $name = null
) : \Zend_Mail
string
string
\Zend_Mail_Exception |
if called subsequent times |
---|
\Zend_Mail
Provides fluent interfacesetFromToDefaultFrom() : \Zend_Mail
\Zend_Mail
Provides fluent interfacesetHeaderEncoding(string $encoding) : \Zend_Mail
string
Zend_Mime::ENCODING_QUOTEDPRINTABLE or Zend_Mime::ENCODING_BASE64
\Zend_Mail
Provides fluent interfacesetMessageId(boolean|string $id = true
) : \Zend_Mail
boolean
string
true :Auto false :No set null :No set string:Sets given string (Angle brackets is not necessary)
\Zend_Mail_Exception |
---|
\Zend_Mail
Provides fluent interfacesetMime(\Zend_Mime $mime)
This can be used to set the boundary specifically or to use a subclass of Zend_Mime for generating the boundary.
\Zend_Mime
setMimeBoundary(string $boundary) : \Zend_Mail
If not set, Zend_Mime will generate one.
string
\Zend_Mail
Provides fluent interfacesetParts(array $parts)
array
setReplyTo(string $email, string $name = null
) : \Zend_Mail
string
string
\Zend_Mail_Exception |
if called more than one time |
---|
\Zend_Mail
setReplyToFromDefault() : \Zend_Mail
\Zend_Mail
Provides fluent interfacesetReturnPath(string $email) : \Zend_Mail
string
\Zend_Mail_Exception |
if set multiple times |
---|
\Zend_Mail
Provides fluent interfacesetSubject(string $subject) : \Zend_Mail
string
\Zend_Mail_Exception |
---|
\Zend_Mail
Provides fluent interfacesetType(string $type) : \Zend_Mail
Should only be used for manually setting multipart content types.
string
Content type
\Zend_Mail_Exception |
for types not supported by Zend_Mime |
---|
\Zend_Mail
Implements fluent interface_addRecipientAndHeader(string $headerName, string $email, string $name)
string
string
string
_clearHeader(string $headerName)
deprecated | use public method directly |
---|
string
_disassembleMime(string $body, string $boundary) : array
Parts consist of the header and the body of each MIME part.
string
string
\Zend_Exception |
---|
array
_encodeHeader(string $value) : string
Encodes header content according to RFC1522 if it contains non-printable characters.
string
string
_filterEmail(string $email) : string
string
string
_filterName(string $name) : string
string
string
_filterOther(string $data) : string
string
string
_formatAddress(string $email, string $name) : string
string
string
string
_storeHeader(string $headerName, string $value, boolean $append = false
)
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.
string
string
boolean
$hasAttachments : boolean
false
$_bodyHtml : false | \Zend_Mime_Part
false
$_bodyText : false | \Zend_Mime_Part
false
$_charset : string
'iso-8859-1'
$_date : string
null
$_defaultFrom : array
static |
---|
$_defaultReplyTo : array
static |
---|
$_defaultTransport : \Zend_Mail_Transport_Abstract
null
static |
---|
$_from : string
null
$_headerEncoding : string
\Zend_Mime::ENCODING_QUOTEDPRINTABLE
$_headers : array
array()
$_mime : \Zend_Mime | null
null
$_mimeBoundary : string
null
$_parts : array
array()
$_recipients : array
array()
$_replyTo : string
null
$_returnPath : string
null
$_subject : string
null
$_to : array
array()
$_type : string
null