Add 'useCustomMailer' and 'sendExistingUserEmail' config options

config.example.js

@@ -48,6 +48,8 @@ const exampleConfig = {
     sendPasswordChangedEmail: true,
     // If this is set, the user will be redirected to this location after confirming email instead of JSON response
     confirmEmailRedirectURL: '/',
+    // Send an email if the user tried to signup with an existing email
+    sendExistingUserEmail: true,
     // Set this to true to disable usernames and use emails instead
     emailUsername: false,
     // Also return the username and UUID when creating a session
@@ -102,6 +104,8 @@ const exampleConfig = {
     couchAuthOnCloudant: false
   },
   mailer: {
+    // If you want to use the built in mailer or a custom one. If you want to use the custom one, you need to listen to the emitted events
+    useCustomMailer: false,
     // Email address that all your system emails will be from
     fromEmail: '[email protected]',
     // Use this if you want to specify a custom Nodemailer transport. Defaults to SMTP or sendmail.

src/config/default.config.ts

@@ -40,7 +40,8 @@ export const defaultConfig: Config = {
     requireEmailConfirm: true,
     sendConfirmEmail: true,
     requirePasswordOnEmailChange: true,
-    sendPasswordChangedEmail: true
+    sendPasswordChangedEmail: true,
+    sendExistingUserEmail: true,
   },
   dbServer: {
     protocol: 'http://',

src/types/config.ts

@@ -150,6 +150,8 @@ export interface LocalConfig {
    * confirming email instead of JSON response
    */
   confirmEmailRedirectURL?: string;
+  /** Send an email if the user tried to signup with an existing email */
+  sendExistingUserEmail?: true
   /** allow to also login with the username. Default: `false` */
   usernameLogin: boolean;
   /** allow to also login with the UUID. Default: `false` */
@@ -282,6 +284,8 @@ export interface RetryMailOptions {
 
 /** Configure how [nodemailer](https://nodemailer.com/about/) sends mails. */
 export interface MailerConfig {
+  /** If you want to use the built in mailer or a custom one. If you want to use the custom one, you need to listen to the emitted events */
+  useCustomMailer?: boolean;
   /** Email address that all your system emails will be from */
   fromEmail: string | Address;
   /**

src/user.ts

@@ -331,10 +331,12 @@ export class User {
 
   private async handleEmailExists(email: string, req?): Promise<void> {
     const existingUser = await this.userDbManager.getUserBy('email', email);
-    await this.mailer.sendEmail('signupExistingEmail', email, {
-      user: existingUser,
-      req
-    });
+    if (this.config.local.sendExistingUserEmail && !this.config.mailer.useCustomMailer) {
+      await this.mailer.sendEmail('signupExistingEmail', email, {
+        user: existingUser,
+        req
+      });
+    }
     this.emitter.emit('signup-attempt', existingUser, 'local');
   }
 
@@ -471,7 +473,7 @@ export class User {
     );
     const result = await this.userDB.insert(finalNewUser);
     newUser._rev = result.rev;
-    if (this.config.local.sendConfirmEmail) {
+    if (this.config.local.sendConfirmEmail && !this.config.mailer.useCustomMailer) {
       await this.mailer.sendEmail(
         'confirmEmail',
         newUser.unverifiedEmail.email,
@@ -897,11 +899,13 @@ export class User {
           status: 404
         };
       }
-      await this.mailer.sendEmail(
-        'forgotUsername',
-        user.email || user.unverifiedEmail.email,
-        { user: user, req: req }
-      );
+      if (!this.config.mailer.useCustomMailer) {
+        await this.mailer.sendEmail(
+          'forgotUsername',
+          user.email || user.unverifiedEmail.email,
+          { user: user, req: req }
+        );
+      }
       this.emitter.emit('forgot-username', user);
     } catch (err) {
       this.emitter.emit('forgot-username-attempt', email);
@@ -956,7 +960,7 @@ export class User {
   }
 
   private async sendModifiedPasswordEmail(user: SlUserDoc, req): Promise<void> {
-    if (this.config.local.sendPasswordChangedEmail) {
+    if (this.config.local.sendPasswordChangedEmail && !this.config.mailer.useCustomMailer) {
       await this.mailer.sendEmail(
         'modifiedPassword',
         user.email || user.unverifiedEmail.email,
@@ -1013,11 +1017,13 @@ export class User {
     };
     user = this.userDbManager.logActivity('forgot-password', 'local', user);
     await this.userDB.insert(user);
-    await this.mailer.sendEmail(
-      'forgotPassword',
-      user.email || user.unverifiedEmail.email,
-      { user: user, req: req, token: token }
-    );
+    if (!this.config.mailer.useCustomMailer) {
+      await this.mailer.sendEmail(
+        'forgotPassword',
+        user.email || user.unverifiedEmail.email,
+        { user: user, req: req, token: token }
+      );
+    }
     this.emitter.emit('forgot-password', user);
   }
 
@@ -1088,14 +1094,16 @@ export class User {
         email: newEmail,
         token: URLSafeUUID()
       };
-      await this.mailer.sendEmail(
-        'confirmEmailChange',
-        user.unverifiedEmail.email,
-        {
-          req: req,
-          user: user
-        }
-      );
+      if (!this.config.mailer.useCustomMailer) {
+        await this.mailer.sendEmail(
+          'confirmEmailChange',
+          user.unverifiedEmail.email,
+          {
+            req: req,
+            user: user
+          }
+        );
+      }
     } else {
       user.email = newEmail;
     }