mecachisenros/civicrm-ses

ses

This extension exposes a webhook page to process bounces from Amazon SES (Simple Email Service) through Amazon SNS (Simple Notification Service) notifications.

The extension is licensed under AGPL-3.0.

Requirements

• PHP v7.1+
• CiviCRM 5.19+

Installation

See: https://docs.civicrm.org/sysadmin/en/latest/customize/extensions/#installing-a-new-extension

Usage

The webhook verifies that the Notification or SubscriptionConfirmation it's been originated and sent by the SNS service (as per SNS docs), if the Notification is a SubscriptionConfirmation it automatically subscribes to it, if it's a Bounce, it maps SES' bounce type to Civi's bounce type.

Hard bounce mapping

SES	CiviCRM
Undetermined	Syntax
General, NoEmail, Suppressed	Invalid

Soft bounce mapping

SES	CiviCRM
General	Syntax
MessageTooLarge, MailboxFull	Quota
ContentRejected, AttachmentRejected	Spam

Please see Amazon's guide and documentation on how to setup SNS notifications for SES.

Webhook url:

• WordPress: https://example.org/?page=CiviCRM&q=civicrm%2fses%2fwebhook
• Drupal: https://example.org/civicrm/ses/webhook

Future features/wishes/would like to do

• Send using API (instead of SMTP)
• UI to create Topic and Subscription without leaving CiviCRM
• Send statistics, and reputation dashlets

Also see: https://github.com/mecachisenros/aws which could replace this extension in the future.

Known Issues

None that I'm aware of, report here if you find any and be aware that this extension is at a beta stage.

civicrm-ses's Issues

Forward mailing using action.forward token bounces due to unverified sender.

1. Create and send a mailing containing the action.forward token.
2. Recipient clicks the Forward link and is taken to the Forward Mailing page (/civicrm/mailing/forward).
3. Recipient enters one or more email addresses to receive the mailing and clicks the Forward button.
4. Each of the forwarded messages bounce with code: 554, response: Message rejected: Email address is not verified.

This happens because the messages contain the email address of the original recipient as the sender which is an unverified email address. Amazon SES requires the sender email to be a verified address.

There is a feature request on the Amazon AWS forum about using SES to send "on behalf of" users' personal email addresses that has not been implemented.

SNS configuration question

The SNS "create subscription" page asks for the protocol of the endpoint. I'm unsure whether the correct answer is "HTTPS" or "Platform application endpoint". Can you clarify? Thanks.

How to debug?

I'm trying to get this set up and am having trouble. Amazon says my SNS HTTPS subscription was confirmed successfully, and my CloudWatch logs say that notifications are being delivered. But no new contacts are showing up as on hold, and no new bounces are showing up in CiviCRM.

What do I need to check to figure this out?

Bounce not processed if VERP Localpart configured

Function get_verp_items() does not account for Localpart if configured in CiviMail account settings, and bounce processing will fail if present.

CRM/Ses/Page/Webhook.php::get_verp_items() should be something like this:

protected function get_verp_items( $header_value ) {
	$localpart = CRM_Core_BAO_MailSettings::defaultLocalpart();
	$verp_items = substr( substr( $header_value, 0, strpos( $header_value, '@' ) ), sizeof( $localpart ) + 2 );
	return explode( $this->verp_separator, $verp_items );
}