InnerCircle.EmailSender

Service for sending emails via smtp

Email senders

In this service we use several senders ("Mail SMTP", "SendGrid") for sending emails to recipients.

Send Grid

You must have an account with API key that you will use in this app. If you don't have an account, you can create it here

Notice: make sure that you don't push your SendGrid credentials in this repo. Otherwise, SendGrid can block your account

Mail SMTP

We use this sender in "Debug" and "Development" mode.
To use the service, you need to create a password for external applications on your account. To do that check the link.
Also check an article to configure Mail SMTP.

Notice: make sure that you don't push your Mail SMTP credentials in this repo.

Launch docker containers

1. Make a copy of the file docker-compose-example.yml and call it docker-compose.yml

2. Enter options of your email sender in docker-compose.yml:

If you use the Mail SMTP, fill out the following variables:

• MailSmtpOptions__Host
• MailSmtpOptions__Port
• MailSmtpOptions__FromEmail
• MailSmtpOptions__FromPassword

If you use Send Grid, fill out:

• SendGridOptions__SendGridAPIKey
• SendGridOptions__SenderEmail
• SendGridOptions__SenderName

3. You need to create an internal network for configuring interaction between different back-end services.
   You can do it using the following command in your terminal: docker network create ic-backend-deb.
   Note: If you already has this network, skip this step.

4. Execute the command docker-compose up -d from source folder

Configurations

• MockForPullRequest - used in PR pipeline to run the service in isolation (no external deps) and run its Karate tests against it
• MockForDevelopment - used locally when you run the service in Visual Studio e.g. in Debug and don't want to spin up any external deps
• LocalEnvForDevelopment - used locally when you run the service in Visual Studio and you want to connect to its external deps from Local Env (ToDo not there yet)
• ProdForDevelopment - used locally when you run the service in Visual Studio and want to connect to its external deps from Prod specially dedicated Local Development Tenant (ToDo, need to complete tenants, secrets need to be available in the developer PC env vars)
• ProdForDeployment - used when we run the service in Prod, it shouldn't contain any secrets, it should be a Release build, using real Prod external deps