tubbz-alt / email-alert-api

Sends email alerts to the public for GOV.UK

email-alert-api

Sends emails to users that subscribe to specific GOV.UK email alerts.

Provides a consistent internal interface to external email notification services. Currently supports only GOV.UK Notify.

Nomenclature

• Content change:

  • A publication event that creates or changes a content item
  • The representation of that event for the purpose of sending emails

• Message:

  • A message, distinct from a content change, that can be sent to subscribers of a list
  • The representation of that event for the purpose of sending emails

• Subscriber list:

  • A particular titled list that a user can sign up to
  • Contains criteria to determine which notifications a subscriber will receive (eg. all publications by HMRC)

• Subscriber:

  • A user who has subscribed to one or more subscriber lists

• Subscription:

  • The relationship between a subscriber and the subscription lists they are subscribed to

• Digest run:

  • One batch of either daily or weekly digests representing a particular subscription that has a start and end time and a set of subscribers to send emails to

• Email:

  • An email generated from content changes or messages to be sent to subscribers

Technical documentation

Dependencies

• PostgreSQL database (9.3 or higher - requires json with json_object_keys method)
• Redis (for Sidekiq)
• GOV.UK Notify API key and other details (see email_service.yml for required fields)

Running the application

bundle exec rails server

Running the test suite

bundle exec rspec

Documentation

• Analytics
• API
• Data cleanup mechanisms
• Matching content to subscriber lists
• Support tasks
• ENV vars

Licence

MIT License