privatemail 0.1.0

Service to forward custom emails to personal email server
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

# privatemail

[![Rust](https://github.com/ch3ck/privatemail/actions/workflows/rust.yml/badge.svg?branch=master)](https://github.com/ch3ck/privatemail/actions/workflows/rust.yml)
[![Run Security Audit](https://github.com/ch3ck/privatemail/actions/workflows/security.yml/badge.svg)](https://github.com/ch3ck/privatemail/actions/workflows/security.yml)
[![Deploy new email service](https://github.com/ch3ck/privatemail/actions/workflows/deploy.yml/badge.svg)](https://github.com/ch3ck/privatemail/actions/workflows/deploy.yml)
[![forthebadge](https://forthebadge.com/images/badges/contains-technical-debt.svg)](https://crates.io/crates/privatemail)

Forward emails from verified domains on SES to SES `verified email`.


## Description

A RUST service that uses the inbound/outbound capabilities of AWS SES to forward emails from verified domains to an SES `verified` email address.
For example, if an email is sent from `john@doe.example` to `achu@fufu.soup` is forwarded to a verified email `onions@suya.io`.
`privatemail` also add capability to `blacklist` certain emails from coming to you.

Example email and how the `From` and `Reply-To` headers are set:
```
From: John Doe <achu@fufu.soup>
Reply-To: john@doe.example

<html>Email body</html>

received by -- <onions@suya.io>
```

### Pre-requisites

- [Verify SES Domain on SES](http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-domains.html)
- [Verify SES Email forwarding](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html)
- [Terraform binaries](https://learn.hashicorp.com/tutorials/terraform/install-cli)
- [AWS SES Limits](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html)
- [Generate Terraform cloud tokens](https://www.terraform.io/docs/cloud/users-teams-organizations/users.html#api-tokens)


## Build

1. Edit the `terraform/variables.tf` file accordingly to suit your needs.
2. If you're using S3 as your backend, you'll need to make changes to `terraform/main.tf`
3. Test build locally.
```bash
$ cargo build
$ cargo test
```

### Provision Infrastructure with Terraform
1. Verify your domain and email address on SES before running this
2. Create a terraform Token which has admin access to your AWS Account
3. Build and generate your Lambda.zip in the terraform directory
3. Provision infrastructure
```bash
$ cd terraform
$ terraform init
$ terraform validate -json
$ terraform plan
$ terraform apply
```
Alternately, you can run the `release.sh` and it builds your code and provisions your infrastructure.

## Contributing
We appreciate your contributions; all PRs are welcomed. Please see [CONTRIBUTING.md]() for more information.


## Deployment :rocket:

### Local Deploy
```bash
$ bash release.sh
```

### CI / CD (GitHub Actions)

Set up the following GitHub secrets for actions worfklows to work properly
```bash
FROM_EMAIL
TF_API_TOKEN
TO_EMAIL
AWS_REGION
BLACK_LIST
```
All deployments occur via GitHub Actions.


## License
The scripts and documentation in this project are released under the [MIT License](LICENSE.md)


## Author
- [Nyah Check](https://nyah.dev)