Property | Type | Description | |
---|---|---|---|
$hasAttachments | boolean | Flag: whether or not email has attachments |
Property | Type | Description | |
---|---|---|---|
$_bodyHtml | false | Zend_Mime_Part | text/html MIME part | |
$_bodyText | false | Zend_Mime_Part | text/plain MIME part | |
$_charset | string | Mail character set | |
$_date | string | Date: header | |
$_defaultFrom | array | ||
$_defaultReplyTo | array | ||
$_defaultTransport | Zend_Mail_Transport_Abstract | ||
$_from | string | From: address | |
$_headerEncoding | string | Encoding of Mail headers | |
$_headers | array | Mail headers | |
$_messageId | string | Message-ID: header | |
$_mimeBoundary | string | MIME boundary string | |
$_recipients | array | Array of all recipients | |
$_replyTo | string | Reply-To header | |
$_returnPath | string | Return-Path header | |
$_subject | string | Subject: header | |
$_to | array | To: addresses | |
$_type | string | Content type of the message |
Method | Description | |
---|---|---|
__construct ( string $charset = null ) | Public constructor | |
addAttachment ( Zend_Mime_Part $attachment ) : Zend_Mail | Adds an existing attachment to the mail message | |
addBcc ( string | array $email ) : Zend_Mail | Adds Bcc recipient, $email can be an array, or a single string address | |
addCc ( string | array $email, string $name = '' ) : Zend_Mail | Adds Cc-header and recipient, $email can be an array, or a single string address | |
addHeader ( string $name, string $value, boolean $append = false ) : Zend_Mail | Add a custom header to the message | |
addTo ( string | array $email, string $name = '' ) : Zend_Mail | Adds To-header and recipient, $email can be an array, or a single string address | |
clearDate ( ) : Zend_Mail | Clears the formatted date from the message | |
clearDefaultFrom ( ) : void | Clears the default sender from the mail | |
clearDefaultReplyTo ( ) : void | Clears the default ReplyTo-address and -name from the mail | |
clearDefaultTransport ( ) | Clear the default transport property | |
clearFrom ( ) : Zend_Mail | Clears the sender from the mail | |
clearHeader ( string $headerName ) : Zend_Mail | Clear header from the message | |
clearMessageId ( ) : Zend_Mail | Clears the Message-ID from the message | |
clearRecipients ( ) : Zend_Mail | Clears list of recipient email addresses | |
clearReplyTo ( ) : Zend_Mail | Clears the current Reply-To address from the message | |
clearReturnPath ( ) : Zend_Mail | Clears the current Return-Path address from the message | |
clearSubject ( ) : Zend_Mail | Clears the encoded subject from the message | |
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 | |
createMessageId ( ) : string | Creates the Message-ID | |
getBodyHtml ( boolean $htmlOnly = false ) : false | Zend_Mime_Part | string | Return Zend_Mime_Part representing body HTML | |
getBodyText ( boolean $textOnly = false ) : false | Zend_Mime_Part | string | Return text body Zend_Mime_Part or string | |
getCharset ( ) : string | Return charset string | |
getDate ( ) : string | Returns the formatted date of the message | |
getDefaultFrom ( ) : null | array | Returns the default sender of the mail | |
getDefaultReplyTo ( ) : null | array | Returns the default Reply-To Address and Name of the mail | |
getDefaultTransport ( ) | Gets the default mail transport for all following uses of unittests | |
getEncodingOfHeaders ( ) : string | Return encoding of mail headers | |
getFrom ( ) : string | Returns the sender of the mail | |
getHeaderEncoding ( ) : string | Return the encoding of mail headers | |
getHeaders ( ) : array | Return mail headers | |
getMessageId ( ) : string | Returns the Message-ID of the message | |
getMimeBoundary ( ) : string | Return the boundary string used for the message | |
getPartCount ( ) : integer | Return a count of message parts | |
getRecipients ( ) : array | Return list of recipient email addresses | |
getReplyTo ( ) : string | null | Returns the current Reply-To address of the message | |
getReturnPath ( ) : string | Returns the current Return-Path address of the message | |
getSubject ( ) : string | Returns the encoded subject of the message | |
getType ( ) : string | Get content type of the message | |
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. | |
setBodyHtml ( string $html, string $charset = null, string $encoding = Zend_Mime::ENCODING_QUOTEDPRINTABLE ) : Zend_Mail | Sets the HTML body for the message | |
setBodyText ( string $txt, string $charset = null, string $encoding = Zend_Mime::ENCODING_QUOTEDPRINTABLE ) : Zend_Mail | Sets the text body for the message. | |
setDate ( integer | string | Zend_Date $date = null ) : Zend_Mail | Sets Date-header | |
setDefaultFrom ( string $email, string $name = null ) : void | Sets Default From-email and name of the message | |
setDefaultReplyTo ( string $email, string $name = null ) : void | Sets Default ReplyTo-address and -name of the message | |
setDefaultTransport ( Zend_Mail_Transport_Abstract $transport ) | Sets the default mail transport for all following uses of Zend_Mail::send(); | |
setEncodingOfHeaders ( string $encoding ) : Zend_Mail | Set the encoding of mail headers | |
setFrom ( string $email, string $name = null ) : Zend_Mail | Sets From-header and sender of the message | |
setFromToDefaultFrom ( ) : Zend_Mail | Sets From-name and -email based on the defaults | |
setHeaderEncoding ( string $encoding ) : Zend_Mail | Set the encoding of mail headers | |
setMessageId ( boolean | string $id = true ) : Zend_Mail | Sets the Message-ID of the message | |
setMimeBoundary ( string $boundary ) : Zend_Mail | Set an arbitrary mime boundary for the message | |
setReplyTo ( string $email, string $name = null ) : Zend_Mail | Set Reply-To Header | |
setReplyToFromDefault ( ) : Zend_Mail | Sets ReplyTo-name and -email based on the defaults | |
setReturnPath ( string $email ) : Zend_Mail | Sets the Return-Path header of the message | |
setSubject ( string $subject ) : Zend_Mail | Sets the subject of the message | |
setType ( string $type ) : Zend_Mail | Set content type |
Method | Description | |
---|---|---|
_addRecipientAndHeader ( string $headerName, string $email, string $name ) | Helper function for adding a recipient and the corresponding header | |
_clearHeader ( string $headerName ) | Clear header from the message | |
_encodeHeader ( string $value ) : string | Encode header fields | |
_filterEmail ( string $email ) : string | Filter of email data | |
_filterName ( string $name ) : string | Filter of name data | |
_filterOther ( string $data ) : string | Filter of other data | |
_formatAddress ( string $email, string $name ) : string | Formats e-mail address | |
_storeHeader ( string $headerName, string $value, boolean $append = false ) | Add a header to the message |
public __construct ( string $charset = null ) | ||
$charset | string |
protected _clearHeader ( string $headerName ) | ||
$headerName | string |
protected _encodeHeader ( string $value ) : string | ||
$value | string | |
return | string |
protected _filterEmail ( string $email ) : string | ||
string | ||
return | string |
protected _filterName ( string $name ) : string | ||
$name | string | |
return | string |
protected _filterOther ( string $data ) : string | ||
$data | string | |
return | string |
public addAttachment ( Zend_Mime_Part $attachment ) : Zend_Mail | ||
$attachment | Zend_Mime_Part | |
return | Zend_Mail | Provides fluent interface |
public clearDate ( ) : Zend_Mail | ||
return | Zend_Mail | Provides fluent interface |
public static clearDefaultFrom ( ) : void | ||
return | void |
public static clearDefaultReplyTo ( ) : void | ||
return | void |
public static clearDefaultTransport ( ) |
public clearFrom ( ) : Zend_Mail | ||
return | Zend_Mail | Provides fluent interface |
public clearHeader ( string $headerName ) : Zend_Mail | ||
$headerName | string | |
return | Zend_Mail | Provides fluent inter |
public clearMessageId ( ) : Zend_Mail | ||
return | Zend_Mail | Provides fluent interface |
public clearRecipients ( ) : Zend_Mail | ||
return | Zend_Mail | Provides fluent interface |
public clearReplyTo ( ) : Zend_Mail | ||
return | Zend_Mail | Provides fluent interface |
public clearReturnPath ( ) : Zend_Mail | ||
return | Zend_Mail | Provides fluent interface |
public clearSubject ( ) : Zend_Mail | ||
return | Zend_Mail | Provides fluent interface |
public 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 | ||
$body | string | |
$mimeType | string | |
$disposition | string | |
$encoding | string | |
$filename | string | OPTIONAL A filename for the attachment |
return | Zend_Mime_Part | Newly created Zend_Mime_Part object (to allow advanced settings) |
public createMessageId ( ) : string | ||
return | string |
public getBodyHtml ( boolean $htmlOnly = false ) : false | Zend_Mime_Part | string | ||
$htmlOnly | boolean | Whether to return the body HTML only, or the MIME part; defaults to false, the MIME part |
return | false | Zend_Mime_Part | string |
public getBodyText ( boolean $textOnly = false ) : false | Zend_Mime_Part | string | ||
$textOnly | boolean | Whether to return just the body text content or the MIME part; defaults to false, the MIME part |
return | false | Zend_Mime_Part | string |
public static getDefaultFrom ( ) : null | array | ||
return | null | array | Null if none was set. |
public static getDefaultReplyTo ( ) : null | array | ||
return | null | array | Null if none was set. |
public static getDefaultTransport ( ) |
public getEncodingOfHeaders ( ) : string | ||
return | string |
public getHeaderEncoding ( ) : string | ||
return | string |
public getMessageId ( ) : string | ||
return | string |
public getMimeBoundary ( ) : string | ||
return | string |
public getPartCount ( ) : integer | ||
return | integer |
public getRecipients ( ) : array | ||
return | array | (of strings) |
public getReplyTo ( ) : string | null | ||
return | string | null | Reply-To address, null when not set |
public getReturnPath ( ) : string | ||
return | string |
public getSubject ( ) : string | ||
return | string |
public send ( Zend_Mail_Transport_Abstract $transport = null ) : Zend_Mail | ||
$transport | Zend_Mail_Transport_Abstract | |
return | Zend_Mail | Provides fluent interface |
public static setDefaultTransport ( Zend_Mail_Transport_Abstract $transport ) | ||
$transport | Zend_Mail_Transport_Abstract |
public setEncodingOfHeaders ( string $encoding ) : Zend_Mail | ||
$encoding | string | |
return | Zend_Mail |
public setFromToDefaultFrom ( ) : Zend_Mail | ||
return | Zend_Mail | Provides fluent interface |
public setHeaderEncoding ( string $encoding ) : Zend_Mail | ||
$encoding | string | Zend_Mime::ENCODING_QUOTEDPRINTABLE or Zend_Mime::ENCODING_BASE64 |
return | Zend_Mail | Provides fluent interface |
public setMessageId ( boolean | string $id = true ) : Zend_Mail | ||
$id | boolean | string | true :Auto false :No set null :No set string:Sets given string (Angle brackets is not necessary) |
return | Zend_Mail | Provides fluent interface |
public setMimeBoundary ( string $boundary ) : Zend_Mail | ||
$boundary | string | |
return | Zend_Mail | Provides fluent interface |
public setReplyTo ( string $email, string $name = null ) : Zend_Mail | ||
string | ||
$name | string | |
return | Zend_Mail |
public setReplyToFromDefault ( ) : Zend_Mail | ||
return | Zend_Mail | Provides fluent interface |
public setReturnPath ( string $email ) : Zend_Mail | ||
string | ||
return | Zend_Mail | Provides fluent interface |
public setSubject ( string $subject ) : Zend_Mail | ||
$subject | string | |
return | Zend_Mail | Provides fluent interface |
protected false|Zend_Mime_Part $_bodyHtml | ||
return | false | Zend_Mime_Part |
protected false|Zend_Mime_Part $_bodyText | ||
return | false | Zend_Mime_Part |
protected static Zend_Mail_Transport_Abstract $_defaultTransport | ||
return | Zend_Mail_Transport_Abstract |
protected string $_headerEncoding | ||
return | string |
protected string $_mimeBoundary | ||
return | string |
public bool $hasAttachments | ||
return | boolean |