Skip to content

Email Notification

The CEP allows sending email notifications for the following events:

  • Successful login
  • Method enrollment
  • Method updates
  • Method deletion

A notification will only be sent via email if the CEP has access to the email address through AA session information.

Configuration

Examples

Basic Example
    environment:
      - CEP_EMAIL_ENABLED=true
      - CEP_EMAIL_MAILER_DSN=smtps://mail.example.com:25
      - CEP_EMAIL_NOTIFY_ON_LOGIN=true
Full Example Using SMIME Signatures
    volumes:
      - ./emailTemplate.html.twig:/var/www/html/templates/emails/notification.html.twig
      - ./certs/smime.crt.pem:/run/secrets/smime.crt.pem
      - ./certs/smime.crt.pem:/run/secrets/smime.key.pem
    environment:
      - CEP_EMAIL_ENABLED=true
      - CEP_EMAIL_MAILER_DSN=smtps://username%40example.com:secretPassword@mail.example.com:587
      - CEP_EMAIL_NOTIFY_ON_LOGIN=true
      - CEP_EMAIL_NOTIFY_ON_ENROLLMENT=true
      - CEP_EMAIL_NOTIFY_ON_UPDATE=true
      - CEP_EMAIL_NOTIFY_ON_DELETE=true
      - CEP_EMAIL_SMIME_CRT=/run/secrets/smime.crt.pem
      - CEP_EMAIL_SMIME_KEY=/run/secrets/smime.key.pem
      - CEP_EMAIL_SMIME_PASSWORD=secret

CEP_EMAIL_ENABLED

If true email notifications are enabled, additional parameters are required. At a minimum, CEP_EMAIL_MAILER_DSN and one event, such as CEP_EMAIL_NOTIFY_ON_LOGIN, are required.

Example
    environment:
      - CEP_EMAIL_ENABLED=true
Default
    environment:
      - CEP_EMAIL_ENABLED=false

CEP_EMAIL_MAILER_DSN

The DSN of a mail server is used to send notifications. If the username is a fully qualified email address, the "@" sign must be URL encoded.

Example
    environment:
      - CEP_EMAIL_MAILER_DSN=smtp://user%40example.com:password@mail.example.com:587
Default
    environment:
      - CEP_EMAIL_MAILER_DSN=

CEP_EMAIL_NOTIFY_ON_LOGIN

If configured to true, a notification will be sent to users after they have successfully logged in.

Example
    environment:
      - CEP_EMAIL_NOTIFY_ON_LOGIN=true
Default
    environment:
      - CEP_EMAIL_NOTIFY_ON_LOGIN=false

CEP_EMAIL_NOTIFY_ON_ENROLLMENT

If configured to true, a notification will be sent to users if a new method has been enrolled.

Example
    environment:
      - CEP_EMAIL_NOTIFY_ON_ENROLLMENT=true
Default
    environment:
      - CEP_EMAIL_NOTIFY_ON_ENROLLMENT=false

CEP_EMAIL_NOTIFY_ON_UPDATE

If configured to true, a notification will be sent to users if a method has been updated.

Example
    environment:
      - CEP_EMAIL_NOTIFY_ON_UPDATE=true
Default
    environment:
      - CEP_EMAIL_NOTIFY_ON_UPDATE=false

CEP_EMAIL_NOTIFY_ON_DELETE

If configured to true, a notification will be sent to users if a method has been deleted.

Example
    environment:
      - CEP_EMAIL_NOTIFY_ON_DELETE=true
Default
    environment:
      - CEP_EMAIL_NOTIFY_ON_DELETE=false

CEP_EMAIL_SENDER_ADDR

Sender address of all notification emails

Example
    environment:
      - CEP_EMAIL_SENDER_ADDR=user@example.com
Default
    environment:
      - CEP_EMAIL_SENDER_ADDR=

CEP_EMAIL_SENDER_NAME

Name of sender

Example
    environment:
      - CEP_EMAIL_SENDER_NAME=Sender Name
Default
    environment:
      - CEP_EMAIL_SENDER_NAME=

CEP_EMAIL_SMIME_CRT

SMIME Certificate to sign notifications emails.

Example
    environment:
      - CEP_EMAIL_SMIME_CRT=/some/path/within/the/conatiner/cert.pem
Default
    environment:
      - CEP_EMAIL_SMIME_CRT=

CEP_EMAIL_SMIME_KEY

The private key is used for SMIME signatures. If the key is encrypted, CEP_EMAIL_SMIME_PASSWORD must be configured.

Example
    environment:
      - CEP_EMAIL_SMIME_KEY=/some/path/within/the/conatiner/key.pem
Default
    environment:
      - CEP_EMAIL_SMIME_KEY=

CEP_EMAIL_SMIME_PASSWORD

Secret password to decrypt the PEM encoded private key.

Example
    environment:
      - CEP_EMAIL_SMIME_PASSWORD=secret
Default
    environment:
      - CEP_EMAIL_SMIME_PASSWORD=