The point of this application is to receive requests to send emails over RabbitMQ and then dispense those emails as templated messages via SendGrid.
Ensure that the configuration, or environment variables, contain the following keys:
| key | description |
|---|---|
| sendgridapikey | The API key for SendGrid |
| rabbithost | The endpoint of the RabbitMQ message broker |
| rabbituser | The username for the RabbitMQ message broker |
| rabbitpass | The password for the RabbitMQ message broker |
| configfile | The destination of the config JSON file (should be on the persistent volume) |
| username | A username for accessing the HTTP API and changing the config |
| password | A password for accessing the HTTP API and changing the config |
Here are the Kubernetes manifests which are exemplary for setting up Bunnymail in k8s.
It creates a PersistentVolume, a PersistentVolumeClaim, a Service and a Deployment.
| Running them as-is will not work, you need to add your own configuration specific to your system. Use of Helm and Secrets is recommended.
A message similar to the following is sent via the message queue to the mail.out exchange:
{
"event": "password-reset",
"recipient": "example@contoso.com",
"data": {
"resetLink": "https://contoso.com/pwdreset?q=jhr3D3rTU28D734D="
}
}The event specified the template to use. This maps to a SendGrid template in the Sqlite database which is turned into a message.
Event-Template mapping requires the following parameters, in addition to the event name:
{
"templateId": "d-mytemplateid123",
"fromAddress": "no-reply@contoso.com",
"fromName": "Hypercombiglobalmeganet"
}Basic authentication is used. There is only one user, whose username and password are set via the environment variables.
You can open up the route to /swagger with the environment variable, then the documentation for editing template parameters via the API will be visible.