Open main menu

Manual:$wgSMTP

(Redirected from Manual:Email)

Other languages:
English • ‎français • ‎magyar • ‎polski • ‎português do Brasil • ‎中文 • ‎日本語
Email settings: $wgSMTP
For using a direct (authenticated) SMTP server connection.
Introduced in version:1.2.0
Removed in version:still in use
Allowed values:see below
Default value:false

Contents

Details

For using a direct (authenticated) SMTP server connection, you need to fill an array with details about your connection. Set to false (the default value) to use the built-in PHP mail() function.

For example:

$wgSMTP = [
    'host'     => "mail.example.com", // could also be an IP address. Where the SMTP server is located
    'IDHost'   => "example.com",      // Generally this will be the domain name of your website (aka mywiki.org)
    'port'     => 25,                 // Port to use when connecting to the SMTP server
    'auth'     => true,               // Should we use SMTP authentication (true or false)
    'username' => "my_user_name",     // Username to use for SMTP authentication (if being used)
    'password' => "my_password"       // Password to use for SMTP authentication (if being used)
];

'IDHost' is a MediaWiki-specific setting used to build the Message-ID email header (see RFC 2822, sec 3.6.4 for more information on a properly formatted Message-ID). If not provided, will default to $wgServer . For the remaining settings, see Mail::factory() for a more complete description. (Scroll down to the smtp parameter.)

Install dependencies (MW 1.31 and earlier)
  Warning: This setting requires PEAR's Mail package to be installed (run pear install MAIL Net_SMTP, and you can run pear list to confirm). Since MediaWiki 1.27 (git #a372e170), the required PEAR dependencies are already bundled. If you get an error message stating that pear is not installed, then install php-pear and then try again. It may also cause conflicts if you have different versions of those PEAR packages installed on your system. In that case, you can remove the installed ones with the command pear uninstall mail pear/Auth_SASL net_smtp

You may also install pear/mail with Composer with the command:

composer require pear/mail

MediaWiki 1.31 added pear/mail to the required section of composer.json, thereby bundling it. Previously (MW 1.26 to 1.30) it had only be in the suggest section. As such, for MW 1.31+ installation of pear/mail is not required. However, pear/net_smtp was not added to composer.json until MW 1.32, and thus it must be installed. For MediaWiki 1.30 and earlier pear/mail must be installed.

These packages can be installed with Composer by creating a composer.local.json like:

{
	"require": {
		"pear/mail": "1.4.1",
		"pear/net_smtp": "1.8.0"
	}
}

See Composer#Using_composer-merge-plugin.


Examples

Outlook Exchange Server

$wgSMTP = [
    'host'     => "outlook.corporatedomain.com",
    'IDHost'   => "corporatationname.com",
    'port'     => 25,
    'auth'     => false,
    'username' => "name@corporationname.com",
    'password' => "pw1245"
];

Gmail

Note that you'll need to use an "App password" instead of your usual Gmail password, as explained here.

$wgSMTP = [
    'host' => 'ssl://smtp.gmail.com',
    'IDHost' => 'gmail.com',
    'localhost' => 'myservername.org',
    'port' => 465,
    'username' => 'myemail@gmail.com',
    'password' => '16 digit special gmail app password',
    'auth' => true
];

After this you may get an authentication failure type error. You will need to sign into the gmail account you are using and verify that the person that just signed in is you. You only need to verify this one time. (gmail will send you an email and you just follow the instructions)

AWS SES

Amazon Web Services' Simple E-mail Service can be used for SMTP support. Note that if your AWS SES instance is configured in 'Sandbox' mode you should change your settings to configuration parameters $wgPasswordSender and $wgEmergencyContact to an email address that you have verified in the AWS SES console. If new users register and they are not in the verified list, they will not get the email and you will be limited to 200 emails per day!

$wgSMTP = [
    'host' => 'tls://email-smtp.us-east-1.amazonaws.com', // Provided by Amazon SES to you
    'IDHost' => 'email-smtp.us-east-1.amazonaws.com', // Provided by Amazon SES to you
    'port' => 465,
    'username' => 'ISJAKSJAETQKJSAS8RP3LSFA', // Provided by Amazon SES to you
    'password' => '13HJASHjhjhjHAkjhkhA/hUfJHSIFAjjAskJADOIW2',  // Provided by Amazon SES to you
    'auth' => true
];

Troubleshooting

Error sending mail: Unknown error in PHP's mail() function MediaWiki

Be sure that $wgEmergencyContact and $wgPasswordSender are set correctly, and match your email address. Some hosts will reject to send an email with a sender that doesn't match the account that sends the email.

Be sure you have installed the packages required to send the mail.

$ sudo pear install mail
$ sudo pear install net_smtp

See also possible issues in task T32260.

If your server has SELinux enabled, be sure to configure it correctly to enable sending mails from the webserver.

Error sending mail: authentication failure SMTP: STARTTLS

PEAR's mail will try to use TLS when connecting to the mail server if the server supports it, even if you don't specify ssl:// in the host. But if the server certificate is not valid (CA not trusted, certificate has expired, CN does not match server name/IP address, etc) it will refuse to work, and instead you'll get the following error:

authentication failure [SMTP: STARTTLS failed (code: 220, response: begin TLS negotiation)]

You must fix the certificate issues for mail to work.

Timeout issue with AWS SES

By default, Amazon EC2 throttles traffic on SMTP port 25 for all instances. If you continue to receive timeout errors using SMTP port 25, you can request that the throttle be removed or you can change the port that is used for sending (for example, 587). For more information, see How do I troubleshoot SMTP connectivity or timeout issues with Amazon SES?

See also