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 * Send arbitrary emails.
29 *
30 * Obtain instance via ServiceWiring. This service is intended to eventually
31 * replace the stable (but static) functions of the UserMailer class.
32 *
33 * Use of this class is discouraged in favour of higher-level abstractions
34 * whenever possible:
35 *
36 * - EmailNotification: Format and send emails to watchers about a recent change.
37 * - EmailUserFactory: Format and send emails between two wiki users.
38 *
39 * @since 1.35
40 * @ingroup Mail
41 */
42class Emailer implements IEmailer {
43
44    /**
45     * @since 1.35
46     *
47     * This function will perform a direct (authenticated) login to
48     * a SMTP Server to use for mail relaying if 'wgSMTP' specifies an
49     * array of parameters. It requires PEAR:Mail to do that.
50     * Otherwise it just uses the standard PHP 'mail' function.
51     *
52     * @inheritDoc
53     */
54    public function send(
55        $to,
56        MailAddress $from,
57        string $subject,
58        string $bodyText,
59        ?string $bodyHtml = null,
60        array $options = []
61    ): StatusValue {
62        $body = $bodyHtml ? [ 'text' => $bodyText, 'html' => $bodyHtml ] : $bodyText;
63        return UserMailer::send( $to, $from, $subject, $body, $options );
64    }
65}