/athena-plugin-mail-service

Athena Framework Mail Service Plugin

Primary LanguageTypeScript

Athena Plugin - Mail Service

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

Installation

  1. Open a command prompt in your main Athena Directory.
  2. Navigate to the plugins folder.
cd src/core/plugins
  1. Copy the command below.

SSH

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

HTTPS

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