0 follower

Interface Yiisoft\Mailer\MailerInterface

All Classes | Methods
Implemented byYiisoft\Mailer\BaseMailer, Yiisoft\Mailer\Debug\MailerInterfaceProxy, Yiisoft\Mailer\FileMailer, Yiisoft\Mailer\NullMailer, Yiisoft\Mailer\StubMailer

MailerInterface is the interface that should be implemented by mailers.

For example:

$message = (new Message())
    ->withFrom('from@domain.com')
    ->withTo('to@domain.com')
    ->withSubject('Message subject')
    ->withTextBody('Plain text content')
    ->withHtmlBody('<b>HTML content</b>')
;
$mailer->send($message);

Public Methods

Hide inherited methods

Method Description Defined By
send() Sends the given email message. Yiisoft\Mailer\MailerInterface
sendMultiple() Sends multiple messages at once. Yiisoft\Mailer\MailerInterface

Method Details

Hide inherited methods

send() public abstract method

Sends the given email message.

public abstract void send ( Yiisoft\Mailer\MessageInterface $message )
$message Yiisoft\Mailer\MessageInterface

The email message instance to be sent.

 

                public function send(MessageInterface $message): void;
sendMultiple() public abstract method

Sends multiple messages at once.

This method may be implemented by some mailers which support more efficient way of sending multiple messages in the same batch.

public abstract Yiisoft\Mailer\SendResults sendMultiple ( Yiisoft\Mailer\MessageInterface[] $messages )
$messages Yiisoft\Mailer\MessageInterface[]

List of email messages, which should be sent.
return Yiisoft\Mailer\SendResults

The result object that contains all messages and errors for failed sent messages.

 

                public function sendMultiple(array $messages): SendResults;