diff options
Diffstat (limited to 'Postman/Postman-Mail/PostmanMailgunTransport.php')
| -rw-r--r-- | Postman/Postman-Mail/PostmanMailgunTransport.php | 267 |
1 files changed, 0 insertions, 267 deletions
diff --git a/Postman/Postman-Mail/PostmanMailgunTransport.php b/Postman/Postman-Mail/PostmanMailgunTransport.php deleted file mode 100644 index b56cadf..0000000 --- a/Postman/Postman-Mail/PostmanMailgunTransport.php +++ /dev/null @@ -1,267 +0,0 @@ -<?php -if ( ! defined( 'ABSPATH' ) ) { - exit; // Exit if accessed directly -} - -require_once 'PostmanModuleTransport.php'; -/** - * Postman Mailgun module - * - * @author jasonhendriks - */ -class PostmanMailgunTransport extends PostmanAbstractModuleTransport implements PostmanModuleTransport { - const SLUG = 'mailgun_api'; - const PORT = 443; - const HOST = 'api.mailgun.net'; - const EU_REGION = 'api.eu.mailgun.net'; - const PRIORITY = 8000; - const MAILGUN_AUTH_OPTIONS = 'postman_mailgun_auth_options'; - const MAILGUN_AUTH_SECTION = 'postman_mailgun_auth_section'; - - /** - * - * @param mixed $rootPluginFilenameAndPath - */ - public function __construct( $rootPluginFilenameAndPath ) { - parent::__construct( $rootPluginFilenameAndPath ); - - // add a hook on the plugins_loaded event - add_action( 'admin_init', array( - $this, - 'on_admin_init', - ) ); - } - public function getProtocol() { - return 'https'; - } - - // this should be standard across all transports - public function getSlug() { - return self::SLUG; - } - public function getName() { - return __( 'Mailgun API', 'post-smtp' ); - } - /** - * v0.2.1 - * - * @return string - */ - public function getHostname() { - return ! is_null( $this->options->getMailgunRegion() ) ? self::EU_REGION : self::HOST; - } - /** - * v0.2.1 - * - * @return int - */ - public function getPort() { - return self::PORT; - } - /** - * v1.7.0 - * - * @return string - */ - public function getTransportType() { - return 'Mailgun_api'; - } - - /** - * (non-PHPdoc) - * - * @see PostmanModuleTransport::createMailEngine() - */ - public function createMailEngine() { - $apiKey = $this->options->getMailgunApiKey(); - $domainName = $this->options->getMailgunDomainName(); - - require_once 'PostmanMailgunMailEngine.php'; - $engine = new PostmanMailgunMailEngine( $apiKey, $domainName ); - return $engine; - } - public function getDeliveryDetails() { - /* translators: where (1) is the secure icon and (2) is the transport name */ - return sprintf( __( 'Post SMTP will send mail via the <b>%1$s %2$s</b>.', 'post-smtp' ), '🔐', $this->getName() ); - } - - /** - * - * @param mixed $data - */ - public function prepareOptionsForExport( $data ) { - $data = parent::prepareOptionsForExport( $data ); - $data [ PostmanOptions::MAILGUN_API_KEY ] = PostmanOptions::getInstance()->getMailgunApiKey(); - return $data; - } - - /** - * (non-PHPdoc) - * - * @see PostmanTransport::getMisconfigurationMessage() - */ - protected function validateTransportConfiguration() { - $messages = parent::validateTransportConfiguration(); - $apiKey = $this->options->getMailgunApiKey(); - $domainName = $this->options->getMailgunDomainName(); - - if ( empty( $apiKey ) ) { - array_push( $messages, __( 'API Key can not be empty', 'post-smtp' ) . '.' ); - $this->setNotConfiguredAndReady(); - } - - if ( empty( $domainName ) ) { - array_push( $messages, __( 'Domain Name can not be empty', 'post-smtp' ) . '.' ); - $this->setNotConfiguredAndReady(); - } - - if ( ! $this->isSenderConfigured() ) { - array_push( $messages, __( 'Message From Address can not be empty', 'post-smtp' ) . '.' ); - $this->setNotConfiguredAndReady(); - } - return $messages; - } - - /** - * (non-PHPdoc) - * - * @see PostmanModuleTransport::getConfigurationBid() - */ - public function getConfigurationBid( PostmanWizardSocket $hostData, $userAuthOverride, $originalSmtpServer ) { - $recommendation = array(); - $recommendation ['priority'] = 0; - $recommendation ['transport'] = self::SLUG; - $recommendation ['hostname'] = null; // scribe looks this - $recommendation ['label'] = $this->getName(); - if ( $hostData->hostname == $this->getHostname() && $hostData->port == self::PORT ) { - $recommendation ['priority'] = self::PRIORITY; - /* translators: where variables are (1) transport name (2) host and (3) port */ - $recommendation ['message'] = sprintf( __( ('Postman recommends the %1$s to host %2$s on port %3$d.') ), $this->getName(), $this->getHostname(), self::PORT ); - } - return $recommendation; - } - - /** - * - * @param mixed $hostname - * @param mixed $response - */ - public function populateConfiguration( $hostname ) { - $response = parent::populateConfiguration( $hostname ); - return $response; - } - - /** - */ - public function createOverrideMenu( PostmanWizardSocket $socket, $winningRecommendation, $userSocketOverride, $userAuthOverride ) { - $overrideItem = parent::createOverrideMenu( $socket, $winningRecommendation, $userSocketOverride, $userAuthOverride ); - // push the authentication options into the $overrideItem structure - $overrideItem ['auth_items'] = array( - array( - 'selected' => true, - 'name' => __( 'API Key', 'post-smtp' ), - 'value' => 'api_key', - ), - ); - return $overrideItem; - } - - /** - * Functions to execute on the admin_init event - * - * "Runs at the beginning of every admin page before the page is rendered." - * ref: http://codex.wordpress.org/Plugin_API/Action_Reference#Actions_Run_During_an_Admin_Page_Request - */ - public function on_admin_init() { - // only administrators should be able to trigger this - if ( PostmanUtils::isAdmin() ) { - $this->addSettings(); - $this->registerStylesAndScripts(); - } - } - - /* - * What follows in the code responsible for creating the Admin Settings page - */ - - /** - */ - public function addSettings() { - // the Mailgun Auth section - add_settings_section( PostmanMailgunTransport::MAILGUN_AUTH_SECTION, __( 'Authentication', 'post-smtp' ), array( - $this, - 'printMailgunAuthSectionInfo', - ), PostmanMailgunTransport::MAILGUN_AUTH_OPTIONS ); - - add_settings_field( PostmanOptions::MAILGUN_API_KEY, __( 'API Key', 'post-smtp' ), array( - $this, - 'mailgun_api_key_callback', - ), PostmanMailgunTransport::MAILGUN_AUTH_OPTIONS, PostmanMailgunTransport::MAILGUN_AUTH_SECTION ); - - add_settings_field( PostmanOptions::MAILGUN_DOMAIN_NAME, __( 'Domain Name', 'post-smtp' ), array( - $this, - 'mailgun_domain_name_callback', - ), PostmanMailgunTransport::MAILGUN_AUTH_OPTIONS, PostmanMailgunTransport::MAILGUN_AUTH_SECTION ); - - add_settings_field( PostmanOptions::MAILGUN_REGION, __( 'Mailgun Europe Region?', 'post-smtp' ), array( - $this, - 'mailgun_region_callback', - ), PostmanMailgunTransport::MAILGUN_AUTH_OPTIONS, PostmanMailgunTransport::MAILGUN_AUTH_SECTION ); - } - public function printMailgunAuthSectionInfo() { - /* Translators: Where (1) is the service URL and (2) is the service name and (3) is a api key URL */ - printf( '<p id="wizard_mailgun_auth_help">%s</p>', sprintf( __( 'Create an account at <a href="%1$s" target="_blank">%2$s</a> and enter <a href="%3$s" target="_blank">an API key</a> below.', 'post-smtp' ), 'https://mailgun.com', 'mailgun.com', 'https://app.mailgun.com/app/domains/' ) ); - } - - /** - */ - public function mailgun_api_key_callback() { - printf( '<input type="password" autocomplete="off" id="mailgun_api_key" name="postman_options[mailgun_api_key]" value="%s" size="60" class="required" placeholder="%s"/>', null !== $this->options->getMailgunApiKey() ? esc_attr( PostmanUtils::obfuscatePassword( $this->options->getMailgunApiKey() ) ) : '', __( 'Required', 'post-smtp' ) ); - print '<input type="button" id="toggleMailgunApiKey" value="Show Password" class="button button-secondary" style="visibility:hidden" />'; - } - - function mailgun_domain_name_callback() { - printf( '<input type="text" autocomplete="off" id="mailgun_domain_name" name="postman_options[mailgun_domain_name]" value="%s" size="60" class="required" placeholder="%s"/>', null !== $this->options->getMailgunDomainName() ? esc_attr( $this->options->getMailgunDomainName() ) : '', __( 'Required', 'post-smtp' ) ); - } - - function mailgun_region_callback() { - $value = $this->options->getMailgunRegion(); - printf( '<input type="checkbox" id="mailgun_region" name="postman_options[mailgun_region]"%s />', null !== $value ? ' checked' : '' ); - } - - /** - */ - public function registerStylesAndScripts() { - // register the stylesheet and javascript external resources - $pluginData = apply_filters( 'postman_get_plugin_metadata', null ); - wp_register_script( 'postman_mailgun_script', plugins_url( 'Postman/Postman-Mail/postman_mailgun.js', $this->rootPluginFilenameAndPath ), array( - PostmanViewController::JQUERY_SCRIPT, - 'jquery_validation', - PostmanViewController::POSTMAN_SCRIPT, - ), $pluginData ['version'] ); - } - - /** - */ - public function enqueueScript() { - wp_enqueue_script( 'postman_mailgun_script' ); - } - - /** - */ - public function printWizardAuthenticationStep() { - print '<section class="wizard_mailgun">'; - $this->printMailgunAuthSectionInfo(); - printf( '<label for="api_key">%s</label>', __( 'API Key', 'post-smtp' ) ); - print '<br />'; - print $this->mailgun_api_key_callback(); - printf( '<label for="domain_name">%s</label>', __( 'Domain Name', 'post-smtp' ) ); - print '<br />'; - print $this->mailgun_domain_name_callback(); - print '<br />'; - printf( '<label for="mailgun_region">%s</label>', __( 'Mailgun Europe Region?', 'post-smtp' ) ); - print '<br />'; - print $this->mailgun_region_callback(); - print '</section>'; - } -} |