SMTP URI WordPress Plugin
PHP
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
readme.txt
smtp-uri.php

readme.txt

=== SMTP URI and logging ===
Contributors: szepe.viktor
Donate link: https://szepe.net/wp-donate/
Tags: email, mail, send, smtp, starttls, tls, gmail, mandrill, hotmail, outlook
Requires at least: 4.0
Tested up to: 4.7.1
Stable tag: 0.4.8
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

SMTP settings for WordPress and error logging.

== Description ==

Using SMTP protocol to transfer emails ensures solid operations.
It is very easy to set up SMTP. You can find the settings for this plugin at the bottom of WordPress admin menu Options / General.

You should get your SMTP settings from your ISP, hosting provider, webmaster, email provider etc.

Using every option SMTP URI formally looks like this:

`
smtpTLS://USERNAME:PASSWORD@HOST:PORT
`

Thus encryption type and `://` and user name and `:` and password and `@` and mail server name and `:` and port number.
All except encryption type and mail server (host name) are optional.

SMTP encryption types are as follows:

* For encrypted connection (STARTTLS on submission port) start your SMTP URI with `smtpTLS://` - the default port is 587.
* For fully SSL encrypted connection (SMTPS) start it with `smtps://` - the default port is 465.
* For unencrypted connection (plain SMTP) start it with `smtp://` - the default port is 25. This is **not recommended** for non-local servers.

**WARNING!** Use [URL-encoded](http://meyerweb.com/eric/tools/dencoder/) strings.

You can find the settings for this plugin at the bottom of WordPress admin Options / General.

You may define your SMTP URI also in `wp-config.php`:

`
define( 'SMTP_URI', 'smtpTLS://USERNAME:PASSWORD@HOST:PORT' );
`

To set `From:` name and `From:` address use
[WP Mail From II plugin](https://wordpress.org/plugins/wp-mailfrom-ii/).

= SMTP error logging =

SMTP communication errors are logged in PHP error.log and - if
[Sucuri Scanner](https://wordpress.org/plugins/sucuri-scanner/)
plugin is available - are sent to Sucuri and can be viewed in its Alert Logs panel.

= Adding automatic Bcc: address =

An automatic Bcc: address can be set by adding path to SMTP URI: `/admin_email`.

= SMTP debugging =

Add query string to SMTP URI: `?debug`.

Debug level can be set by adding a value: `?debug=4`, possible values: 0,1,2,4

= TODO =

* Option to skip newsletters: ALO Newsletter, Newsletter, Mailpoet.
* Video on installing and setting up this plugin.
* Remove `smtp_uri` option on uninstallation (I hope you won't uninstall it)

= Usage examples =

Unauthenticated local SMTP server on port 25

`
smtp://localhost
`

Unauthenticated local SMTP server on submission port

`
smtpTLS://localhost
`

Authenticated connection to localhost on port 25

`
smtp://john.doe:Secretpwd1@localhost
`

"@" sign in the username, a Gmail example


`
smtps://your.address%40gmail.com:Gmail_password@smtp.gmail.com
`

Sendgrid example

`
smtpTLS://CREDENTIAL-USERNAME:PASSWORD@smtp.sendgrid.net
`

Mandrill example

`
smtpTLS://REGISTERED%40EMAIL:API-KEY@smtp.mandrillapp.com
`

Unauthenticated SMTP server on a custom port

`
smtpTLS://mail.server.net:2525
`

Development goes on on [GitHub](https://github.com/szepeviktor/smtp-uri).

== Installation ==

This section describes how to install the plugin and get it working.

1. Upload `smtp-uri.php` to the `/wp-content/plugins/svn-updater/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress

== Frequently Asked Questions ==

= Is it possible to hack in this plugin? =

You may uncomment debugging and automatic Bcc.

`
// Turn on SMTP debugging
$mail->SMTPDebug = 4;
$mail->Debugoutput = 'error_log';

// Bcc admin email
$mail->addBCC( get_bloginfo( 'admin_email' ) );
`

== Changelog ==

= 0.4.8 =
* Remove X-Mailer header

= 0.4.7 =
* Added title to SMTP URI input field when constant is defined
* WP 4.4 compatibility

= 0.4.6 =
* Test URL query before using it

= 0.4.5 =
* Added plugin link
* Added invalid From: address detection , correction is to set `admin_email`
* An automatic Bcc: address can be set by adding path to SMTP URI: `/admin_email`
* Adding any other path sets automatic Bcc: address, remember to use URL encoding, %40 for `@`
* SMTP debug to PHP error.log can be turned on by adding query string to SMTP URI: `?debug`
* Debug level can be set by adding a value: `?debug=4`, possible values: 0,1,2,4

= 0.4.4 =
* Encryption is explicitly disabled when using `smtp://` (PHP 5.6 requires valid certificate)

= 0.4.3 =
* Reorder and rephrase things

= 0.4.2 =
* Initial release on WordPress.org

= 0.4.1 =
* Releases up to 0.4.1 are available on [GitHub](https://github.com/szepeviktor/wordpress-plugin-construction)