1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
<?php
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 PRIORITY = 8000;
const MAILGUN_AUTH_OPTIONS = 'postman_mailgun_auth_options';
const MAILGUN_AUTH_SECTION = 'postman_mailgun_auth_section';
/**
*
* @param unknown $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', Postman::TEXT_DOMAIN );
}
/**
* v0.2.1
*
* @return string
*/
public function getHostname() {
return self::HOST;
}
/**
* v0.2.1
*
* @return string
*/
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>.', Postman::TEXT_DOMAIN ), '🔐', $this->getName() );
}
/**
*
* @param unknown $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', Postman::TEXT_DOMAIN ) . '.' );
$this->setNotConfiguredAndReady();
}
if ( empty( $domainName ) ) {
array_push( $messages, __( 'Domain Name can not be empty', Postman::TEXT_DOMAIN ) . '.' );
$this->setNotConfiguredAndReady();
}
if ( ! $this->isSenderConfigured() ) {
array_push( $messages, __( 'Message From Address can not be empty', Postman::TEXT_DOMAIN ) . '.' );
$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 == self::HOST && $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(), self::HOST, self::PORT );
}
return $recommendation;
}
/**
*
* @param unknown $hostname
* @param unknown $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 Kkey', Postman::TEXT_DOMAIN ),
'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', Postman::TEXT_DOMAIN ), array(
$this,
'printMailgunAuthSectionInfo',
), PostmanMailgunTransport::MAILGUN_AUTH_OPTIONS );
add_settings_field( PostmanOptions::MAILGUN_API_KEY, __( 'API Key', Postman::TEXT_DOMAIN ), array(
$this,
'mailgun_api_key_callback',
), PostmanMailgunTransport::MAILGUN_AUTH_OPTIONS, PostmanMailgunTransport::MAILGUN_AUTH_SECTION );
add_settings_field( PostmanOptions::MAILGUN_DOMAIN_NAME, __( 'Domain Name', Postman::TEXT_DOMAIN ), array(
$this,
'mailgun_domain_name_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.', Postman::TEXT_DOMAIN ), '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', Postman::TEXT_DOMAIN ) );
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', Postman::TEXT_DOMAIN ) );
}
/**
*/
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', Postman::TEXT_DOMAIN ) );
print '<br />';
print $this->mailgun_api_key_callback();
printf( '<label for="domain_name">%s</label>', __( 'Domain Name', Postman::TEXT_DOMAIN ) );
print '<br />';
print $this->mailgun_domain_name_callback();
print '</section>';
}
}
|
