Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#69: support eu.sparkpost.com #78

Closed
wants to merge 1 commit into from
Closed

#69: support eu.sparkpost.com #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions CRM/Admin/Form/Setting/Sparkpost.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,12 @@ public function buildQuickForm() {
// Check dependencies and display error messages
sparkpost_check_dependencies();

$this->addYesNo('sparkpost_EU', ts('Is your account is declared in Europe?'));
$this->add('password', 'sparkpost_apiKey', ts('API Key'), '', TRUE);
$this->add('text', 'sparkpost_ipPool', ts('IP pool'));
$this->addYesNo('sparkpost_useBackupMailer', ts('Use backup mailer'));
$this->add('text', 'sparkpost_customCallbackUrl', ts('Custom callback URL'));
$this->addYesNo('sparkpost_track', ts('Allow Sparkpost to track openend mails ?'));

$this->_testButtonName = $this->getButtonName('refresh', 'test');

Expand Down Expand Up @@ -91,7 +93,7 @@ public function postProcess() {
CRM_Utils_System::flushCache();

$formValues = $this->controller->exportValues($this->_name);
foreach (array('sparkpost_apiKey', 'sparkpost_ipPool', 'sparkpost_useBackupMailer', 'sparkpost_customCallbackUrl') as $name) {
foreach (array('sparkpost_apiKey', 'sparkpost_ipPool', 'sparkpost_useBackupMailer', 'sparkpost_customCallbackUrl', 'sparkpost_track', 'sparkpost_EU') as $name) {
CRM_Sparkpost::setSetting($name, $formValues[$name]);
}

Expand All @@ -116,11 +118,19 @@ public function postProcess() {

// Test that the sending domain is correctly configured
$domain = substr(strrchr($domainEmailAddress, "@"), 1);
$is_EU = CRM_Sparkpost::getSetting('sparkpost_EU');
if ($is_EU) {
$sp_domain = "eu.sparkpost.com";
}
else {
$sp_domain = "sparkpost.com";
}

try {
$response = CRM_Sparkpost::call("sending-domains/$domain");
} catch (Exception $e) {
if (strpos($e->getMessage(), 'Invalid request') !== FALSE) {
$url = "https://app.sparkpost.com/account/sending-domains";
$url = "https://app." . $sp_domain . "/account/sending-domains";
CRM_Core_Session::setStatus(ts('Domain %1 is not created and not verified in Sparkpost. Please follow instructions at <a href="%2">%2</a>.',
array(1 => $domain, 2 => $url)), ts('SparkPost error'), 'error');
return;
Expand All @@ -131,7 +141,7 @@ public function postProcess() {
}
}
if (!$response->results || !$response->results->status || !$response->results->status->ownership_verified) {
$url = 'https://app.sparkpost.com/account/sending-domains';
$url = "https://app." . $sp_domain . "/account/sending-domains";
CRM_Core_Session::setStatus(ts('The domain \'%1\' is not verified. Please follow instructions at <a href="%2">%2</a>.',
array(1 => $domain, 2 => $url)), ts('SparkPost error'), 'errors');
return;
Expand Down
17 changes: 13 additions & 4 deletions CRM/Sparkpost.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,11 @@ static function getSetting($setting = NULL) {
// Start with the default values for settings
$settings = array(
'sparkpost_useBackupMailer' => false,
'sparkpost_track' => false,
'sparkpost_EU' => false,
);
// Merge the settings defined in DB (no more groups in 4.7, so has to be one by one ...)
foreach (array('sparkpost_apiKey', 'sparkpost_useBackupMailer', 'sparkpost_campaign', 'sparkpost_ipPool', 'sparkpost_customCallbackUrl') as $name) {
foreach (array('sparkpost_apiKey', 'sparkpost_useBackupMailer', 'sparkpost_campaign', 'sparkpost_ipPool', 'sparkpost_customCallbackUrl', 'sparkpost_track', 'sparkpost_EU' ) as $name) {
$value = CRM_Core_BAO_Setting::getItem(CRM_Sparkpost::SPARKPOST_EXTENSION_SETTINGS, $name);
if (!is_null($value)) {
$settings[$name] = $value;
Expand Down Expand Up @@ -81,8 +83,15 @@ static function call($path, $params = array(), $content = array()) {
}

// Initialize connection and set headers
$is_EU = CRM_Sparkpost::getSetting('sparkpost_EU');
if ($is_EU) {
$sp_domain = "eu.sparkpost.com";
}
else {
$sp_domain = "sparkpost.com";
}
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sparkpost.com/api/v1/$path");
curl_setopt($ch, CURLOPT_URL, "https://api." . $sp_domain ."/api/v1/" . $path);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
$request_headers = array();
$request_headers[] = 'Content-Type: application/json';
Expand Down Expand Up @@ -152,11 +161,11 @@ static function call($path, $params = array(), $content = array()) {
throw new Exception("Sparkpost error: Sending limits exceeded. Check your limits in the Sparkpost console.", CRM_Sparkpost::FALLBACK);
}
// Don't have specifics, so throw a generic exception
throw new Exception("Sparkpost error: HTTP return code $curl_info[http_code], Sparkpost error code $error->code ($error->message: $error->description). Check https://support.sparkpost.com/customer/en/portal/articles/2140916-extended-error-codes for interpretation.");
throw new Exception("Sparkpost error: HTTP return code $curl_info[http_code], Sparkpost error code $error->code ($error->message: $error->description). Check https://support." . $sp_domain . "/customer/en/portal/articles/2140916-extended-error-codes for interpretation.");
}
}

// Return (valid) response
return $response;
}
}
}
23 changes: 17 additions & 6 deletions Mail/Sparkpost.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,12 +72,23 @@ function send($recipients, $headers, $body) {
list($from, $textHeaders) = $headerElements;

// Default options: do not track opens and clicks as CiviCRM does it
$request_body = array(
'options' => array(
'open_tracking' => FALSE, // This will be done by CiviCRM
'click_tracking' => FALSE, // ditto
)
);
$sp_tracking = CRM_Sparkpost::getSetting('sparkpost_track');
if ($sp_tracking) {
$request_body = array(
'options' => array(
'open_tracking' => TRUE, // This will be done by CiviCRM
'click_tracking' => TRUE, // ditto
)
);
}
else {
$request_body = array(
'options' => array(
'open_tracking' => FALSE, // This will be done by CiviCRM
'click_tracking' => FALSE, // ditto
)
);
}
// Should we send via a dedicated IP pool?
$ip_pool = CRM_Sparkpost::getSetting('sparkpost_ipPool');
if (!empty($ip_pool)) {
Expand Down
28 changes: 27 additions & 1 deletion settings/Sparkpost.setting.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,19 @@
require_once(__DIR__ . "/../CRM/Sparkpost.php");

return array(
'sparkpost_EU' => array(
'group_name' => CRM_Sparkpost::SPARKPOST_EXTENSION_SETTINGS,
'group' => 'com.cividesk.email.sparkpost',
'name' => 'sparkpost_EU',
'type' => 'Boolean',
'html_type' => 'radio',
'default' => FALSE,
'add' => '4.4',
'is_domain' => 1,
'is_contact' => 0,
'description' => 'Is your account is declared in Europe?',
'help_text' => 'European accounts have to use *.eu.sparkpost.com',
),
'sparkpost_apiKey' => array(
'group_name' => CRM_Sparkpost::SPARKPOST_EXTENSION_SETTINGS,
'group' => 'com.cividesk.email.sparkpost',
Expand All @@ -17,7 +30,7 @@
'is_domain' => 1,
'is_contact' => 0,
'description' => 'SparkPost REST API key',
'help_text' => 'You can create API keys at: https://app.sparkpost.com/account/api-keys',
'help_text' => 'You can create API keys at: https://app.sparkpost.com/account/credentials, or https://app.eu.sparkpost.com/account/credentials for european accounts',
),
'sparkpost_customCallbackUrl' => array(
'group_name' => CRM_Sparkpost::SPARKPOST_EXTENSION_SETTINGS,
Expand Down Expand Up @@ -45,4 +58,17 @@
'description' => 'Use backup mailer?',
'help_text' => 'The backup mailer will be used if Sparkpost cannot send emails (unverified sending domain, sending limits exceeded, ...).',
),
'sparkpost_track' => array(
'group_name' => CRM_Sparkpost::SPARKPOST_EXTENSION_SETTINGS,
'group' => 'com.cividesk.email.sparkpost',
'name' => 'sparkpost_track',
'type' => 'Boolean',
'html_type' => 'radio',
'default' => FALSE,
'add' => '4.4',
'is_domain' => 1,
'is_contact' => 0,
'description' => 'Allow Sparkpost to track opened mails ?',
'help_text' => 'Allow to track activities of transactionnal mails',
),
);
14 changes: 14 additions & 0 deletions templates/CRM/Admin/Form/Setting/Sparkpost.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,13 @@
<fieldset>
<legend>{ts}SparkPost Configuration{/ts}</legend>
<table class="form-layout-compressed">
<tr class="crm-sparkpost-form-block-sparkpost_EU">
<td class="label">{$form.sparkpost_EU.label}</td>
<td>{$form.sparkpost_EU.html}<br />
<span class="description">{ts}Is your account is declared in Europe?{/ts}
</span>
</td>
</tr>
<tr class="crm-sparkpost-form-block-sparkpost_apiKey">
<td class="label">{$form.sparkpost_apiKey.label}</td>
<td>{$form.sparkpost_apiKey.html}<br />
Expand Down Expand Up @@ -37,6 +44,13 @@
</span>
</td>
</tr>
<tr class="crm-sparkpost-form-block-sparkpost_track">
<td class="label">{$form.sparkpost_track.label}</td>
<td>{$form.sparkpost_track.html}<br />
<span class="description">{ts}Allow Sparkpost to track opened mails ?{/ts}
</span>
</td>
</tr>
</table>
</fieldset>
</div>
Expand Down