class EmailService (View source)

Class EmailService

Email reporting for queued jobs

Traits

A class that can be instantiated or replaced via DI

Methods

public static 
create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

public static 
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

public
__construct()

No description

public
Email|null
createMissingDefaultJobReport(array $jobConfig, string $title)

No description

public
Email|null
createStalledJobReport(string $subject, string $message, int $jobID)

No description

public
Email|null
createBrokenJobsReport(string $subject, string $message, DataList $jobs)

No description

public
Email|null
createReport(string $subject)

Create a generic email report useful for reporting queue service issues

Details

static Injectable create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();

Parameters

mixed ...$args

Return Value

Injectable

static Injectable singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

__construct()

No description

Email|null createMissingDefaultJobReport(array $jobConfig, string $title)

No description

Parameters

array $jobConfig
string $title

Return Value

Email|null

Email|null createStalledJobReport(string $subject, string $message, int $jobID)

No description

Parameters

string $subject
string $message
int $jobID

Return Value

Email|null

Email|null createBrokenJobsReport(string $subject, string $message, DataList $jobs)

No description

Parameters

string $subject
string $message
DataList $jobs

Return Value

Email|null

Email|null createReport(string $subject)

Create a generic email report useful for reporting queue service issues

Parameters

string $subject

Return Value

Email|null