An email service plugin for the Athena Framework compatible with 4.0.0 of the Athena Framework.

1. Open a command prompt in your main Athena Directory.
2. Navigate to the plugins folder.

cd src/core/plugins

3. Copy the command below.

SSH

git clone [email protected]:Athena-Roleplay-Framework/athena-plugin-mail-service.git

HTTPS

git clone https://github.com/Athena-Roleplay-Framework/athena-plugin-mail-service

4. npm install nodemailer
5. You need a domain (.com, .org, whatever) registered under you.
6. Utilize https://sendgrid.com/
7. Setup Sender Authentication https://app.sendgrid.com/settings/sender_auth
8. Go through the steps to verify your domain with sendgrid.
9. Create an API key https://app.sendgrid.com/settings/api_keys
10. In server/src/config.ts fill in the information. 6a. Leave username alone if using SendGrid 6b. Only fill in password with API key.
11. Send a test email by writing some code to double check everything is okay. :)