kinto-emailer 4.0.0

Validate configuration

The following command will send a dummy email to the specified recipient or will fail if the configuration is not correct:

$ kinto-send-email config/kinto.ini testemailer@restmail.net

Development

Use a fake emailer that write emails files to disk:

mail.debug_mailer = true

Recipients

The list of recipients can either contain:

• Email adresses (eg. alice@wonderland.com or "Joe Doe <jon@doe.com>")

• Group URI (eg. /buckets/staging/groups/reviewers)

With group URIs, the email recipients will be expanded with the group members principals look like email addresses (eg. ldap:peace@world.org).

Selection

It is possible to define several hooks, and filter on some condition. For example:

{
  "kinto-emailer": {
    "hooks": [{
      "resource_name": "record",
      "action": "create",
      "template": "Record created!",
      "recipients": ['Security reviewers <security-reviews@mozilla.com>']
    }, {
      "resource_name": "collection",
      "action": "updated",
      "template": "Collection updated!",
      "recipients": ["Security reviewers <security-reviews@mozilla.com>"]
    }]
  }
}

The possible filters are:

• resource_name: record or collection (default: all)

• action: create, update, delete (default: all)

• collection_id (default: all)

• record_id (default: all)

• event: kinto.core.events.AfterResourceChanged (default), or kinto_remote_settings.signer.events.ReviewRequested, kinto_remote_settings.signer.events.ReviewApproved, kinto_remote_settings.signer.events.ReviewRejected

If a filter value starts with the special character ^, then the matching will consider the filter value to be a regular expression.

For example, in order to exclude a specific collection_id, set the filter value to: ^(?!normandy-recipes$).

Template

The template string can have placeholders:

• bucket_id

• id: record or collection id

• user_id

• resource_name

• uri

• action

• timestamp

• root_url

• client_address

• user_agent

• settings[name]

For example:

{user_id} has {action}d a {resource_name} in {bucket_id}.

See Kinto core notifications.

Functional Tests

A PostgreSQL database is required.

Install and run PostgreSQL using your system package manager, or using Docker:

$ docker run -e POSTGRES_PASSWORD=postgres -p 5432:5432 postgres:15

Create the test database:

$ psql -c "CREATE DATABASE testdb ENCODING 'UTF8' TEMPLATE template0;" -U postgres -h localhost -p 5432

Run a Kinto instance in a separate terminal:

$ make run-kinto

And start the test suite:

$ make functional