436 lines
15 KiB
PHP
436 lines
15 KiB
PHP
<?php
|
|
if ( ! defined( 'ABSPATH' ) ) {
|
|
exit; // Exit if accessed directly
|
|
}
|
|
|
|
class PostmanSendTestEmailController {
|
|
const EMAIL_TEST_SLUG = 'postman/email_test';
|
|
const RECIPIENT_EMAIL_FIELD_NAME = 'postman_recipient_email';
|
|
|
|
// logging
|
|
private $logger;
|
|
private $options;
|
|
private $allowed_tags = array(
|
|
'input' => array(
|
|
'type' => array(),
|
|
'id' => array(),
|
|
'name' => array(),
|
|
'value' => array(),
|
|
'class' => array(),
|
|
'placeholder' => array(),
|
|
'size' => array(),
|
|
)
|
|
);
|
|
|
|
// Holds the values to be used in the fields callbacks
|
|
private $rootPluginFilenameAndPath;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param mixed $rootPluginFilenameAndPath
|
|
*/
|
|
public function __construct( $rootPluginFilenameAndPath ) {
|
|
assert( ! empty( $rootPluginFilenameAndPath ) );
|
|
assert( PostmanUtils::isAdmin() );
|
|
assert( is_admin() );
|
|
|
|
$this->logger = new PostmanLogger( get_class( $this ) );
|
|
$this->rootPluginFilenameAndPath = $rootPluginFilenameAndPath;
|
|
$this->options = PostmanOptions::getInstance();
|
|
|
|
PostmanUtils::registerAdminMenu( $this, 'addEmailTestSubmenu' );
|
|
|
|
// hook on the init event
|
|
add_action( 'init', array(
|
|
$this,
|
|
'on_init',
|
|
) );
|
|
|
|
// initialize the scripts, stylesheets and form fields
|
|
add_action( 'admin_init', array(
|
|
$this,
|
|
'on_admin_init',
|
|
) );
|
|
}
|
|
|
|
/**
|
|
* Functions to execute on the init event
|
|
*
|
|
* "Typically used by plugins to initialize. The current user is already authenticated by this time."
|
|
* ref: http://codex.wordpress.org/Plugin_API/Action_Reference#Actions_Run_During_a_Typical_Request
|
|
*/
|
|
public function on_init() {
|
|
// register Ajax handlers
|
|
new PostmanSendTestEmailAjaxController();
|
|
}
|
|
|
|
/**
|
|
* Fires on the admin_init method
|
|
*/
|
|
public function on_admin_init() {
|
|
$this->registerStylesAndScripts();
|
|
}
|
|
|
|
/**
|
|
* Get the settings option array and print one of its values
|
|
*/
|
|
public function test_email_callback() {
|
|
return sprintf(
|
|
'<input type="text" id="%s" name="postman_test_options[test_email]" value="%s" class="ps-input required email" size="40"/>',
|
|
esc_attr( self::RECIPIENT_EMAIL_FIELD_NAME ),
|
|
esc_attr( wp_get_current_user()->user_email )
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Register and add settings
|
|
*/
|
|
private function registerStylesAndScripts() {
|
|
if ( $this->logger->isTrace() ) {
|
|
$this->logger->trace( 'registerStylesAndScripts()' );
|
|
}
|
|
|
|
$pluginData = apply_filters( 'postman_get_plugin_metadata', null );
|
|
|
|
// register the stylesheet resource
|
|
wp_register_style( 'postman_send_test_email', plugins_url( 'Postman/Postman-Send-Test-Email/postman_send_test_email.css', $this->rootPluginFilenameAndPath ), PostmanViewController::POSTMAN_STYLE, $pluginData ['version'] );
|
|
|
|
// register the javascript resource
|
|
wp_register_script( 'postman_test_email_wizard_script', plugins_url( 'Postman/Postman-Send-Test-Email/postman_send_test_email.js', $this->rootPluginFilenameAndPath ), array(
|
|
PostmanViewController::JQUERY_SCRIPT,
|
|
'jquery_validation',
|
|
'jquery_steps_script',
|
|
PostmanViewController::POSTMAN_SCRIPT,
|
|
), $pluginData ['version'] );
|
|
}
|
|
|
|
/**
|
|
* Register the Email Test screen
|
|
*/
|
|
public function addEmailTestSubmenu() {
|
|
$page = add_submenu_page(
|
|
'',
|
|
sprintf( '%s', esc_html__( 'Postman SMTP Setup', 'post-smtp' ) ),
|
|
esc_html__( 'Postman SMTP', 'post-smtp' ),
|
|
Postman::MANAGE_POSTMAN_CAPABILITY_NAME, PostmanSendTestEmailController::EMAIL_TEST_SLUG, array(
|
|
$this,
|
|
'outputTestEmailContent',
|
|
) );
|
|
// When the plugin options page is loaded, also load the stylesheet
|
|
add_action( 'admin_print_styles-' . $page, array(
|
|
$this,
|
|
'enqueueEmailTestResources',
|
|
) );
|
|
}
|
|
|
|
/**
|
|
*/
|
|
function enqueueEmailTestResources() {
|
|
wp_enqueue_style( 'jquery_steps_style' );
|
|
wp_enqueue_style( PostmanViewController::POSTMAN_STYLE );
|
|
wp_enqueue_style( 'postman_send_test_email' );
|
|
wp_enqueue_script( 'postman_test_email_wizard_script' );
|
|
wp_localize_script( PostmanViewController::POSTMAN_SCRIPT, 'postman_email_test', array(
|
|
'recipient' => '#' . self::RECIPIENT_EMAIL_FIELD_NAME,
|
|
'not_started' => _x( 'In Outbox', 'Email Test Status', 'post-smtp' ),
|
|
'sending' => _x( 'Sending...', 'Email Test Status', 'post-smtp' ),
|
|
'success' => _x( 'Success', 'Email Test Status', 'post-smtp' ),
|
|
//'failed' => _x( 'Failed', 'Email Test Status', 'post-smtp' ),
|
|
'failed' => sprintf( 'Failed - Check the plugin email log for more info: %s', '<a href="' . esc_url( admin_url( 'admin.php?page=postman_email_log' ) ) . '">Here</a>' ),
|
|
'ajax_error' => __( 'Ajax Error', 'post-smtp' ),
|
|
) );
|
|
}
|
|
|
|
/**
|
|
*/
|
|
public function outputTestEmailContent() {
|
|
print '<div class="wrap">';
|
|
|
|
PostmanViewController::outputChildPageHeader( __( 'Send Test Email', 'post-smtp' ) );
|
|
|
|
printf(
|
|
'<form id="postman_test_email_wizard" method="post" action="%s">',
|
|
esc_url( PostmanUtils::getSettingsPageUrl() )
|
|
);
|
|
|
|
wp_nonce_field('post-smtp', 'security' );
|
|
|
|
// Step 1
|
|
printf( '<h5>%s</h5>', esc_html__( 'Specify the Recipient', 'post-smtp' ) );
|
|
print '<fieldset>';
|
|
printf( '<legend>%s</legend>', esc_html__( 'Who is this message going to?', 'post-smtp' ) );
|
|
printf( '<p>%s', esc_html__( 'This utility allows you to send an email message for testing.', 'post-smtp' ) );
|
|
|
|
/* translators: where %d is an amount of time, in seconds */
|
|
printf(
|
|
'%s</p>',
|
|
sprintf(
|
|
wp_kses_post(
|
|
_n( 'If there is a problem, Postman will give up after %d second.',
|
|
'If there is a problem, Postman will give up after %d seconds.',
|
|
$this->options->getReadTimeout(), 'post-smtp'
|
|
)
|
|
),
|
|
esc_html( $this->options->getReadTimeout() )
|
|
)
|
|
);
|
|
printf( '<label for="postman_test_options[test_email]">%s</label>', esc_attr_x( 'Recipient Email Address', 'Configuration Input Field', 'post-smtp' ) );
|
|
print wp_kses( $this->test_email_callback(), $this->allowed_tags );
|
|
print '</fieldset>';
|
|
|
|
// Step 2
|
|
printf( '<h5>%s</h5>', esc_html__( 'Send The Message', 'post-smtp' ) );
|
|
print '<fieldset>';
|
|
print '<legend>';
|
|
print esc_html__( 'Sending the message:', 'post-smtp' );
|
|
printf( ' <span id="postman_test_message_status">%s</span>', esc_attr_x( 'In Outbox', 'Email Test Status', 'post-smtp' ) );
|
|
print '</legend>';
|
|
print '<section>';
|
|
printf( '<p><label>%s</label></p>', esc_html__( 'Status', 'post-smtp' ) );
|
|
print '<textarea id="postman_test_message_error_message" class="ps-textarea" readonly="readonly" cols="65" rows="4"></textarea>';
|
|
|
|
$transport = PostmanOptions::getInstance()->getTransportType();
|
|
|
|
if(
|
|
version_compare( '8.0.0', phpversion(), '<=' )
|
|
&&
|
|
( $transport == 'smtp' || $transport == 'default' )
|
|
) {
|
|
|
|
echo '
|
|
<div class="ps-broken-mail-notice">
|
|
<span class="dashicons dashicons-info"></span>'.esc_html__( 'Is your email\'s Header or Body broken? ', 'post-smtp' ).'<a href="https://postmansmtp.com/fix-for-broken-emails/" target="_blank">'.esc_html__( 'Learn how to fix', 'post-smtp' ).'</a>.
|
|
</div>
|
|
';
|
|
|
|
}
|
|
|
|
/**
|
|
* Fires after the test email section
|
|
*/
|
|
do_action( 'post_smtp_test_email_section' );
|
|
|
|
print '</section>';
|
|
print '</fieldset>';
|
|
|
|
// Step 3
|
|
printf( '<h5>%s</h5>', esc_html__( 'Session Transcript', 'post-smtp' ) );
|
|
print '<fieldset>';
|
|
printf( '<legend>%s</legend>', esc_html__( 'Examine the Session Transcript if you need to.', 'post-smtp' ) );
|
|
printf(
|
|
'<p>%s <b>%s</b> %s</p>',
|
|
esc_html__( 'This is the conversation between Postman and the mail server. It can be useful for diagnosing problems.', 'post-smtp' ) ,
|
|
esc_html__( 'DO NOT', 'post-smtp' ),
|
|
esc_html__( 'post it on-line, it may contain your account password.', 'post-smtp' )
|
|
);
|
|
print '<section>';
|
|
printf( '<p><label for="postman_test_message_transcript">%s</label></p>', esc_html__( 'Session Transcript', 'post-smtp' ) );
|
|
print '<textarea readonly="readonly" id="postman_test_message_transcript" class="ps-textarea" cols="65" rows="8"></textarea>';
|
|
print '</section>';
|
|
print '</fieldset>';
|
|
|
|
print '</form>';
|
|
print '</div>';
|
|
}
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @author jasonhendriks
|
|
*/
|
|
class PostmanSendTestEmailAjaxController extends PostmanAbstractAjaxHandler {
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param PostmanOptions $options
|
|
* @param PostmanOAuthToken $authorizationToken
|
|
* @param PostmanConfigTextHelper $oauthScribe
|
|
*/
|
|
function __construct() {
|
|
parent::__construct();
|
|
PostmanUtils::registerAjaxHandler( 'postman_send_test_email', $this, 'sendTestEmailViaAjax' );
|
|
}
|
|
|
|
/**
|
|
* Yes, this procedure is just for testing.
|
|
*
|
|
* @return boolean
|
|
*/
|
|
function test_mode() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* This Ajax sends a test email
|
|
*
|
|
* @since 1.0
|
|
* @since 2.0.25 @filter `postman_test_email_args`
|
|
* @version 1.0
|
|
*/
|
|
function sendTestEmailViaAjax() {
|
|
|
|
check_admin_referer('post-smtp', 'security');
|
|
|
|
if( !current_user_can( Postman::MANAGE_POSTMAN_CAPABILITY_NAME ) ) {
|
|
wp_send_json_error(
|
|
array(
|
|
'Message' => 'Unauthorized.'
|
|
),
|
|
401
|
|
);
|
|
}
|
|
|
|
// get the email address of the recipient from the HTTP Request
|
|
$email = $this->getRequestParameter( 'email' );
|
|
|
|
// get the name of the server from the HTTP Request
|
|
$serverName = PostmanUtils::postmanGetServerName();
|
|
|
|
/* translators: where %s is the domain name of the site */
|
|
$subject = sprintf( _x( 'Postman SMTP Test (%s)', 'Test Email Subject', 'post-smtp' ), $serverName );
|
|
|
|
// Postman API: indicate to Postman this is just for testing
|
|
add_filter( 'postman_test_email', array(
|
|
$this,
|
|
'test_mode',
|
|
) );
|
|
|
|
// this header specifies that there are many parts (one text part, one html part)
|
|
$header = 'Content-Type: multipart/alternative;' . "\r\n";
|
|
$header .= 'MIME-Version: 1.0' . "\r\n";
|
|
|
|
// createt the message content
|
|
$message = $this->createMessageContent();
|
|
|
|
$email_args = apply_filters( 'postman_test_email_args', compact( 'email', 'subject', 'message', 'header' ) );
|
|
extract( $email_args );
|
|
|
|
// send the message
|
|
$success = wp_mail( $email, $subject, $message, $header );
|
|
|
|
// Postman API: remove the testing indicator
|
|
remove_filter( 'postman_test_email', array(
|
|
$this,
|
|
'test_mode',
|
|
) );
|
|
|
|
// Postman API: retrieve the result of sending this message from Postman
|
|
$result = apply_filters( 'postman_wp_mail_result', null );
|
|
|
|
// post-handling
|
|
if ( $success ) {
|
|
$this->logger->debug( 'Test Email delivered to server' );
|
|
// the message was sent successfully, generate an appropriate message for the user
|
|
$statusMessage = sprintf( __( 'Your message was delivered (%d ms) to the SMTP server! Congratulations :)', 'post-smtp' ), $result ['time'] );
|
|
|
|
$this->logger->debug( 'statusmessage: ' . $statusMessage );
|
|
|
|
// compose the JSON response for the caller
|
|
$response = array(
|
|
'message' => $statusMessage,
|
|
'transcript' => $result ['transcript'],
|
|
);
|
|
|
|
// log the response
|
|
if ( $this->logger->isTrace() ) {
|
|
$this->logger->trace( 'Ajax Response:' );
|
|
$this->logger->trace( $response );
|
|
}
|
|
|
|
// send the JSON response
|
|
wp_send_json_success( $response );
|
|
} else {
|
|
$this->logger->error( 'Test Email NOT delivered to server - ' . $result ['exception']->getCode() );
|
|
// the message was NOT sent successfully, generate an appropriate message for the user
|
|
$statusMessage = $result ['exception']->getMessage();
|
|
|
|
$this->logger->debug( 'statusmessage: ' . $statusMessage );
|
|
|
|
// compose the JSON response for the caller
|
|
$response = array(
|
|
'message' => $statusMessage,
|
|
'transcript' => $result ['transcript'],
|
|
);
|
|
|
|
// log the response
|
|
if ( $this->logger->isTrace() ) {
|
|
$this->logger->trace( 'Ajax Response:' );
|
|
$this->logger->trace( $response );
|
|
}
|
|
|
|
// send the JSON response
|
|
wp_send_json_error( $response );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Create the multipart message content
|
|
*
|
|
* @return string
|
|
*/
|
|
private function createMessageContent() {
|
|
// Postman API: Get the plugin metadata
|
|
$pluginData = apply_filters( 'postman_get_plugin_metadata', null );
|
|
|
|
/*
|
|
translators: where %s is the Postman plugin version number (e.g. 1.4) */
|
|
// English - Mandarin - French - Hindi - Spanish - Portuguese - Russian - Japanese
|
|
// http://www.pinyin.info/tools/converter/chars2uninumbers.html
|
|
$greeting = 'Hello! - 你好 - Bonjour! - नमस्ते - ¡Hola! - Olá - Привет! - 今日は';
|
|
$sentBy = sprintf( _x( 'Sent by Postman %s', 'Test Email Tagline', 'post-smtp' ), $pluginData ['version'] );
|
|
$imageSource = __( 'Image source', 'post-smtp' );
|
|
$withPermission = __( 'Used with permission', 'post-smtp' );
|
|
$messageArray = array(
|
|
'Content-Type: text/plain; charset = "UTF-8"',
|
|
'Content-Transfer-Encoding: 8bit',
|
|
'',
|
|
'Hello!',
|
|
'',
|
|
sprintf( '%s - https://wordpress.org/plugins/post-smtp/', $sentBy ),
|
|
'',
|
|
'Content-Type: text/html; charset=UTF-8',
|
|
'Content-Transfer-Encoding: quoted-printable',
|
|
'',
|
|
'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">',
|
|
'<html xmlns="http://www.w3.org/1999/xhtml">',
|
|
'<head>',
|
|
'<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />',
|
|
'<style type="text/css" media="all">',
|
|
'.wporg-notification .im {',
|
|
' color: #888;',
|
|
'} /* undo a GMail-inserted style */',
|
|
'</style>',
|
|
'</head>',
|
|
'<body class="wporg-notification">',
|
|
' <div style="background: #e8f6fe; font-family: & quot; Helvetica Neue&quot; , Helvetica ,Arial,sans-serif; font-size: 14px; color: #666; text-align: center; margin: 0; padding: 0">',
|
|
' <table border="0" cellspacing="0" cellpadding="0" bgcolor="#e8f6fe" style="background: #e8f6fe; width: 100%;">',
|
|
' <tbody>',
|
|
' <tr>',
|
|
' <td>',
|
|
' <table border="0" cellspacing="0" cellpadding="0" align="center" style="padding: 0px; width: 100%;"">',
|
|
' <tbody>',
|
|
' <tr>',
|
|
' <td>',
|
|
' <div style="max-width: 600px; height: 400px; margin: 0 auto; overflow: hidden;background-image:url(\'https://ps.w.org/postman-smtp/assets/email/poofytoo.png\');background-repeat: no-repeat;">',
|
|
sprintf( ' <div style="margin:50px 0 0 300px; width:300px; font-size:2em;">%s</div>', $greeting ),
|
|
sprintf( ' <div style="text-align:right;font-size: 1.4em; color:black;margin:150px 0 0 200px;">%s', $sentBy ),
|
|
' <br/>',
|
|
' </div>',
|
|
' </div>',
|
|
' </td>',
|
|
' </tr>',
|
|
' </tbody>',
|
|
' </table>',
|
|
sprintf( ' <br><span style="font-size:0.9em;color:#94c0dc;">%s: poofytoo - %s</span>', $imageSource, $withPermission ),
|
|
' </td>',
|
|
' </tr>',
|
|
' </tbody>',
|
|
' </table>',
|
|
'</body>',
|
|
'</html>',
|
|
);
|
|
return implode( PostmanMessage::EOL, $messageArray );
|
|
}
|
|
} |