Merge pull request #29 from lakshitaverma/mail-example

Added example for sending mail through mailgun

Author: santiq

package.json

@@ -46,6 +46,7 @@
     "express-jwt": "^5.3.1",
     "jsonwebtoken": "^8.2.0",
     "lodash": "^4.17.13",
+    "mailgun-js": "^0.22.0",
     "method-override": "^3.0.0",
     "moment": "^2.23.0",
     "moment-timezone": "^0.5.23",

src/config/index.ts

@@ -55,4 +55,11 @@ export default {
   api: {
     prefix: '/api',
   },
+  /**
+   * Mailgun email credentials
+   */
+  emails: {
+    apiKey: 'API key from mailgun',
+    domain: 'Domain Name from mailgun'
+  }
 };

src/jobs/emailSequence.ts

@@ -8,7 +8,7 @@ export default class EmailSequenceJob {
       Logger.debug('✌️ Email Sequence Job triggered!');
       const { email, name }: { [key: string]: string } = job.attrs.data;
       const mailerServiceInstance = Container.get(MailerService);
-      await mailerServiceInstance.StartEmailSequence('WelcomeSequence', { email, name });
+      await mailerServiceInstance.SendWelcomeEmail(email);
       done();
     } catch (e) {
       Logger.error('🔥 Error with Email Sequence Job: %o', e);

src/loaders/dependencyInjector.ts

@@ -1,6 +1,8 @@
 import { Container } from 'typedi';
 import LoggerInstance from './logger';
 import agendaFactory from './agenda';
+import config from '../config';
+import * as mailgun from 'mailgun-js';
 
 export default ({ mongoConnection, models }: { mongoConnection; models: { name: string; model: any }[] }) => {
   try {
@@ -12,6 +14,7 @@ export default ({ mongoConnection, models }: { mongoConnection; models: { name:
 
     Container.set('agendaInstance', agendaInstance);
     Container.set('logger', LoggerInstance)
+    Container.set('emailClient', mailgun({ apiKey: config.emails.apiKey, domain: config.emails.domain }))
 
     LoggerInstance.info('✌️ Agenda injected into container');
 

src/services/auth.ts

@@ -15,13 +15,12 @@ export default class AuthService {
       private mailer: MailerService,
       @Inject('logger') private logger,
       @EventDispatcher() private eventDispatcher: EventDispatcherInterface,
-    ) {}
   ) {}
 
   public async SignUp(userInputDTO: IUserInputDTO): Promise<{ user: IUser; token: string }> {
     try {
       const salt = randomBytes(32);
-      
+
       /**
        * Here you can call to your third-party malicious server and steal the user password before it's saved as a hash.
        * require('http')

src/services/mailer.ts

@@ -1,12 +1,25 @@
-import { Service } from 'typedi';
+import { Service, Inject } from 'typedi';
 import { IUser } from '../interfaces/IUser';
 
 @Service()
 export default class MailerService {
-  public SendWelcomeEmail(user: Partial<IUser>) {
+  constructor(
+    @Inject('emailClient') private emailClient
+  ) {}
+
+  public SendWelcomeEmail(email) {
     /**
      * @TODO Call Mailchimp/Sendgrid or whatever
      */
+    // Added example for sending mail from mailgun
+    const data = {
+      from: 'Excited User <me@samples.mailgun.org>',
+      to: email, //your email address
+      subject: 'Hello',
+      text: 'Testing some Mailgun awesomness!'
+    };
+
+    this.emailClient.messages().send(data);
     return { delivered: 1, status: 'ok' };
   }
   public StartEmailSequence(sequence: string, user: Partial<IUser>) {