TransportAdapterInterface

Type
Interface
Namespace
craft\mail\transportadapters
Extends
craft\base\SavableComponentInterface
Implemented by
craft\mail\transportadapters\BaseTransportAdapter, craft\mail\transportadapters\Gmail, craft\mail\transportadapters\Sendmail, craft\mail\transportadapters\Smtp
Since
3.0

TransportAdapterInterface defines the common interface to be implemented by SwiftMailer transport adapter classes.

View source

Public Methods

MethodDescription
afterDelete()Performs actions after a component is deleted.
afterSave()Performs actions after a component is saved.
beforeDelete()Performs actions before a component is deleted.
beforeSave()Performs actions before a component is saved.
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.
getIsNew()Returns whether the component is new (unsaved).
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.
validate()Validates the component.

defineTransport()

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

View source

Returns

array, \Swift_Transport

Signature

public abstract array, \Swift_Transport defineTransport ( )