WIP implements sendmail

tacxou · tacxou · commit 32f11f480a2f · 2023-10-10T19:05:44.000+02:00
diff --git a/package.json b/package.json
@@ -56,7 +56,7 @@
     "mailparser": "^3.6.5",
     "nest-access-control": "^3.0.0",
     "nest-commander": "^3.11.1",
-    "nodemailer": "^6.9.4",
+    "nodemailer": "^6.9.6",
     "passport": "^0.6.0",
     "passport-jwt": "^4.0.1",
     "radash": "^11.0.0",
@@ -77,9 +77,9 @@
     "@types/jest": "^29.5.3",
     "@types/lru-cache": "^7.10.10",
     "@types/mailparser": "^3.4.0",
-    "@types/multer": "^1.4.7",
+    "@types/multer": "^1.4.8",
     "@types/node": "^18.0.0",
-    "@types/nodemailer": "^6.4.9",
+    "@types/nodemailer": "^6.4.11",
     "@types/passport-jwt": "^3.0.9",
     "@typescript-eslint/eslint-plugin": "^6.4.0",
     "@typescript-eslint/parser": "^6.4.0",
diff --git a/src/accounts/_dto/account-submit.dto.ts b/src/accounts/_dto/account-submit.dto.ts
@@ -0,0 +1,88 @@
+import { ApiProperty } from '@nestjs/swagger'
+import { IsDateString, IsEmail, IsEnum, IsObject, IsOptional, IsString } from 'class-validator'
+import { TextEncoding } from 'nodemailer/lib/mailer'
+
+export class AccountSubmitDto {
+  @IsEmail({}, { each: true })
+  @ApiProperty()
+  public to: string[]
+
+  @IsEmail({}, { each: true })
+  @IsOptional()
+  @ApiProperty()
+  public cc?: string[]
+
+  @IsEmail({}, { each: true })
+  @IsOptional()
+  @ApiProperty()
+  public bcc?: string[]
+
+  @IsEmail({}, { each: true })
+  @IsOptional()
+  @ApiProperty()
+  public replyTo?: string[]
+
+  @IsEmail()
+  @IsOptional()
+  @ApiProperty()
+  public inReplyTo?: string
+
+  @IsString()
+  @IsOptional()
+  @ApiProperty()
+  public subject?: string
+
+  @IsString()
+  @IsOptional()
+  @ApiProperty()
+  public text?: string
+
+  @IsString()
+  @IsOptional()
+  @ApiProperty()
+  public html?: string
+
+  @IsString()
+  @IsOptional()
+  @ApiProperty()
+  public raw?: string
+
+  @IsEnum({ quotedPrintable: 'quoted-printable', base64: 'base64' })
+  @IsOptional()
+  @ApiProperty({ enum: ['quoted-printable', 'base64'] })
+  public textEncoding?: TextEncoding
+
+  @IsDateString()
+  @IsOptional()
+  @ApiProperty()
+  public date?: string
+
+  @IsString({ each: true })
+  @IsOptional()
+  @ApiProperty()
+  public references?: string[]
+
+  @IsString()
+  @IsOptional()
+  @ApiProperty()
+  public encoding?: string
+
+  @IsObject()
+  @IsOptional()
+  @ApiProperty()
+  public headers?: {
+    [name: string]: any
+  }
+
+  @IsString()
+  @IsOptional()
+  @ApiProperty()
+  public context?: {
+    [name: string]: any
+  }
+
+  @IsString()
+  @IsOptional()
+  @ApiProperty()
+  public template?: string
+}
diff --git a/src/accounts/accounts.controller.ts b/src/accounts/accounts.controller.ts
@@ -1,4 +1,17 @@
-import { Body, Controller, Delete, Get, HttpStatus, Logger, Param, Patch, Post, Res, Sse } from '@nestjs/common'
+import {
+  Body,
+  Controller,
+  Delete,
+  Get,
+  HttpStatus,
+  Logger,
+  Param, ParseFilePipe,
+  Patch,
+  Post,
+  Res,
+  Sse, UploadedFiles,
+  UseInterceptors,
+} from '@nestjs/common'
 import { ModuleRef } from '@nestjs/core'
 import { Response } from 'express'
 import { AbstractController } from '~/_common/abstracts/abstract.controller'
@@ -15,6 +28,8 @@ import { ApiReadResponseDecorator } from '~/_common/decorators/api-read-response
 import { ApiUpdateDecorator } from '~/_common/decorators/api-update.decorator'
 import { ApiDeletedResponseDecorator } from '~/_common/decorators/api-deleted-response.decorator'
 import { ApiTags } from '@nestjs/swagger'
+import { FileInterceptor } from '@nestjs/platform-express'
+import { AccountSubmitDto } from '~/accounts/_dto/account-submit.dto'
 
 @ApiTags('accounts')
 @Controller('accounts')
