correo/README.md

# Correo

Correo is a .NET service for programmatically sending emails. Communication with this service is available through two channels simultaneously:
* HTTP (via REST API)
* Pub/Sub Messaging (via NATS)

It can be integrated with several types of mediators, the configuration being the following:

```"SmtpMediator": "SmtpClient", //SmtpClient, SendGrid, Mailgun```

## Mediators

### SMTP servers:
* Local servers
* Gmail
* Yahoo

The integration with SMTP servers can be done through two libraries (.NET / MailKit), and the configuration area looks like this:

```
"SmtpClient": {
  "Package": "MailKit", //.NET, MailKit
  "Server": "smtp.gmail.com",
  "Port": "587",
  "UseAuthentication": true,
  "Authentication": {
    "UserName": "<account>@gmail.com",
    "Domain": "",
    "Password": "********"
  },
  "EnableSsl": true,
  "TrustServer": false
}
```

### Transactional Email APIs:
#### SendGrid

SendGrid is a cloud-based SMTP provider that allows you to send emails without having to maintain email servers. It has an excellent and easy-to-use email API with a free plan that allows you to send 100 emails per day.
For this integration, the setup is very simple. All you need is an API Key generated from the [SendGrid](https://app.sendgrid.com/) platform. Afterwards, this API Key will be configured in Correo as below:

```
"SmtpMediator": "SendGrid"
"SendGrid": {
  "ApiKey": "xxxxxxxxxxx"
}
```

#### Mailgun
Mailgun is an email automation service that allows you to send, receive, and track emails. It offers a free usage plan as well as a pay-as-you-go pricing model that is based on the number of emails sent per month.
For this integration, the setup is very simple. All you need is an API Key generated from the [Mailgun](https://app.mailgun.com/) platform and the domain name configured in Mailgun. Afterwards, this keys will be configured in Correo as below:
```
"SmtpMediator": "Mailgun"
"Mailgun": {
  "ApiKey": "xxxxxxxxxxx",
  "Domain": "xxxxxxxxxxx"
}
```

## Database
The database is SQLite. It is created automatically at the first start of the service, if it is missing. The path where the database is stored can be configured as follows:

```
"Workspace": "workspace",
"ConnectionStrings": {
  "DatabaseConnection": "Data Source={Workspace}\\correo.db"
}
```

For the moment, the only purpose of the database is to store the logs generated by Serilog.

## Hosting
The only hosting environment tested for this service is Docker, but considering that .NET 6 is cross platform, it can most likely be hosted in any environment.