1. class
  2. Core
  3. \
  4. Lib
  5. \
  6. Mail
  7. \
  8. WelcomeMailer

WelcomeMailer

class WelcomeMailer extends AbstractMailer

Class for generating a welcome message.

Properties

protected string $layout

The layout to be used with email.

 from  AbstractMailer
protected MailerService $mailer

The mailer service object sending the mail.

 from  AbstractMailer
protected string $style

The style to be used with email.

 from  AbstractMailer
protected Users $user

The user to send the email.

 from  AbstractMailer

Methods

__construct(Users $user)

Constructor for AbstractMailer

from  AbstractMailer
bool
buildAndSend(string|null $layout = null, array $attachments = [], string|null $layoutPath = null, string|null $templatePath = null, string|null $styles = null, string|null $stylesPath = null)

Common send logic shared by all mailers.

from  AbstractMailer
array
getData()

Overrides getData from parent.

string
getSubject()

Overrides getSubject from parent.

string
getTemplate()

Overrides getTemplate from parent.

bool
send()

Send the mail

from  AbstractMailer
static bool
sendTo(Users $user)

Statically sends E-mail

from  AbstractMailer

Details

in AbstractMailer at line 41
__construct(Users $user)

Constructor for AbstractMailer

Parameters

Users $user

The user to send the email.

in AbstractMailer at line 58
bool buildAndSend(string|null $layout = null, array $attachments = [], string|null $layoutPath = null, string|null $templatePath = null, string|null $styles = null, string|null $stylesPath = null)

Common send logic shared by all mailers.

Parameters

string|null $layout

The layout if it exists.
array $attachments

An array containing information about attachments.
string|null $layoutPath

The path to the layout.
string|null $templatePath

The path to the template.
string|null $styles

Name of stylesheet file.
string|null $stylesPath

The path to the stylesheet.

Return Value

bool

True if successful. Otherwise, we return false.

at line 14
protected array getData()

Overrides getData from parent.

Return Value

array

Data to be used in E-mail.

at line 23
protected string getSubject()

Overrides getSubject from parent.

Return Value

string

The subject of the E-mail.

at line 32
protected string getTemplate()

Overrides getTemplate from parent.

Return Value

string

The name of the template to be used.

in AbstractMailer at line 107
bool send()

Send the mail

Return Value

bool

in AbstractMailer at line 117
static bool sendTo(Users $user)

Statically sends E-mail

Parameters

Users $user

The recipient

Return Value

bool