Collection of static functions for sending mail. More...

Static Public Member Functions
static	quotedPrintable ( $string, $charset='')
	Converts a string into quoted-printable format.

static	send ( $to, $from, $subject, $body, $options=[])
	Send a raw email via SMTP (if $wgSMTP is set) or otherwise via PHP mail().

Static Protected Member Functions
static	sendInternal (array $to, MailAddress $from, $subject, $body, $options=[])
	Helper function fo UserMailer::send() which does the actual sending.

static	sendWithPear ( $mailer, $dest, $headers, $body)
	Send mail using a PEAR mailer.

Detailed Description

Collection of static functions for sending mail.

Since: 1.12

Definition at line 38 of file UserMailer.php.

Member Function Documentation

◆ quotedPrintable()

static MediaWiki\Mail\UserMailer::quotedPrintable	(		$string,
			$charset = '' )

static

Converts a string into quoted-printable format.

Since: 1.17

From PHP5.3 there is a built in function quoted_printable_encode() This method does not duplicate that. This method is doing Q encoding inside encoded-words as defined by RFC 2047 This is for email headers. The built in quoted_printable_encode() is for email bodies

Parameters

string	$string
string	$charset

Returns: string

Definition at line 456 of file UserMailer.php.

Referenced by MediaWiki\Mail\UserMailer\sendInternal(), and MediaWiki\Mail\MailAddress\toString().

◆ send()

static MediaWiki\Mail\UserMailer::send	(	$to,
		$from,
		$subject,
		$body,
		$options = [] )

static

Send a raw email via SMTP (if $wgSMTP is set) or otherwise via PHP mail().

This function perform a direct (authenticated) login to a SMTP server, to use for mail relaying, if 'wgSMTP' specifies an array of parameters. This uses the pear/mail package.

Otherwise it uses the standard PHP 'mail' function, which in turn relies on the server's sendmail configuration.

Since: 1.12

Parameters

MailAddress \| MailAddress[]	$to	Recipient's email (or an array of them)
MailAddress	$from	Sender's email
string	$subject	Email's subject.
string \| string[]	$body	Email's text or Array of two strings to be the text and html bodies
array	$options	Keys: 'replyTo' MailAddress 'contentType' string default 'text/plain; charset=UTF-8' 'headers' array Extra headers to set

Returns: Status

Definition at line 106 of file UserMailer.php.

References MediaWiki\MainConfigNames\AllowHTMLEmail, MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Mail\UserMailer\sendInternal(), and wfDebug().

◆ sendInternal()

static MediaWiki\Mail\UserMailer::sendInternal	(	array	$to,
		MailAddress	$from,
			$subject,
			$body,
			$options = [] )

staticprotected

Helper function fo UserMailer::send() which does the actual sending.

It expects a $to list which the UserMailerSplitTo hook would not split further.

Parameters

MailAddress[]	$to	Array of recipients' email addresses
MailAddress	$from	Sender's email
string	$subject	Email's subject.
string \| string[]	$body	Email's text or Array of two strings to be the text and html bodies
array	$options	Keys: 'replyTo' MailAddress 'contentType' string default 'text/plain; charset=UTF-8' 'headers' array Extra headers to set