TransportAdapterInterface
- Type
- Interface
- Namespace
- craft\mail\transportadapters
- Extends
- craft\base\ConfigurableComponentInterface
- Implemented by
- craft\mail\transportadapters\BaseTransportAdapter, craft\mail\transportadapters\Gmail, craft\mail\transportadapters\Sendmail, craft\mail\transportadapters\Smtp
- Since
- 3.0.0
TransportAdapterInterface defines the common interface to be implemented by Symfony Mailer transport adapter classes.
View source (opens new window)
# Public Methods
| Method | Description |
|---|---|
| defineTransport() | Returns the config array or an implementation of AbstractTransport object that should be passed to \craft\mail\Mailer::setTransport(). |
| displayName() | Returns the display name of this class. |
| extraFields() (opens new window) | Returns the list of additional fields that can be returned by toArray() (opens new window) in addition to those listed in fields() (opens new window). |
| fields() (opens new window) | Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified. |
| getSettings() | Returns an array of the component’s settings. |
| getSettingsHtml() | Returns the component’s settings HTML. |
| instance() (opens new window) | Returns static class instance, which can be used to obtain meta information. |
| isSelectable() | Returns whether the component should be selectable in component Type selects. |
| settingsAttributes() | Returns the list of settings attribute names. |
| toArray() (opens new window) | Converts the object into an array. |
# defineTransport()
Returns the config array or an implementation of AbstractTransport object that should be passed to \craft\mail\Mailer::setTransport().
View source (opens new window)
Returns
array (opens new window), \Symfony\Component\Mailer\Transport\AbstractTransport
← Smtp GithubMarkdown →