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 SwiftMailer transport adapter classes.

View source

# Public Methods

Method Description
defineTransport() Returns the config array or \Swift_Transport object that should be passed to craft\mail\Mailer::setTransport().
displayName() Returns the display name of this class.
getSettings() Returns an array of the component’s settings.
getSettingsHtml() Returns the component’s settings HTML.
isSelectable() Returns whether the component should be selectable in component Type selects.
settingsAttributes() Returns the list of settings attribute names.

# defineTransport()

Returns the config array or \Swift_Transport object that should be passed to craft\mail\Mailer::setTransport().

View source

Returns

array, \Swift_Transport