Interface craft\mail\transportadapters\TransportAdapterInterface
- Extends
- craft\base\SavableComponentInterface
- Implemented by
- craft\mail\transportadapters\BaseTransportAdapter, craft\mail\transportadapters\Gmail, craft\mail\transportadapters\Sendmail, craft\mail\transportadapters\Smtp
- Available since version
- 3.0
- Source Code
- https://github.com/craftcms/cms/blob/master/src/mail/transportadapters/TransportAdapterInterface.php
TransportAdapterInterface defines the common interface to be implemented by SwiftMailer transport adapter classes.
| Method | Description | Defined By |
|---|---|---|
afterDelete() |
Performs actions after a component is deleted. | craft\base\SavableComponentInterface |
afterSave() |
Performs actions after a component is saved. | craft\base\SavableComponentInterface |
beforeDelete() |
Performs actions before a component is deleted. | craft\base\SavableComponentInterface |
beforeSave() |
Performs actions before a component is saved. | craft\base\SavableComponentInterface |
defineTransport() |
Returns the config array or \Swift_Transport object that should be passed to craft\mail\Mailer::setTransport(). | craft\mail\transportadapters\TransportAdapterInterface |
displayName() |
Returns the display name of this class. | craft\base\ComponentInterface |
getIsNew() |
Returns whether the component is new (unsaved). | craft\base\SavableComponentInterface |
getSettings() |
Returns an array of the component’s settings. | craft\base\SavableComponentInterface |
getSettingsHtml() |
Returns the component’s settings HTML. | craft\base\SavableComponentInterface |
isSelectable() |
Returns whether the component should be selectable in component Type selects. | craft\base\SavableComponentInterface |
settingsAttributes() |
Returns the list of settings attribute names. | craft\base\SavableComponentInterface |
validate() |
Validates the component. | craft\base\SavableComponentInterface |
Method Details
defineTransport()
public abstract method
#
Returns the config array or \Swift_Transport object that should be passed to craft\mail\Mailer::setTransport().
public abstract array, \Swift_Transport defineTransport ( )