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

AbstractMailer

abstract class AbstractMailer

Describes specification for all mailers.

Properties

protected string $layout

The layout to be used with email.
protected MailerService $mailer

The mailer service object sending the mail.
protected string $style

The style to be used with email.
protected Users $user

The user to send the email.

Methods

__construct(Users $user)

Constructor for 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.

array
getData()

Used to retrieve data to be used in E-mail.

string
getSubject()

Returns subject for E-mail.

string
getTemplate()

Returns the template to be used.

bool
send()

Send the mail

static bool
sendTo(Users $user)

Statically sends E-mail

Details

at line 41
__construct(Users $user)

Constructor for AbstractMailer

Parameters

Users $user

The user to send the email.

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 86
abstract protected array getData()

Used to retrieve data to be used in E-mail.

Return Value

array

Data to be used in E-mail.

at line 93
abstract protected string getSubject()

Returns subject for E-mail.

Return Value

string

The subject of the E-mail.

at line 100
abstract protected string getTemplate()

Returns the template to be used.

Return Value

string

The name of the template to be used.

at line 107
bool send()

Send the mail

Return Value

bool

at line 117
static bool sendTo(Users $user)

Statically sends E-mail

Parameters

Users $user

The recipient

Return Value

bool