https://github.com/lblod/berichtencentrum-email-notification-service

Microservice to create notification emails for newly received messages in berichtencentrum.
https://github.com/lblod/berichtencentrum-email-notification-service

mu-service

Last synced: 21 days ago
JSON representation

Microservice to create notification emails for newly received messages in berichtencentrum.

• Host: GitHub
• URL: https://github.com/lblod/berichtencentrum-email-notification-service
• Owner: lblod
• License: mit
• Created: 2018-12-19T10:40:38.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-03-28T10:24:23.000Z (9 months ago)
• Last Synced: 2024-04-16T06:36:59.679Z (8 months ago)
• Topics: mu-service
• Language: Python
• Homepage:
• Size: 49.8 KB
• Stars: 0
• Watchers: 20
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# berichtencentrum-email-notification-service

Microservice to create notification emails for newly received messages in berichtencentrum. Fetches messages that need a notification to be sent, constructs email messages and places them in the correct outbox.

## Installation

To add the service to your stack, add the following snippet to `docker-compose.yml`:

```

services:

  berichtencentrum-email-notification:

    image: lblod/berichtencentrum-email-notification-service:latest

    environment:

      RUN_INTERVAL: 5

      OUTBOX_FOLDER_URI: "http://data.lblod.info/id/mail-folders/2"

      FROM_EMAIL_ADRESS: "Agentschap Binnenlands Bestuur Vlaanderen "

      LOKET_APP_BASEURL: "https://loket.lokaalbestuur.vlaanderen.be/"

```

## Configuration

### Environment variables

Required environment variables:

* `FROM_EMAIL_ADDRESS`: The email address added in the 'from' header of the sent mail.

* `LOKET_APP_BASEURL`: Base URL of the loket app (so we can supply a working link to the message mentioned in the email)

* `OUTBOX_FOLDER_URI`: URI of the email outbox folder in which the prepared messages must be stored.

Optional environment variables:

* `MU_APPLICATION_GRAPH`

* `MU_SPARQL_ENDPOINT`

* `MU_SPARQL_UPDATEPOINT`

* `BCC_EMAIL_ADDRESSES`: recipients off mails that should be in BCC.

* `RUN_INTERVAL`: How frequent the service to send email notifications must run (in minutes), _default: 5_

* `MAX_MESSAGE_AGE`: Max age of the messages requested to the API (in days), _default: 3_. This value could theoretically be equal to that of `RUN_INTERVAL`, but a margin is advised to take eventual application or API downtime into account (to not miss any older messages).