Class craft\helpers\MailerHelper
- Inheritance
- craft\helpers\MailerHelper
- Available since version
- 3.0
- Source Code
- https://github.com/craftcms/cms/blob/master/src/helpers/MailerHelper.php
Class MailerHelper
| Method | Description | Defined By |
|---|---|---|
allMailerTransportTypes() |
Returns all available mailer transport adapter classes. | craft\helpers\MailerHelper |
createMailer() |
Creates a mailer component based on the given mail settings. | craft\helpers\MailerHelper |
createTransportAdapter() |
Creates a transport adapter based on the given mail settings. | craft\helpers\MailerHelper |
| Event | Type | Description | Defined By |
|---|---|---|---|
EVENT_REGISTER_MAILER_TRANSPORT_TYPES |
craft\events\RegisterComponentTypesEvent | The event that is triggered when registering mailer transport adapter types. | craft\helpers\MailerHelper |
Method Details
allMailerTransportTypes()
public static method
#
Returns all available mailer transport adapter classes.
public static string[] allMailerTransportTypes ( )
createMailer()
public static method
#
Creates a mailer component based on the given mail settings.
public static craft\mail\Mailer createMailer ( craft\models\MailSettings $settings )$settings |
craft\models\MailSettings |
createTransportAdapter()
public static method
#
Creates a transport adapter based on the given mail settings.
public static craft\mail\transportadapters\TransportAdapterInterface createTransportAdapter ( \craft\helpers\string $type, array $settings = null )$type |
string | |
$settings |
array, null | |
| throws | craft\errors\MissingComponentException | if $type is missing |
|---|
Event Details
EVENT_REGISTER_MAILER_TRANSPORT_TYPES
event of type craft\events\RegisterComponentTypesEvent
#
The event that is triggered when registering mailer transport adapter types.