Description

Story: https://breedinginsight.atlassian.net/browse/BI-2101

This PR enables bi-api to send transactional email using SMTP provided the EMAIL_RELAY_HOST, EMAIL_RELAY_PORT, EMAIL_RELAY_LOGIN and EMAIL_RELAY_PASSWORD are provided.

I configured DKIM and DMARC records required by SES so that we can send emails from noreply@breedinginsight.org.

I added an item to the v0.10 Deploy Checklist to update the production environment variables.

If the EMAIL_RELAY_LOGIN and EMAIL_RELAY_PASSWORD variables are omitted or empty, the code will continue to use SMTP without auth, which is desirable in development and non-production deployments.

Background Information

1. javax.mail docs: https://javaee.github.io/javamail/docs/api/com/sun/mail/smtp/package-summary.html

There are many configurable properties, it required some trial and error to get everything right.

2. obtaining Amazon SES SMTP credentials: https://docs.aws.amazon.com/ses/latest/dg/smtp-credentials.html

"Your SMTP user name and password are not the same as your AWS access key ID and secret access key."

Dependencies

bi-web develop branch

Testing

Regression Testing

• With your local .env unchanged, ensure you can still use mailhog as usual.

Feature Functional Testing

1. Now, set the following in your .env, the credentials have been shared with the dev team.

   EMAIL_RELAY_HOST=email-smtp.us-east-1.amazonaws.com
   EMAIL_RELAY_PORT=25
   EMAIL_RELAY_LOGIN=*****
   EMAIL_RELAY_PASSWORD=*****
   EMAIL_FROM=noreply@breedinginsight.org

2. See the acceptance criteria on Jira: https://breedinginsight.atlassian.net/browse/BI-2101

Checklist:

• I have performed a self-review of my own code
• I have tested my code and ensured it meets the acceptance criteria of the story
• I have tested that my code works with both the brapi-java-server and BreedBase
• I have create/modified unit tests to cover this change
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to documentation
• I have run TAF: <please include a link to TAF run>