Documentation

RestUserActivationMail extends SimpleMail
in package

Application

Constants

EMAIL_ENABLE = false: NewUserActivationMail constructor.
REST_ACTIVATION_URL = '/'

Properties

$attachments : array<string|int, mixed>: The attachments for the message.
$bcc : array<string|int, mixed>: The "bcc" recipients of the message.
$cc : array<string|int, mixed>: The "cc" recipients of the message.
$from : array<string|int, mixed>: The person the message is from.
$rawAttachments : array<string|int, mixed>: The raw attachments for the message.
$replyTo : array<string|int, mixed>: The "reply to" recipients of the message.
$subject : string: The subject of the message.
$textView : string: The plain text view to use for the message.
$theme : string: The name of the theme (css) file which will be used to style the mail.
$to : array<string|int, mixed>: The "to" recipients of the message.
$view : string: The view to use for the message.
$viewData : array<string|int, mixed>: The view data for the message.
$button : null|array<string|int, mixed>
$html : string: The HTML to use for the message.
$isEnabledForSubAccounts : bool
$optional : null|array<string|int, mixed>
$templateLang : string

Methods

__construct() : mixed: SimpleMail constructor.
addBccEmail() : void
addOptional() : mixed
attach() : $this: Attach a file to the message.
attachData() : $this: Attach in-memory data as an attachment.
bcc() : $this: Set the recipients of the message.
build() : mixed
cc() : $this: Set the recipients of the message.
clearRecipients() : mixed
from() : $this: Set the sender of the message.
fromNotification() : SimpleMail
getButton() : mixed: Get the value of button
getOpt() : array<string|int, mixed>|null
getOptional() : mixed
getProtocolAndHost() : mixed
getSecondSendGridTemplateId() : string|null
getSendGridTemplateId() : string
getSubject() : string
hasBcc() : bool: Determine if the given recipient is set on the mailable.
hasCc() : bool: Determine if the given recipient is set on the mailable.
hasFrom() : bool: Determine if the given recipient is set on the mailable.
hasReplyTo() : bool: Determine if the given recipient is set on the mailable.
hasTo() : bool: Determine if the given recipient is set on the mailable.
html() : $this: Set the rendered HTML content for the message.
isEnabled() : bool
isUseSecondSendGridAccount() : bool
replyTo() : $this: Set the "reply to" address of the message.
send() : mixed
setButton() : $this
setIsEnabled() : void
setSecondSendGridTemplateId() : void
setSendGridTemplateId() : void
setUseSecondSendGridAccount() : void
setView() : $this
setViewName() : $this
subject() : $this: Set the subject of the message.
text() : $this: Set the plain text view for the message.
theme() : $this: Set the name of the theme (css) file which will be used to style the mail.
to() : $this: Set the recipients of the message.
view() : $this: Set the view and view data for the message.
with() : $this: Set the view data for the message.
addressesToArray() : array<string|int, mixed>: Convert the given recipient arguments to an array.
buildAttachments() : $this: Add all of the attachments to the message.
buildFrom() : $this: Add the sender to the message.
buildRecipients() : $this: Add all of the recipients to the message.
buildSubject() : $this: Set the subject for the message.
buildView() : array<string|int, mixed>|string: Build the view for the message.
extractClientTextId() : mixed
extractFirstName() : string
extractFullName() : string
getMailableSubaccounts() : array<string|int, mixed>
getTemplateLanguage() : mixed
hasRecipient() : bool: Determine if the given recipient is set on the mailable.
normalizeRecipient() : object: Convert the given recipient into an object.
setAddress() : $this: Set the recipients of the message.
tryExtractUserAccount() : mixed

EMAIL_ENABLE

NewUserActivationMail constructor.


    public
        mixed
    EMAIL_ENABLE
    = false

REST_ACTIVATION_URL


    public
        mixed
    REST_ACTIVATION_URL
    = '/'

$attachments

The attachments for the message.


        public
            array<string|int, mixed>
    $attachments
     = []

$bcc