@@ -96,6 +111,27 @@ export class AccountsController extends AbstractController {
     })
   }
 
+  @Post(':account([\\w-.]+)/submit')
+  @UseInterceptors(FileInterceptor('file'))
+  @UseRoles({
+    resource: ScopesEnum.Accounts,
+    action: ActionEnum.Create,
+  })
+  public async submit(
+    @Res() res: Response,
+    @Param('account') id: string,
+    @Body() body: AccountSubmitDto,
+    @UploadedFiles(
+      new ParseFilePipe({ fileIsRequired: false }),
+    ) files?: Array<Express.Multer.File>,
+  ): Promise<Response> {
+    const data = await this.service.submit(id, body, files)
+    return res.status(HttpStatus.OK).json({
+      statusCode: HttpStatus.OK,
+      data,
+    })
+  }
+
   @Sse('changes')
   public async sse(@Res() res: Response): Promise<Observable<MessageEvent>> {
     let subscriber: FSWatcher
diff --git a/src/accounts/accounts.service.ts b/src/accounts/accounts.service.ts
@@ -6,6 +6,8 @@ import { AbstractService } from '~/_common/abstracts/abstract.service'
 import { InjectImapflow } from '~/imapflow/imapflow.decorators'
 import { AccountsFileV1, AccountsMetadataV1, readAccountsFile, writeAccountsFile } from './accounts.setup'
 import { PartialType } from '@nestjs/swagger'
+import { MailerService } from '@nestjs-modules/mailer'
+import { AccountSubmitDto } from '~/accounts/_dto/account-submit.dto'
 
 class InternalAccountMetadataV1 extends PartialType(AccountsMetadataV1) {
 }
@@ -18,6 +20,7 @@ export class AccountsService extends AbstractService {
   public constructor(
     protected readonly moduleRef: ModuleRef,
     @InjectImapflow() protected imapflow: Map<string, ImapFlow>,
+    private readonly mailerService: MailerService,
   ) {
     super({ moduleRef })
     // noinspection JSUnusedGlobalSymbols
@@ -73,4 +76,16 @@ export class AccountsService extends AbstractService {
     await writeAccountsFile(accounts, this.cache)
     return account
   }
+
+  public async submit(id: string, body: AccountSubmitDto, files?: Express.Multer.File[]) {
+    const accounts = await readAccountsFile(this.cache)
+    const account = accounts.accounts.find((a) => a.id === id)
+    if (!account) throw new NotFoundException(`Account not found: ${id}`)
+    return this.mailerService.sendMail({
+      ...body,
+      attachments: files,
+      from: account.smtp.from || account.smtp.auth.user,
+      transporterName: id,
+    })
+  }
 }
diff --git a/src/accounts/accounts.setup.ts b/src/accounts/accounts.setup.ts
@@ -98,6 +98,16 @@ export class AccountsMetadataImapV1 implements ImapFlowOptions {
   public maxIdleTime: number = 60_000
 }
 
+export class AccountsMetadataSmtpAuthV1 {
+  @IsString()
+  @ApiProperty()
+  public user: string
+
+  @IsString()
+  @ApiProperty()
+  public pass: string
+}
+
 export class AccountsMetadataSmtpV1 {
   @IsString()
   @ApiProperty()
@@ -110,18 +120,26 @@ export class AccountsMetadataSmtpV1 {
   @ApiProperty()
   public port?: number = 25
 
+  @IsString()
+  @IsOptional()
+  @ApiProperty()
+  public from?: string
+
   @IsBoolean()
   @IsOptional()
   @ApiProperty()
-  public tls: boolean = false
+  public ignoreTLS: boolean = false
 
-  @IsString()
+  @IsBoolean()
+  @IsOptional()
   @ApiProperty()
-  public username: string
+  public secure: boolean = true
 
-  @IsString()
+  @ValidateNested()
+  @IsOptional()
+  @Type(() => AccountsMetadataSmtpAuthV1)
   @ApiProperty()
-  public password: string
+  public auth?: AccountsMetadataSmtpAuthV1
 
   // noinspection JSUnusedGlobalSymbols
   public toJSON() {
@@ -228,7 +246,7 @@ export class AccountsMetadataV1 {
   public webhooks?: AccountsMetadataWebhooksV1[]
 }
 
-export default async function setupAccounts(): Promise<any[]> {
+export default async function setupAccounts(): Promise<AccountsMetadataV1[]> {
   try {
     if (existsSync(ACCOUNTS_FILE_PATH)) {
       Logger.verbose('Account file found, validating...', 'setupAccounts')
@@ -240,7 +258,7 @@ export default async function setupAccounts(): Promise<any[]> {
   }
 }
 
-export async function validateAccounts(): Promise<any[]> {
+export async function validateAccounts(): Promise<AccountsMetadataV1[]> {
   const data = readFileSync(ACCOUNTS_FILE_PATH, 'utf8')
   const yml = parse(data)
   const schema = plainToInstance(AccountsFileV1, yml)
diff --git a/src/app.module.ts b/src/app.module.ts
@@ -13,12 +13,14 @@ import { AccountsMetadataV1 } from './accounts/accounts.setup'
 import { APP_GUARD, APP_PIPE } from '@nestjs/core'
 import { CronModule } from '~/accounts/cron/cron.module'
 import { AuthGuard } from '~/_common/guards/auth.guard'
-import { AccessControlModule, RolesBuilder } from "nest-access-control";
-import { AclsService } from "~/acls/acls.service";
-import { AclsModule } from "~/acls/acls.module";
-import { AclGuard } from "~/_common/guards/acl.guard";
+import { AccessControlModule, RolesBuilder } from 'nest-access-control'
+import { AclsService } from '~/acls/acls.service'
+import { AclsModule } from '~/acls/acls.module'
+import { AclGuard } from '~/_common/guards/acl.guard'
 import { DtoValidationPipe } from '~/_common/pipes/dto-validation.pipe'
 import { ScheduleModule } from '@nestjs/schedule'
+import { MailerModule, MailerOptions } from '@nestjs-modules/mailer'
+import { HandlebarsAdapter } from '@nestjs-modules/mailer/dist/adapters/handlebars.adapter'
 
 @Module({
   imports: [
@@ -43,13 +45,18 @@ import { ScheduleModule } from '@nestjs/schedule'
         config: config.get<AccountsMetadataV1[]>('mailer.accounts'),
       }),
     }),
+    MailerModule.forRootAsync({
+      imports: [ConfigModule],
+      inject: [ConfigService],
+      useFactory: async (config: ConfigService) => ({
+        ...config.get<MailerOptions>('mailer.options'),
+      }),
+    }),
     AccessControlModule.forRootAsync({
       imports: [AclsModule],
       inject: [AclsService],
       useFactory: async (aclService: AclsService) => {
-        return new RolesBuilder(
-          await aclService.getGrantsObject(),
-        )
+        return new RolesBuilder(await aclService.getGrantsObject())
       },
     }),
     ScheduleModule.forRoot(),
diff --git a/src/config.ts b/src/config.ts
@@ -7,6 +7,8 @@ import { BinaryLike, CipherCCMTypes, CipherGCMTypes, CipherKey, createHash } fro
 import { SwaggerCustomOptions } from '@nestjs/swagger'
 import setupAccounts, { AccountsMetadataV1 } from './accounts/accounts.setup'
 import setupTokens, { TokensMetadataV1 } from "~/tokens/tokens.setup";
+import { MailerOptions } from '@nestjs-modules/mailer'
+import { HandlebarsAdapter } from '@nestjs-modules/mailer/dist/adapters/handlebars.adapter'
 
 export interface ConfigInstance {
   application: NestApplicationContextOptions
@@ -16,6 +18,7 @@ export interface ConfigInstance {
   }
   mailer: {
     accounts: AccountsMetadataV1[]
+    options?: MailerOptions
   }
   crypt: {
     algorithm: string | CipherCCMTypes | CipherGCMTypes
@@ -60,6 +63,24 @@ export default async (): Promise<ConfigInstance> => {
     },
     mailer: {
       accounts: mailerAccounts,
+      options: {
+        transports: mailerAccounts.reduce((acc, account) => {
+          if (account.smtp) {
+            acc[account.id] = account.smtp
+          }
+          return acc
+        }, {}),
+        defaults: {
+          from: '"nest-modules" <modules@nestjs.com>',
+        },
+        template: {
+          dir: __dirname + '/../../templates',
+          adapter: new HandlebarsAdapter(),
+          options: {
+            strict: true,
+          },
+        },
+      },
     },
     jwt: {
       options: {
diff --git a/src/main.ts b/src/main.ts
@@ -1,6 +1,6 @@
 // noinspection JSUnresolvedReference
 
-import { BadRequestException, HttpStatus, INestApplication, Logger, ValidationError, ValidationPipe } from '@nestjs/common'
+import { INestApplication, Logger } from '@nestjs/common'
 import { NestFactory } from '@nestjs/core'
 import { NestExpressApplication } from '@nestjs/platform-express'
 import { Response } from 'express'
@@ -9,6 +9,7 @@ import { join } from 'path'
 import configInstance from './config'
 import { AppModule } from './app.module'
 import passport from 'passport'
+import 'multer'
 
 declare const module: any
 ;(async (): Promise<void> => {
diff --git a/templates/.gitignore b/templates/.gitignore
@@ -0,0 +1,2 @@
+*
+!.gitignore
diff --git a/yarn.lock b/yarn.lock
