1. class
  2. Pimcore
  3. \
  4. Mail

Mail

class Mail extends Swift_Message (View source)

Properties

static protected bool $forceDebugMode
static protected array $debugEmailAddresses Contains the debug email addresses from settings -> system -> Email Settings -> Debug email addresses
protected Placeholder $placeholderObject
protected bool $loggingEnable If true - emails are logged in the database and on the file-system
protected Email $document Contains the email document
protected array $params Contains the dynamic Params for the Placeholders
static protected bool $html2textInstalled html2text from mbayer is installed (http://www.mbayer.de/html2text/)
protected string $html2textOptions Options passed to html2text
protected bool $html2textBinaryEnabled use html2text from mbayer if it is installed (http://www.mbayer.de/html2text/)
protected bool $preventDebugInformationAppending Prevent adding debug information
protected bool $ignoreDebugMode if true - the Pimcore debug mode is ignored
protected bool $enableLayoutOnPlaceholderRendering if true - the layout is enabled when document is rendered to a string
static bool $forcePimcoreMode 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 null $hostUrl if $hostUrl is set - this url well be used to create absolute urls otherwise it is determined automatically
protected bool $recipientsCleared if true: prevent setting the recipients from the Document - set in $this->clearRecipients()
protected string $bodyText body plain text
protected Swift_MimePart $bodyTextMimePart plain text mime part this is created and attached to mail on send
protected array $originalData place to store original data before modifying message when sending in debug mode
protected Log $lastLogEntry

Methods

$this
setHostUrl($url)

No description

null
getHostUrl()

No description

__construct(null $subject = null, null $body = null, null $contentType = null, null $charset = null)

Mail constructor.

init(string $type = 'email')

Initializes the mailer with the settings form Settings -> System -> Email Settings

$this
setIgnoreDebugMode($value)

No description

bool
getIgnoreDebugMode()

Checks if the Debug mode is ignored

bool
doRedirectMailsToDebugMailAddresses()

returns if redirecting to debug mail addresses should take place when sending the mail

$this
setEnableLayoutOnPlaceholderRendering($value)

No description

bool
getEnableLayoutOnPlaceholderRendering()

No description

static bool
determineHtml2TextIsInstalled()

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

Mail
setHtml2TextOptions(string $options = '')

Sets options that are passed to html2text

string
getHtml2TextOptions()

Returns options for html2text

Mail
clearRecipients()

Clears list of recipient email addresses

Mail
disableLogging()

Disables email logging

Mail
enableLogging()

Enables email logging (by default it's enabled)

bool
loggingIsEnabled()

returns the logging status

Mail
setParams(array $params)

Sets the parameters for the email view and the Placeholders

Mail
setParam(string $key, mixed $value)

Sets a single parameter for the email view and the Placeholders

array
getParams()

Returns the parameters which were set with "setParams" or "setParam"

mixed
getParam(string $key)

Returns a parameter which was set with "setParams" or "setParam"

static 
setForceDebugMode(bool $value)

Forces the debug mode - useful for cli-script which should not send emails to recipients

Mail
unsetParams(array $params)

Deletes parameters which were set with "setParams" or "setParam"

Mail
unsetParam(string $key)

Deletes a single parameter which was set with "setParams" or "setParam"

Mail
setDocumentSettings()

Sets the settings which are defined in the Document Settings (from,to,cc,bcc,replyTo)

Mail
send(Swift_Mailer $mailer = null)

Sends this email using the given transport or with the settings from "Settings" -> "System" -> "Email Settings"

Mail
sendWithoutRendering(Swift_Mailer $mailer = null)

sends mail without (re)rendering the content.

static bool
isValidEmailAddress($emailAddress)

Static helper to validate a email address

string
getSubjectRendered()

Replaces the placeholders with the content and returns the rendered Subject

string|null
getBodyHtmlRendered()

Replaces the placeholders with the content and returns the rendered Html

string
getBodyTextRendered()

Replaces the placeholders with the content and returns the rendered text if a text was set with "$mail->setBodyText()"

$this
setDocument($document)

No description

Email
getDocument()

Returns the Document

Mail
preventDebugInformationAppending()

Prevents appending of debug information (used for resending emails)

bool
isPreventingDebugInformationAppending()

Returns, if debug information is not added

bool
getHtml2TextBinaryEnabled()

No description

$this
enableHtml2textBinary()

No description

static bool
getHtml2textInstalled()

No description

string
html2Text($htmlContent)

No description

string
getBodyText()

No description

$this
setBodyText($bodyText)

No description

Mail
setBodyHtml($body)

No description

Swift_MimePart
getBodyTextMimePart()

No description

array
getOriginalData()

No description

setOriginalData(array $originalData)

No description

$this
addAttachment(Swift_Mime_Attachment $attachment)

No description

Swift_Mime_Attachment
createAttachment($data, $mimeType = null, $filename = null, $disposition = null)

No description

addTo($address, $name = null)

No description

Log
getLastLogEntry()

No description

Details

at line 165
$this setHostUrl($url)

Parameters

$url

Return Value

$this

at line 175
null getHostUrl()

Return Value

null

at line 188
__construct(null $subject = null, null $body = null, null $contentType = null, null $charset = null)

Mail constructor.

Parameters

null $subject
null $body
null $contentType
null $charset

at line 217
init(string $type = 'email')

Initializes the mailer with the settings form Settings -> System -> Email Settings

Parameters

string $type

at line 242
$this setIgnoreDebugMode($value)

Parameters

$value

Return Value

$this

at line 254
bool getIgnoreDebugMode()

Checks if the Debug mode is ignored

Return Value

bool

at line 264
bool doRedirectMailsToDebugMailAddresses()

returns if redirecting to debug mail addresses should take place when sending the mail

Return Value

bool

at line 278
$this setEnableLayoutOnPlaceholderRendering($value)

Parameters

$value

Return Value

$this

at line 288
bool getEnableLayoutOnPlaceholderRendering()

Return Value

bool

at line 301
static bool determineHtml2TextIsInstalled()

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

Return Value

bool

at line 313
Mail setHtml2TextOptions(string $options = '')

Sets options that are passed to html2text

Parameters

string $options

Return Value

Mail

at line 329
string getHtml2TextOptions()

Returns options for html2text

Return Value

string

at line 339
Mail clearRecipients()

Clears list of recipient email addresses

Return Value

Mail Provides fluent interface

at line 354
Mail disableLogging()

Disables email logging

Return Value

Mail Provides fluent interface

at line 366
Mail enableLogging()

Enables email logging (by default it's enabled)

Return Value

Mail Provides fluent interface

at line 378
bool loggingIsEnabled()

returns the logging status

Return Value

bool

at line 390
Mail setParams(array $params)

Sets the parameters for the email view and the Placeholders

Parameters

array $params

Return Value

Mail Provides fluent interface

at line 407
Mail setParam(string $key, mixed $value)

Sets a single parameter for the email view and the Placeholders

Parameters

string $key | int $key
mixed $value

Return Value

Mail Provides fluent interface

at line 423
array getParams()

Returns the parameters which were set with "setParams" or "setParam"

Return Value

array

at line 435
mixed getParam(string $key)

Returns a parameter which was set with "setParams" or "setParam"

Parameters

string $key | integer $key

Return Value

mixed

at line 445
static setForceDebugMode(bool $value)

Forces the debug mode - useful for cli-script which should not send emails to recipients

Parameters

bool $value

at line 457
Mail unsetParams(array $params)

Deletes parameters which were set with "setParams" or "setParam"

Parameters

array $params

Return Value

Mail Provides fluent interface

at line 473
Mail unsetParam(string $key)

Deletes a single parameter which was set with "setParams" or "setParam"

Parameters

string $key | integer $key

Return Value

Mail Provides fluent interface

at line 489
protected Mail setDocumentSettings()

Sets the settings which are defined in the Document Settings (from,to,cc,bcc,replyTo)

Return Value

Mail Provides fluent interface

at line 560
Mail send(Swift_Mailer $mailer = null)

Sends this email using the given transport or with the settings from "Settings" -> "System" -> "Email Settings"

IMPORTANT: If the debug mode is enabled in "Settings" -> "System" -> "Debug" all emails will be sent to the debug email addresses that are given in "Settings" -> "System" -> "Email Settings" -> "Debug email addresses"

set DefaultTransport or the internal mail function if no default transport had been set.

Parameters

Swift_Mailer $mailer

Return Value

Mail Provides fluent interface

at line 590
Mail sendWithoutRendering(Swift_Mailer $mailer = null)

sends mail without (re)rendering the content.

see also comments of send() method

Parameters

Swift_Mailer $mailer

Return Value

Mail

at line 693
static bool isValidEmailAddress($emailAddress)

Static helper to validate a email address

Parameters

$emailAddress

Return Value

bool

at line 705
string getSubjectRendered()

Replaces the placeholders with the content and returns the rendered Subject

Return Value

string

at line 721
string|null getBodyHtmlRendered()

Replaces the placeholders with the content and returns the rendered Html

Return Value

string|null

at line 755
string getBodyTextRendered()

Replaces the placeholders with the content and returns the rendered text if a text was set with "$mail->setBodyText()"

Return Value

string

at line 799
$this setDocument($document)

Parameters

$document

Return Value

$this

Exceptions

Exception

at line 820
Email getDocument()

Returns the Document

Return Value

Email | null

at line 830
Mail preventDebugInformationAppending()

Prevents appending of debug information (used for resending emails)

Return Value

Mail

at line 842
bool isPreventingDebugInformationAppending()

Returns, if debug information is not added

Return Value

bool

at line 851
bool getHtml2TextBinaryEnabled()

Return Value

bool

at line 861
$this enableHtml2textBinary()

Return Value

$this

Exceptions

Exception

at line 879
static bool getHtml2textInstalled()

Return Value

bool || null

at line 893
protected string html2Text($htmlContent)

Parameters

$htmlContent

Return Value

string

at line 917
string getBodyText()

Return Value

string

at line 927
$this setBodyText($bodyText)

Parameters

$bodyText

Return Value

$this

at line 939
Mail setBodyHtml($body)

Parameters

$body

Return Value

Mail

at line 947
Swift_MimePart getBodyTextMimePart()

Return Value

Swift_MimePart

at line 955
array getOriginalData()

Return Value

array

at line 963
setOriginalData(array $originalData)

Parameters

array $originalData

at line 973
$this addAttachment(Swift_Mime_Attachment $attachment)

Parameters

Swift_Mime_Attachment $attachment

Return Value

$this

at line 988
Swift_Mime_Attachment createAttachment($data, $mimeType = null, $filename = null, $disposition = null)

Parameters

$data
$mimeType
$filename
$disposition

Return Value

Swift_Mime_Attachment

at line 1002
addTo($address, $name = null)

Parameters

$address
$name

at line 1016
Log getLastLogEntry()

Return Value

Log