The "bcc" recipients of the message.


        public
            array<string|int, mixed>
    $bcc
     = []

$cc

The "cc" recipients of the message.


        public
            array<string|int, mixed>
    $cc
     = []

$from

The person the message is from.


        public
            array<string|int, mixed>
    $from
     = []

$rawAttachments

The raw attachments for the message.


        public
            array<string|int, mixed>
    $rawAttachments
     = []

$replyTo

The "reply to" recipients of the message.


        public
            array<string|int, mixed>
    $replyTo
     = []

$subject

The subject of the message.


        public
            string
    $subject

$textView

The plain text view to use for the message.


        public
            string
    $textView

$theme

The name of the theme (css) file which will be used to style the mail.


        public
            string
    $theme
     = 'basic'

$to

The "to" recipients of the message.


        public
            array<string|int, mixed>
    $to
     = []

$view

The view to use for the message.


        public
            string
    $view

$viewData

The view data for the message.


        public
            array<string|int, mixed>
    $viewData
     = []

$button


        protected
            null|array<string|int, mixed>
    $button
     = null

$html

The HTML to use for the message.


        protected
            string
    $html

$isEnabledForSubAccounts


        protected
            bool
    $isEnabledForSubAccounts
     = false

$optional


        protected
            null|array<string|int, mixed>
    $optional
     = null

$templateLang


        protected
            string
    $templateLang

__construct()

SimpleMail constructor.


    public
                    __construct(mixed $user, mixed $hash[, mixed $redirect = null ]) : mixed

Parameters

$user : mixed
$hash : mixed
$redirect : mixed = null

addBccEmail()


    public
                    addBccEmail() : void

addOptional()


    public
                    addOptional(mixed $name, mixed $value) : mixed

Parameters

$name : mixed
$value : mixed

attach()

Attach a file to the message.


    public
                    attach(string $file[, array<string|int, mixed> $options = [] ]) : $this

Options: as - filename mime - mimetype

Parameters

$file : string
$options : array<string|int, mixed> = []

Return values

$this

attachData()

Attach in-memory data as an attachment.


    public
                    attachData(string $data, string $name[, array<string|int, mixed> $options = [] ]) : $this

Parameters

$data : string
$name : string
$options : array<string|int, mixed> = []

Return values

$this

bcc()

Set the recipients of the message.


    public
                    bcc(object|array<string|int, mixed>|string $address[, string|null $name = null ]) : $this

Parameters

$address : object|array<string|int, mixed>|string
$name : string|null = null

Return values

$this

build()


    public
        final            build() : mixed

cc()

Set the recipients of the message.


    public
                    cc(object|array<string|int, mixed>|string $address[, string|null $name = null ]) : $this

Parameters

$address : object|array<string|int, mixed>|string
$name : string|null = null

Return values

$this

clearRecipients()


    public
                    clearRecipients() : mixed

from()

Set the sender of the message.


    public
                    from(object|array<string|int, mixed>|string $address[, string|null $name = null ]) : $this

Parameters

$address : object|array<string|int, mixed>|string
$name : string|null = null

Return values

$this

fromNotification()


    public
            static        fromNotification(Notification $notification, Translator $translator) : SimpleMail

Parameters

$notification : Notification
$translator : Translator

Return values

SimpleMail

getButton()

Get the value of button


    public
                    getButton() : mixed

getOpt()


    public
                    getOpt() : array<string|int, mixed>|null

Return values

array<string|int, mixed>|null

getOptional()


    public
                    getOptional() : mixed

getProtocolAndHost()


    public
                    getProtocolAndHost() : mixed

getSecondSendGridTemplateId()


    public
                    getSecondSendGridTemplateId() : string|null

Return values

string|null

getSendGridTemplateId()


    public
                    getSendGridTemplateId() : string

Return values

string

getSubject()


    public
                    getSubject() : string

Return values

string

hasBcc()

Determine if the given recipient is set on the mailable.


    public
                    hasBcc(object|array<string|int, mixed>|string $address[, string|null $name = null ]) : bool

Parameters

