Piwik\

Mail

Class for sending mails

Methods

The class defines the following methods:

• __construct()
• setFrom() — Sets the sender.
• setDefaultFromPiwik() — Sets the default sender
• getFrom() — Returns the address the mail will be sent from
• getFromName() — Returns the address the mail will be sent from
• setWrappedHtmlBody()
• setBodyHtml() — Sets the HTML part of the mail
• setBodyText() — Sets the text part of the mail.
• getBodyHtml() — Returns html content of the mail
• getBodyText() — Returns text content of the mail
• setSubject() — Sets the subject of the mail
• getSubject() — Return the subject of the mail
• addTo() — Adds a recipient
• getRecipients() — Returns the list of recipients
• addBcc() — Add Bcc address
• getBccs() — Returns the list of bcc addresses
• clearAllRecipients() — Removes all recipients and bccs from the list
• addReplyTo() — Add Reply-To address
• setReplyTo() — Sets the reply to address (all previously added addresses will be removed)
• getReplyTos() — Returns the list of reply to addresses
• addAttachment()
• getAttachments()
• send() — Sends the mail
• safeSend() — If the send email process throws an exception, we catch it and log it
• setSmtpDebug() — Enables SMTP debugging
• isSmtpDebugEnabled() — Returns whether SMTP debugging is enabled or not
• getMailHost() — Returns the hostname mails will be sent from
• sanitiseString() — Replaces characters known to appear incorrectly in some email clients

__construct()

Signature

setFrom()

Sets the sender.

Signature

• It accepts the following parameter(s):
  • $email (string) — Email address of the sender.
  • $name (null|string) — Name of the sender.
• It does not return anything or a mixed result.

setDefaultFromPiwik()

Sets the default sender

Signature

• It does not return anything or a mixed result.
• It throws one of the following exceptions:
  • Piwik\Exception\DI\NotFoundException

getFrom()

Returns the address the mail will be sent from

Signature

• It returns a string value.

getFromName()

Returns the address the mail will be sent from

Signature

• It returns a string value.

setWrappedHtmlBody()

Signature

• It accepts the following parameter(s):

  • $body (View|string) —

• It does not return anything or a mixed result.

• It throws one of the following exceptions:
  • Piwik\Exception\DI\DependencyException
  • Piwik\Exception\DI\NotFoundException

setBodyHtml()

Sets the HTML part of the mail

Signature

• It accepts the following parameter(s):

  • $html

• It does not return anything or a mixed result.

setBodyText()

Sets the text part of the mail.

If bodyHtml is set, this will be used as alternative text part

Signature

• It accepts the following parameter(s):

  • $txt

• It does not return anything or a mixed result.

getBodyHtml()

Returns html content of the mail

Signature

• It returns a string value.

getBodyText()

Returns text content of the mail

Signature

• It returns a string value.

setSubject()

Sets the subject of the mail

Signature

• It accepts the following parameter(s):

  • $subject

• It does not return anything or a mixed result.

getSubject()

Return the subject of the mail

Signature

• It returns a string value.

addTo()

Adds a recipient

Signature

• It accepts the following parameter(s):

  • $address (string) —

  • $name (string) —

• It does not return anything or a mixed result.

getRecipients()

Returns the list of recipients

Signature

• It returns a array value.

addBcc()

Add Bcc address

Signature

• It accepts the following parameter(s):

  • $email (string) —

  • $name (string) —

• It does not return anything or a mixed result.

getBccs()

Returns the list of bcc addresses

Signature

• It returns a array value.

clearAllRecipients()

Removes all recipients and bccs from the list

Signature

• It does not return anything or a mixed result.

addReplyTo()

Add Reply-To address

Signature

• It accepts the following parameter(s):

  • $email (string) —

  • $name (string) —

• It does not return anything or a mixed result.

setReplyTo()

Sets the reply to address (all previously added addresses will be removed)

Signature

• It accepts the following parameter(s):

  • $email (string) —

  • $name (string) —

• It does not return anything or a mixed result.

getReplyTos()

Returns the list of reply to addresses

Signature

• It returns a array value.

addAttachment()

Signature

• It accepts the following parameter(s):

  • $body

  • $mimeType

  • $filename

  • $cid

• It does not return anything or a mixed result.

getAttachments()

Signature

• It does not return anything or a mixed result.

send()

Sends the mail

Signature

• Returns: bool|null — returns null if sending the mail was aborted by the Mail.send event
• It throws one of the following exceptions:
  • Piwik\Exception\DI\DependencyException
  • Piwik\Exception\DI\NotFoundException
  • PHPMailer\PHPMailer\Exception

safeSend()

If the send email process throws an exception, we catch it and log it

Signature

• It returns a void value.
• It throws one of the following exceptions:
  • Piwik\Exception\DI\NotFoundException
  • Piwik\Exception\DI\DependencyException

setSmtpDebug()

Enables SMTP debugging

Signature

• It accepts the following parameter(s):

  • $smtpDebug (bool) —

• It does not return anything or a mixed result.

isSmtpDebugEnabled()

Returns whether SMTP debugging is enabled or not

Signature

• It returns a bool value.

getMailHost()

Returns the hostname mails will be sent from

Signature

• It returns a string value.

sanitiseString()

Replaces characters known to appear incorrectly in some email clients

Signature

• It accepts the following parameter(s):

  • $string

• It returns a mixed value.