MediaWiki
REL1_22
|
Collection of static functions for sending mail. More...
Static Public Member Functions | |
static | arrayToHeaderString ($headers, $endl="\n") |
Creates a single string from an associative array. | |
static | errorHandler ($code, $string) |
Set the mail error message in self::$mErrorString. | |
static | makeMsgId () |
Create a value suitable for the MessageId Header. | |
static | quotedPrintable ($string, $charset= '') |
Converts a string into quoted-printable format. | |
static | rfc822Phrase ($phrase) |
Converts a string into a valid RFC 822 "phrase", such as is used for the sender name. | |
static | send ($to, $from, $subject, $body, $replyto=null, $contentType= 'text/plain;charset=UTF-8') |
This function will perform a direct (authenticated) login to a SMTP Server to use for mail relaying if 'wgSMTP' specifies an array of parameters. | |
Static Public Attributes | |
static | $mErrorString |
Static Protected Member Functions | |
static | quotedPrintableCallback ($matches) |
static | sendWithPear ($mailer, $dest, $headers, $body) |
Send mail using a PEAR mailer. |
Collection of static functions for sending mail.
Definition at line 83 of file UserMailer.php.
static UserMailer::arrayToHeaderString | ( | $ | headers, |
$ | endl = "\n" |
||
) | [static] |
Creates a single string from an associative array.
array | $headers | Associative Array: keys are header field names, values are ... values. |
string | $endl | The end of line character. Defaults to "\n" |
Note RFC2822 says newlines must be CRLF (
) but php mail naively "corrects" it and requires
for the "correction" to work
Definition at line 120 of file UserMailer.php.
References $name, $value, array(), and as.
Referenced by send().
static UserMailer::errorHandler | ( | $ | code, |
$ | string | ||
) | [static] |
Set the mail error message in self::$mErrorString.
$code | Integer: error number | |
string | $string | error message |
Definition at line 387 of file UserMailer.php.
static UserMailer::makeMsgId | ( | ) | [static] |
Create a value suitable for the MessageId Header.
Definition at line 133 of file UserMailer.php.
References global, wfParseUrl(), and wfWikiID().
Referenced by send().
static UserMailer::quotedPrintable | ( | $ | string, |
$ | charset = '' |
||
) | [static] |
Converts a string into quoted-printable format.
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
Definition at line 412 of file UserMailer.php.
References $out, array(), and empty.
Referenced by send(), UserMailerTest\testQuotedPrintable(), and MailAddress\toString().
static UserMailer::quotedPrintableCallback | ( | $ | matches | ) | [static, protected] |
Definition at line 432 of file UserMailer.php.
References $matches.
static UserMailer::rfc822Phrase | ( | $ | phrase | ) | [static] |
Converts a string into a valid RFC 822 "phrase", such as is used for the sender name.
$phrase | string |
Definition at line 396 of file UserMailer.php.
References array().
static UserMailer::send | ( | $ | to, |
$ | from, | ||
$ | subject, | ||
$ | body, | ||
$ | replyto = null , |
||
$ | contentType = 'text/plain; charset=UTF-8' |
||
) | [static] |
This function will perform a direct (authenticated) login to a SMTP Server to use for mail relaying if 'wgSMTP' specifies an array of parameters.
It requires PEAR:Mail to do that. Otherwise it just uses the standard PHP 'mail' function.
$to | MailAddress: recipient's email (or an array of them) | |
$from | MailAddress: sender's email | |
string | $subject | email's subject. |
string | $body | email's text or Array of two strings to be the text and html bodies |
$replyto | MailAddress: optional reply-to email (default: null). | |
string | $contentType | optional custom Content-Type (default: text/plain; charset=UTF-8) |
MWException |
Definition at line 161 of file UserMailer.php.
References $mime, $ret, array(), arrayToHeaderString(), as, MWTimestamp\getLocalInstance(), global, mail, makeMsgId(), Status\newFatal(), Status\newGood(), quotedPrintable(), sendWithPear(), wfDebug(), wfIniGetBool(), wfIsWindows(), wfRestoreWarnings(), wfRunHooks(), and wfSuppressWarnings().
Referenced by EmaillingJob\run().
static UserMailer::sendWithPear | ( | $ | mailer, |
$ | dest, | ||
$ | headers, | ||
$ | body | ||
) | [static, protected] |
Send mail using a PEAR mailer.
$mailer | |
$dest | |
$headers | |
$body |
Definition at line 96 of file UserMailer.php.
References Status\newFatal(), Status\newGood(), and wfDebug().
Referenced by send().
UserMailer::$mErrorString [static] |
Definition at line 84 of file UserMailer.php.