• Página Inicial
• Pimcore
• Mail

PHP Class Pimcore\Mail

Exibir arquivo Open project: pimcore/pimcore Class Usage Examples

Public Properties

Property	Type	Description
$forcePimcoreMode	boolean	forces the mail class to always us the "Pimcore Mode", so you don't have to set the charset every time when you create new Pimcore_Mail instance

Protected Properties

Property	Type	Description
$debugEmailAddresses	array	Contains the debug email addresses from settings -> system -> Email Settings -> Debug email addresses
$document	Pimcore\Model\Document\Email	Contains the email document
$enableLayoutOnPlaceholderRendering	boolean	if true - the layout is enabled when document is rendered to a string
$hostUrl	null	if $hostUrl is set - this url well be used to create absolute urls otherwise it is determined automatically
$html2textBinaryEnabled	boolean	use html2text from mbayer if it is installed (http://www.mbayer.de/html2text/)
$html2textInstalled	boolean	html2text from mbayer is installed (http://www.mbayer.de/html2text/)
$html2textOptions	string	Options passed to html2text
$ignoreDebugMode	boolean	if true - the Pimcore debug mode is ignored
$loggingEnable	boolean	If true - emails are logged in the database and on the file-system
$params	array	Contains the dynamic Params for the Placeholders
$placeholderObject		Pimcore_Placeholder
$preventDebugInformationAppending	boolean	Prevent adding debug information
$recipientsCleared	boolean
$temporaryStorage	array	Contains data that has to be stored temporary e.g. email receivers for logging

Public Methods

Method	Description
__construct ( null $charset = null )
addBcc ( string | array $email ) : Mail	Adds Bcc recipient, $email can be an array, or a single string address Additionally adds recipients to temporary storage
addCc ( string | array $email, string $name = '' ) : Pimcore_Mail	Adds Cc-header and recipient, $email can be an array, or a single string address Additionally adds recipients to temporary storage
addTo ( string | array $email, string $name = '' ) : Mail	Adds To-header and recipient, $email can be an array, or a single string address Additionally adds recipients to temporary storage
clearRecipients ( ) : Mail	Clears list of recipient email addresses and resets the temporary storage
determineHtml2TextIsInstalled ( ) : boolean	Determines if mbayer html2text is installed (more information at http://www.mbayer.de/html2text/) and uses it to automatically create a text version of the html email
disableLogging ( ) : Mail	Disables email logging
enableHtml2textBinary ( )
enableLogging ( ) : Mail	Enables email logging (by default it's enabled)
getBodyHtmlRendered ( ) : string | null	Replaces the placeholders with the content and returns the rendered Html
getBodyTextRendered ( ) : string	Replaces the placeholders with the content and returns the rendered text if a text was set with "$mail->setBodyText()" *
getDocument ( ) : Email	Returns the Document
getEnableLayoutOnPlaceholderRendering ( ) : boolean
getHostUrl ( ) : null
getHtml2TextBinaryEnabled ( ) : boolean
getHtml2TextOptions ( ) : string	Returns options for html2text
getHtml2textInstalled ( ) : boolean
getIgnoreDebugMode ( ) : boolean	Checks if the Debug mode is ignored
getParam ( string | integer $key ) : mixed	Returns a parameter which was set with "setParams" or "setParam"
getParams ( ) : array	Returns the parameters which were set with "setParams" or "setParam"
getSubjectRendered ( ) : string	Replaces the placeholders with the content and returns the rendered Subject
getTemporaryStorage ( ) : array	Returns the temporary storage
init ( $type = "email" ) : void	Initializes the mailer with the settings form Settings -> System -> Email Settings
isValidEmailAddress ( $emailAddress ) : boolean	Static helper to validate a email address
loggingIsEnabled ( ) : boolean	returns the logging status
preventDebugInformationAppending ( ) : Mail	Prevents appending of debug information (used for resending emails)
send ( Zend_Mail_Transport_Abstract $transport = null ) : Mail	Sends this email using the given transport or with the settings from "Settings" -> "System" -> "Email Settings"
sendWithoutRendering ( null $transport = null ) : Zend_Mail	sends mail without (re)rendering the content.
setDocument ( $document )
setEnableLayoutOnPlaceholderRendering ( $value )
setFrom ( string $email, null $name = null ) : Zend_Mail
setHostUrl ( $url )
setHtml2TextOptions ( string $options = '' ) : Mail	Sets options that are passed to html2text
setIgnoreDebugMode ( $value )
setParam ( string | integer $key, mixed $value ) : Mail	Sets a single parameter for the email view and the Placeholders
setParams ( array $params ) : Mail	Sets the parameters for the email view and the Placeholders
setSender ( string $email ) : Zend_Mail	Sets From-header and sender of the message
setTo ( $email, $name = '' )
unsetParam ( string | integer $key ) : Mail	Deletes a single parameter which was set with "setParams" or "setParam"
unsetParams ( array $params ) : Mail	Deletes parameters which were set with "setParams" or "setParam"

Protected Methods

Method	Description
addToTemporaryStorage ( string $key, string | array $email, string $name )	Helper to add receivers to the temporary storage
checkDebugMode ( )
html2Text ( $htmlContent ) : string
setDocumentSettings ( ) : Mail	Sets the settings which are defined in the Document Settings (from,to,cc,bcc)

Method Details

Property Details