Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
CRAP
100.00% covered (success)
100.00%
1 / 1
Emailer
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
2
100.00% covered (success)
100.00%
1 / 1
 send
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
2
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;
25use UserMailer;
26
27/**
28 * @internal
29 * @since 1.35
30 */
31class Emailer implements IEmailer {
32
33    /**
34     * @since 1.35
35     *
36     * This function will perform a direct (authenticated) login to
37     * a SMTP Server to use for mail relaying if 'wgSMTP' specifies an
38     * array of parameters. It requires PEAR:Mail to do that.
39     * Otherwise it just uses the standard PHP 'mail' function.
40     *
41     * @inheritDoc
42     */
43    public function send(
44        $to,
45        MailAddress $from,
46        string $subject,
47        string $bodyText,
48        ?string $bodyHtml = null,
49        array $options = []
50    ): StatusValue {
51        $body = $bodyHtml ? [ 'text' => $bodyText, 'html' => $bodyHtml ] : $bodyText;
52        return UserMailer::send( $to, $from, $subject, $body, $options );
53    }
54}