MediaWiki  master
MediaWiki\Mail\IEmailer Interface Reference

Interface for sending emails. More...

Inheritance diagram for MediaWiki\Mail\IEmailer:

Public Member Functions

 send (array $to, MailAddress $from, string $subject, string $bodyText, ?string $bodyHtml=null, array $options=[])
 Sends emails to recipients. More...
 

Detailed Description

Interface for sending emails.

Since
1.35

Definition at line 34 of file IEmailer.php.

Member Function Documentation

◆ send()

MediaWiki\Mail\IEmailer::send ( array  $to,
MailAddress  $from,
string  $subject,
string  $bodyText,
?string  $bodyHtml = null,
array  $options = [] 
)

Sends emails to recipients.

Since
1.35
Parameters
MailAddress[]$toArray of Recipients' emails
MailAddress$fromSender's email
string$subjectEmail's subject.
string$bodyTexttext part of body
string | null$bodyHtmlhtml part of body (optional)
array$optionsKeys: 'replyTo' MailAddress 'contentType' string default 'text/plain; charset=UTF-8' 'headers' array Extra headers to set

-param array{replyTo?:MailAddress,contentType?:string,headers?:array<string,string>} $options

Exceptions
MWException
Exception
Returns
StatusValue

Implemented in MediaWiki\Mail\Emailer.


The documentation for this interface was generated from the following file: