chore(server): remove enable flag in mail config (#11680)

close #11625

packages/backend/server/src/base/error/def.ts

@@ -275,6 +275,10 @@ export const USER_FRIENDLY_ERRORS = {
     args: { message: 'string' },
     message: ({ message }) => `HTTP request error, message: ${message}`,
   },
+  email_service_not_configured: {
+    type: 'internal_server_error',
+    message: 'Email service is not configured.',
+  },
 
   // Input errors
   query_too_long: {

packages/backend/server/src/base/error/errors.gen.ts

@@ -54,6 +54,12 @@ export class HttpRequestError extends UserFriendlyError {
     super('bad_request', 'http_request_error', message, args);
   }
 }
+
+export class EmailServiceNotConfigured extends UserFriendlyError {
+  constructor(message?: string) {
+    super('internal_server_error', 'email_service_not_configured', message);
+  }
+}
 @ObjectType()
 class QueryTooLongDataType {
   @Field() max!: number
@@ -943,6 +949,7 @@ export enum ErrorNames {
   BAD_REQUEST,
   GRAPHQL_BAD_REQUEST,
   HTTP_REQUEST_ERROR,
+  EMAIL_SERVICE_NOT_CONFIGURED,
   QUERY_TOO_LONG,
   VALIDATION_ERROR,
   USER_NOT_FOUND,

packages/backend/server/src/core/auth/controller.ts

@@ -37,7 +37,6 @@ import { CurrentUser, Session } from './session';
 interface PreflightResponse {
   registered: boolean;
   hasPassword: boolean;
-  magicLink: boolean;
 }
 
 interface SignInCredential {
@@ -91,20 +90,16 @@ export class AuthController {
 
     const user = await this.models.user.getUserByEmail(params.email);
 
-    const magicLinkAvailable = this.config.mailer.enabled;
-
     if (!user) {
       return {
         registered: false,
         hasPassword: false,
-        magicLink: magicLinkAvailable,
       };
     }
 
     return {
       registered: user.registered,
       hasPassword: !!user.password,
-      magicLink: magicLinkAvailable,
     };
   }
 

packages/backend/server/src/core/mail/config.ts

@@ -3,7 +3,6 @@ import { defineModuleConfig } from '../../base';
 declare global {
   interface AppConfigSchema {
     mailer: {
-      enabled: boolean;
       SMTP: {
         host: string;
         port: number;
@@ -17,10 +16,6 @@ declare global {
 }
 
 defineModuleConfig('mailer', {
-  enabled: {
-    desc: 'Whether enabled mail service.',
-    default: false,
-  },
   'SMTP.host': {
     desc: 'Host of the email server (e.g. smtp.gmail.com)',
     default: '',
@@ -49,6 +44,6 @@ defineModuleConfig('mailer', {
   'SMTP.ignoreTLS': {
     desc: "Whether ignore email server's TSL certification verification. Enable it for self-signed certificates.",
     default: false,
-    env: 'MAILER_IGNORE_TLS',
+    env: ['MAILER_IGNORE_TLS', 'boolean'],
   },
 });

packages/backend/server/src/core/mail/mailer.ts

@@ -1,12 +1,25 @@
 import { Injectable } from '@nestjs/common';
 
-import { JobQueue } from '../../base';
+import { EmailServiceNotConfigured, JobQueue } from '../../base';
+import { MailSender } from './sender';
 
 @Injectable()
 export class Mailer {
-  constructor(private readonly queue: JobQueue) {}
+  constructor(
+    private readonly queue: JobQueue,
+    private readonly sender: MailSender
+  ) {}
+
+  get enabled() {
+    // @ts-expect-error internal api
+    return this.sender.smtp !== null;
+  }
 
   async send(command: Jobs['notification.sendMail']) {
+    if (!this.enabled) {
+      throw new EmailServiceNotConfigured();
+    }
+
     try {
       await this.queue.add('notification.sendMail', command);
       return true;

packages/backend/server/src/core/mail/sender.ts

@@ -56,13 +56,7 @@ export class MailSender {
   }
 
   private setup() {
-    const { SMTP, enabled } = this.config.mailer;
-
-    if (!enabled) {
-      this.smtp = null;
-      return;
-    }
-
+    const { SMTP } = this.config.mailer;
     const opts = configToSMTPOptions(SMTP);
 
     if (SMTP.host) {
@@ -83,6 +77,7 @@ export class MailSender {
       });
     } else {
       this.logger.warn('Mailer SMTP transport is not configured.');
+      this.smtp = null;
     }
   }
 

packages/backend/server/src/schema.gql

@@ -447,6 +447,7 @@ enum ErrorNames {
   DOC_UPDATE_BLOCKED
   EARLY_ACCESS_REQUIRED
   EMAIL_ALREADY_USED
+  EMAIL_SERVICE_NOT_CONFIGURED
   EMAIL_TOKEN_NOT_FOUND
   EMAIL_VERIFICATION_REQUIRED
   EXPECT_TO_GRANT_DOC_USER_ROLES