1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Mail;
use Exception;
use MailAddress;
use MWException;
use StatusValue;
/**
* Interface for sending emails.
*
* @since 1.35
* @internal
*/
interface IEmailer {
/**
* Sends emails to recipients
*
* @since 1.35
*
* @param MailAddress[] $to Array of Recipients' emails
* @param MailAddress $from Sender's email
* @param string $subject Email's subject.
* @param string $bodyText text part of body
* @param string|null $bodyHtml html part of body (optional)
* @param array $options Keys:
* 'replyTo' MailAddress
* 'contentType' string default 'text/plain; charset=UTF-8'
* 'headers' array Extra headers to set
*
* @codingStandardsIgnoreStart
* @phan-param array{replyTo?:MailAddress,contentType?:string,headers?:array<string,string>} $options
* @codingStandardsIgnoreEnd
*
* @throws MWException
* @throws Exception
* @return StatusValue
*/
public function send(
array $to,
MailAddress $from,
string $subject,
string $bodyText,
?string $bodyHtml = null,
array $options = []
): StatusValue;
}
|