$address : object|array<string|int, mixed>|string
$name : string|null = null

Return values

bool

hasCc()

Determine if the given recipient is set on the mailable.


    public
                    hasCc(object|array<string|int, mixed>|string $address[, string|null $name = null ]) : bool

Parameters

$address : object|array<string|int, mixed>|string
$name : string|null = null

Return values

bool

hasFrom()

Determine if the given recipient is set on the mailable.


    public
                    hasFrom(object|array<string|int, mixed>|string $address[, string|null $name = null ]) : bool

Parameters

$address : object|array<string|int, mixed>|string
$name : string|null = null

Return values

bool

hasReplyTo()

Determine if the given recipient is set on the mailable.


    public
                    hasReplyTo(object|array<string|int, mixed>|string $address[, string|null $name = null ]) : bool

Parameters

$address : object|array<string|int, mixed>|string
$name : string|null = null

Return values

bool

hasTo()

Determine if the given recipient is set on the mailable.


    public
                    hasTo(object|array<string|int, mixed>|string $address[, string|null $name = null ]) : bool

Parameters

$address : object|array<string|int, mixed>|string
$name : string|null = null

Return values

bool

html()

Set the rendered HTML content for the message.


    public
                    html(string $html) : $this

Parameters

$html : string

Return values

$this

isEnabled()


    public
                    isEnabled() : bool

Return values

bool

isUseSecondSendGridAccount()


    public
                    isUseSecondSendGridAccount() : bool

Return values

bool

replyTo()

Set the "reply to" address of the message.


    public
                    replyTo(object|array<string|int, mixed>|string $address[, string|null $name = null ]) : $this

Parameters

$address : object|array<string|int, mixed>|string
$name : string|null = null

Return values

$this

send()


    public
                    send(Mailer $mailer) : mixed

Parameters

$mailer : Mailer

setButton()


    public
                    setButton(string $text, string $href[, bool $hostCompletion = false ]) : $this

Parameters

$text : string
$href : string
$hostCompletion : bool = false

Return values

$this

setIsEnabled()


    public
                    setIsEnabled(bool $isEnabled) : void

Parameters

$isEnabled : bool

setSecondSendGridTemplateId()


    public
                    setSecondSendGridTemplateId(string $secondSendGridTemplateId) : void

Parameters

$secondSendGridTemplateId : string

setSendGridTemplateId()


    public
                    setSendGridTemplateId(string $sendGridTemplateId) : void

Parameters

$sendGridTemplateId : string

setUseSecondSendGridAccount()


    public
                    setUseSecondSendGridAccount(bool $useSecondSendGridAccount) : void

Parameters

$useSecondSendGridAccount : bool

setView()


    public
                    setView(string $view) : $this

Parameters

$view : string

Return values

$this

setViewName()


    public
                    setViewName(string $viewName) : $this

Parameters

$viewName : string

Return values

$this

subject()

Set the subject of the message.


    public
                    subject(string $subject) : $this

Parameters

$subject : string

Return values

$this

text()

Set the plain text view for the message.


    public
                    text(string $textView[, array<string|int, mixed> $data = [] ]) : $this

Parameters

$textView : string
$data : array<string|int, mixed> = []

Return values

$this

theme()

Set the name of the theme (css) file which will be used to style the mail.


    public
                    theme([string $theme = 'basic' ]) : $this

Parameters

$theme : string = 'basic'

Return values

$this

to()

Set the recipients of the message.


    public
                    to(object|array<string|int, mixed>|string $address[, string|null $name = null ]) : $this

Parameters

$address : object|array<string|int, mixed>|string
$name : string|null = null

Return values

$this

view()

Set the view and view data for the message.


    public
                    view(string $view[, array<string|int, mixed> $data = [] ]) : $this

Parameters

$view : string
$data : array<string|int, mixed> = []

Return values

$this

with()

Set the view data for the message.


    public
                    with(string|array<string|int, mixed> $key[, mixed $value = null ]) : $this

Parameters

$key : string|array<string|int, mixed>
$value : mixed = null

Return values

$this

addressesToArray()

Convert the given recipient arguments to an array.


    protected
                    addressesToArray(object|array<string|int, mixed>|string $address[, string|null $name = null ]) : array<string|int, mixed>

Parameters

$address : object|array<string|int, mixed>|string
$name : string|null = null

Return values

array<string|int, mixed>

buildAttachments()

Add all of the attachments to the message.


    protected
                    buildAttachments(Message $message) : $this

Parameters

$message : Message

Return values

$this

buildFrom()

Add the sender to the message.


    protected
                    buildFrom(Message $message) : $this

Parameters

$message : Message

Return values

$this

buildRecipients()

Add all of the recipients to the message.


    protected
                    buildRecipients(Message $message) : $this

Parameters

$message : Message

Return values

$this

buildSubject()

Set the subject for the message.


    protected
                    buildSubject(Message $message) : $this

Parameters

$message : Message

Return values

$this

buildView()

Build the view for the message.


    protected
                    buildView() : array<string|int, mixed>|string

Return values

array<string|int, mixed>|string

extractClientTextId()


    protected
                    extractClientTextId(mixed $user) : mixed

Parameters

$user : mixed

extractFirstName()


    protected
                    extractFirstName(mixed $user) : string

Parameters

$user : mixed: [optional] $default = $this->user = null

Return values

string —

$default = "Customer"

extractFullName()


    protected
                    extractFullName(mixed $user) : string

Parameters

$user : mixed: [optional] $default = $this->user = null

Return values

string —

$default = "Customer"

getMailableSubaccounts()


    protected
                    getMailableSubaccounts(UserAccount $userAccount) : array<string|int, mixed>

Parameters

$userAccount : UserAccount

Return values

array<string|int, mixed>

getTemplateLanguage()


    protected
                    getTemplateLanguage() : mixed

hasRecipient()

Determine if the given recipient is set on the mailable.


    protected
                    hasRecipient(object|array<string|int, mixed>|string $address[, string|null $name = null ][, string $property = 'to' ]) : bool

Parameters

$address : object|array<string|int, mixed>|string
$name : string|null = null
$property : string = 'to'

Return values

bool

normalizeRecipient()

Convert the given recipient into an object.


    protected
                    normalizeRecipient(mixed $recipient) : object

Parameters

$recipient : mixed

Return values

object

setAddress()

Set the recipients of the message.


    protected
                    setAddress(object|array<string|int, mixed>|string $address[, string|null $name = null ][, string $property = 'to' ]) : $this

All recipients are stored internally as [['name' => ?, 'address' => ?]]

Parameters

$address : object|array<string|int, mixed>|string
$name : string|null = null
$property : string = 'to'

Return values

$this

tryExtractUserAccount()


    protected
                    tryExtractUserAccount(mixed $user) : mixed

Parameters

$user : mixed

RestUserActivationMail extends SimpleMail in package Application

Table of Contents

Constants

Properties

Methods

Constants

EMAIL_ENABLE

REST_ACTIVATION_URL

Properties

$attachments

$bcc

$cc

$from

$rawAttachments

$replyTo

$subject

$textView

$theme

$to

$view

$viewData

$button

$html

$isEnabledForSubAccounts

$optional

$templateLang

Methods

__construct()

Parameters

addBccEmail()

addOptional()

Parameters

attach()

Parameters

Return values

attachData()

Parameters

Return values

bcc()

Parameters

Return values

build()

cc()

Parameters

Return values

clearRecipients()

from()

Parameters

Return values

fromNotification()

Parameters

Return values

getButton()

getOpt()

Return values

getOptional()

getProtocolAndHost()

getSecondSendGridTemplateId()

Return values

getSendGridTemplateId()

Return values

getSubject()

Return values

hasBcc()

Parameters

Return values

hasCc()

Parameters

Return values

hasFrom()

Parameters

Return values

hasReplyTo()

Parameters

Return values

hasTo()

Parameters

Return values

html()

Parameters

RestUserActivationMail extends SimpleMail
in package

Application