|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|
|Other settings: Alphabetical | By function|
To send emails (email confirmations, notifications, Special:Emailuser), you should use a third party email provider and allow MediaWiki to send email with it through SMTP. The settings are stored as an array in $wgSMTP. Set to false (the default value) to use the built-in PHP mail() function, but do note that if you do so your emails will most likely end up in the user's spam folder.
$wgSMTP is configured like so:
$wgSMTP = [ 'host' => 'mail.example.com', // could also be an IP address. Where the SMTP server is located. If using SSL or TLS, add the prefix "ssl://" or "tls://". 'IDHost' => 'example.com', // Generally this will be the domain name of your website (aka mywiki.org) 'port' => 587, // 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
- Install dependencies for older versions of MediaWiki (version MediaWiki 1.31 and earlier)
Outlook Exchange Server
$wgSMTP = [ 'host' => 'outlook.corporatedomain.com', // outbox server of the email account 'IDHost' => 'corporationname.com', 'port' => 587, 'auth' => false, 'username' => 'email@example.com', // user of the email account 'password' => '****************' // pass of the email account ];
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', // outbox server of the email account 'IDHost' => 'gmail.com', 'port' => 465, 'username' => 'firstname.lastname@example.org', // user of the email account 'password' => '****************', // app password of the email account '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)
Amazon Web Services' Simple Email 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
$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' => '************************', // Provided by Amazon SES to you 'password' => '******************************************', // Provided by Amazon SES to you 'auth' => true ];
Error sending mail: Unknown error in PHP's mail() function MediaWiki
Be sure that
$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.
If the incorrect port is used, email will timeout without returning an error, and the website will appear unresponsive to the user. Consult your email provider's manual or try the other common SMTP ports: 25, 465, and 587.
- Timeout issues 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?
- Manual:Configuration settings - various settings related to email
- Manual:$wgEnableEmail (enabled by default)