SesTransport
class SesTransport extends Transport (View source)
Properties
| array | $plugins | The plug-ins registered with the transport. |
from Transport |
| protected SesClient | $ses | The Amazon SES instance. |
|
| protected array | $options | The Amazon SES transmission options. |
Methods
| bool | isStarted() {@inheritdoc} |
from Transport |
| start() {@inheritdoc} |
from Transport | |
| stop() {@inheritdoc} |
from Transport | |
| bool | ping() {@inheritdoc} |
from Transport |
| void | registerPlugin(Swift_Events_EventListener $plugin) Register a plug-in with the transport. |
from Transport |
| void | beforeSendPerformed(Swift_Mime_SimpleMessage $message) Iterate through registered plugins and execute plugins' methods. |
from Transport |
| void | sendPerformed(Swift_Mime_SimpleMessage $message) Iterate through registered plugins and execute plugins' methods. |
from Transport |
| int | numberOfRecipients(Swift_Mime_SimpleMessage $message) Get the number of recipients. |
from Transport |
| void | __construct(SesClient $ses, array $options = []) Create a new SES transport instance. |
|
| int | send(Swift_Mime_SimpleMessage $message, $failedRecipients = null) {@inheritdoc} |
|
| SesClient | ses() Get the Amazon SES client for the SesTransport instance. |
|
| array | getOptions() Get the transmission options being used by the transport. |
|
| array | setOptions(array $options) Set the transmission options being used by the transport. |
Details
bool isStarted()
{@inheritdoc}
start()
{@inheritdoc}
stop()
{@inheritdoc}
bool ping()
{@inheritdoc}
void registerPlugin(Swift_Events_EventListener $plugin)
Register a plug-in with the transport.
protected void beforeSendPerformed(Swift_Mime_SimpleMessage $message)
Iterate through registered plugins and execute plugins' methods.
protected void sendPerformed(Swift_Mime_SimpleMessage $message)
Iterate through registered plugins and execute plugins' methods.
protected int numberOfRecipients(Swift_Mime_SimpleMessage $message)
Get the number of recipients.
void __construct(SesClient $ses, array $options = [])
Create a new SES transport instance.
int send(Swift_Mime_SimpleMessage $message, $failedRecipients = null)
{@inheritdoc}
SesClient ses()
Get the Amazon SES client for the SesTransport instance.
array getOptions()
Get the transmission options being used by the transport.
array setOptions(array $options)
Set the transmission options being used by the transport.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Mail/Transport/SesTransport.html