class SwiftMailer implements Mailer (View source)

deprecated 4.12.0 Will be replaced with symfony/mailer Mailer objects are responsible for actually sending emails. The default Mailer class will use PHP's mail() function.

Traits

Provides extensions to this object to integrate it with standard config API methods.

A class that can be instantiated or replaced via DI

Config options

swift_plugins array

Properties

Methods

public static 
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

public
mixed
stat(string $name) deprecated

Get inherited config value

public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

public
$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

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
bool
__construct()

No description

public
bool
send($message)

No description

protected
int
sendSwift(Swift_Message $message, array $failedRecipients = null)

No description

public
Swift_Mailer
getSwiftMailer()

No description

public
$this
setSwiftMailer(Swift_Mailer $swift)

No description

Details

static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Return Value

Config_ForClass

mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

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

bool __construct()

No description

Return Value

bool

Whether the sending was "successful" or not

bool send($message)

No description

Parameters

$message

Return Value

bool

protected int sendSwift(Swift_Message $message, array $failedRecipients = null)

No description

Parameters

Swift_Message $message
array $failedRecipients

Return Value

int

Swift_Mailer getSwiftMailer()

No description

Return Value

Swift_Mailer

$this setSwiftMailer(Swift_Mailer $swift)

No description

Parameters

Swift_Mailer $swift

Return Value

$this