Skip to content

Commit

Permalink
Added plugin link
Browse files Browse the repository at this point in the history 
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
  • Loading branch information
@szepeviktor
szepeviktor committed Sep 5, 2015
1 parent ee16cac commit f20d6c5
Show file tree
Hide file tree
Showing 2 changed files with 102 additions and 19 deletions.
20 changes: 19 additions & 1 deletion readme.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ 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.3
Stable tag: 0.4.4
Stable tag: 0.4.5
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Expand Down Expand Up @@ -51,6 +51,16 @@ 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.
Expand Down Expand Up @@ -128,6 +138,14 @@ $mail->addBCC( get_bloginfo( 'admin_email' ) );

== Changelog ==

= 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)

Expand Down
101 changes: 83 additions & 18 deletions smtp-uri.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@
Plugin Name: SMTP URI and logging
Plugin URI: https://github.com/szepeviktor
Description: SMTP settings for WordPress and error logging.
Version: 0.4.4
Version: 0.4.5
License: The MIT License (MIT)
Author: Viktor Szépe
Author URI: http://www.online1.hu/webdesign/
GitHub Plugin URI: https://github.com/szepeviktor/smtp-uri
*/

/*
@TODO Add DKIM header
@TODO Option to skip newsletters.
"X-ALO-EM-Newsletter" /?emtrck= /?emunsub= /plugins/alo-easymail/tr.php?v=
Newsletter
Mailpoet
/* @TODO
Add DKIM header
Option to skip newsletters.
"X-ALO-EM-Newsletter" /?emtrck= /?emunsub= /plugins/alo-easymail/tr.php?v=
Newsletter
Mailpoet
*/

/**
Expand All @@ -28,18 +28,30 @@
class O1_Smtp_Uri {

private $phpmailer = null;
private $from = null;

public function __construct() {

// Remember From address
add_filter( 'wp_mail_from', array( $this, 'set_from' ), 4294967295 );
// Set SMTP options
add_action( 'phpmailer_init', array( $this, 'smtp_options' ), 4294967295 );
// Handle last error
add_action( 'shutdown', array( $this, 'handle_error' ), 4294967295 );
// Settings in Options/Reading
add_action( 'admin_init', array( $this, 'settings_init' ) );
// "Settings" link on Plugins page
add_filter( 'plugin_action_links_' . plugin_basename( __FILE__ ), array( $this, 'plugin_link' ) );
}

public function set_from( $from ) {

$this->from = $from;

return $from;
}


/**
* Set PHPMailer SMTP options from the SMTP_URI named constant.
*
Expand All @@ -58,12 +70,20 @@ public function smtp_options( $mail ) {
// Set callback function for logging message data
$mail->action_function = array( $this, 'callback' );

// Correct invalid From: address
if ( null !== $this->from && ! $mail->validateAddress( $this->from ) ) {
$mail->From = get_bloginfo( 'admin_email' );
}

$smtp_uri = $this->get_smtp_uri();
if ( empty( $smtp_uri ) ) {
return;
}

$uri = parse_url( $smtp_uri );
if ( empty( $uri['scheme'] ) || empty( $uri['host'] ) ) {
return;
}

// Protocol and encryption
switch ( strtolower( $uri['scheme'] ) ) {
Expand All @@ -87,31 +107,41 @@ public function smtp_options( $mail ) {
}

// Host name
if ( empty( $uri['host'] ) ) {
return;
}
$mail->Host = urldecode( $uri['host'] );

// Safe to enable SMTP now
$mail->isSMTP();

// Port
if ( is_int( $uri['port'] ) ) {
if ( ! empty( $uri['port'] ) && is_int( $uri['port'] ) ) {
$mail->Port = $uri['port'];
}

// Authentication
if ( ! empty( $uri['user'] ) && ! empty( $uri['pass'] ) ) {
$mail->SMTPAuth = true;
$mail->Username = urldecode( $uri['user'] );
$mail->Password = urldecode( $uri['pass'] );
$mail->SMTPAuth = true;
}

$mail->isSMTP();
// Bcc admin email or the specified address
if ( ! empty( $uri['path'] ) ) {
if ( '/admin_email' === $uri['path'] ) {
$mail->addBCC( get_bloginfo( 'admin_email' ) );
} else {
$bcc = urldecode( ltrim( $uri['path'], '/' ) );
if ( $mail->validateAddress( $bcc ) ) {
$mail->addBCC( $bcc );
}
}
}

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

// Bcc admin email
//$mail->addBCC( get_bloginfo( 'admin_email' ) );
$query = $this->parse_query( $uri['query'] );
if ( isset( $query['debug'] ) ) {
$mail->SMTPDebug = is_numeric( $query['debug'] ) ? (int)$query['debug'] : 4;
$mail->Debugoutput = 'error_log';
}
}

/**
Expand Down Expand Up @@ -251,6 +281,41 @@ private function esc_log( $data ) {

return $escaped;
}

/**
* Parse URL query string to an array.
*
* @param string $query_string The query string
*
* @return array The query as an array
*/
private function parse_query( $query_string ) {
$query = array();
$names_values_array = explode( '&', $query_string );

foreach ( $names_values_array as $name_value ) {
$name_value_array = explode( '=', $name_value );

// Check field name
if ( empty( $name_value_array[0] ) )
continue;

// Set field value
$query[ $name_value_array[0] ] = isset( $name_value_array[1] ) ? $name_value_array[1] : '';
}

return $query;
}

public function plugin_link( $actions ) {

$link = sprintf( '<a href="%s">Settings</a>',
admin_url( 'options-general.php#smtp_uri' )
);
array_unshift( $actions, $link );

return $actions;
}
}

new O1_Smtp_Uri;

0 comments on commit f20d6c5

Please sign in to comment.