949c9c932e
* Add missing `ingroup` to class blocks (and remove from any file blocks) as otherwise the file is indexed twice (e.g. in Doxygen) which makes navigation on doc.wikimedia.org rather messy. Remove duplicate descriptions from file blocks in favour of class doc blocks. This reduces needless duplication and was often incorrect or outdated, and helps make file headers more consistently (visually) ignorable. Ref https://gerrit.wikimedia.org/r/q/message:ingroup+is:merged * Widen `@covers` tags in phpunit tests Given all called methods are de-facto and liberally claimed, and that we keep the coverage limited to the subject class, it maintains the spirit and intent by listing the class explicitly instead. PHPUnit offers a more precise tool when you need it (i.e. when testing legacy monster/god classes), but for well-written code, the class-wide tag is exactly what you want. We lose useful coverage and waste valuable time on keeping tags accurate through refactors (or worse, forget to do so). Tracking tiny per-method details wastes time in realizing (and fixing) when people inevitably don't keep them in sync, and time lost in finding uncovered code to write tests to realize it was already covered but "not yet claimed". Ref https://gerrit.wikimedia.org/r/q/owner:Krinkle+is:merged+message:Widen While at it, improve purposes and explainations of several mail-related classes, and set `@since`: - EmailNotification introduced in r22110 (1.11.0), gita6f6e04841, later moved to a separate file inbf8810d6bc(Ic435bbdbb6). - MailAddress introduced in r12082 (1.6.0, 1.5.7), git5cfddf9a82. - UserMailer converted to class with ::send in r26357 (1.12.0), git353f203ce2. Change-Id: I1216781240bcfabdebf109cef8f995355db0f659
63 lines
1.8 KiB
PHP
63 lines
1.8 KiB
PHP
<?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 MailAddress;
|
|
use StatusValue;
|
|
|
|
/**
|
|
* Interface for sending arbitrary emails.
|
|
*
|
|
* Default implementation is MediaWiki\Mail\Emailer.
|
|
*
|
|
* @internal
|
|
* @since 1.35
|
|
* @ingroup Mail
|
|
*/
|
|
interface IEmailer {
|
|
|
|
/**
|
|
* Sends emails to recipients
|
|
*
|
|
* @since 1.35
|
|
*
|
|
* @param MailAddress|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
|
|
*
|
|
* @phan-param array{replyTo?:?MailAddress,contentType?:string,headers?:array<string,string>} $options
|
|
* @return StatusValue
|
|
*/
|
|
public function send(
|
|
$to,
|
|
MailAddress $from,
|
|
string $subject,
|
|
string $bodyText,
|
|
?string $bodyHtml = null,
|
|
array $options = []
|
|
): StatusValue;
|
|
}
|