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