draft for automated email service

Author: Vayras

config/dev.config.example.yaml

@@ -39,4 +39,14 @@ app:
   auth:
     callbackPath: '/auth/discord/callback'
     dashboardRedirectPath: '/health'
-    sessionTtlSeconds: 604800 # 7 days
+    sessionTtlSeconds: 604800 # 7 days
+email:
+  smtp:
+    host: smtp.gmail.com # SMTP server host (e.g., smtp.gmail.com, smtp.sendgrid.net)
+    port: 587 # SMTP port (587 for TLS, 465 for SSL)
+    secure: false # true for SSL (port 465), false for TLS (port 587)
+    user: [email protected] # SMTP username/email
+    pass: your-app-password # SMTP password or app-specific password
+  from:
+    email: [email protected] # Sender email address
+    name: Bitshala # Sender name

package-lock.json

@@ -44,10 +44,12 @@
     "@nestjs/throttler": "^6.4.0",
     "@nestjs/typeorm": "^10.0.2",
     "@nestjs/websockets": "^10.3.7",
+    "@types/nodemailer": "^7.0.3",
     "axios": "^1.7.2",
     "currency.js": "^2.0.4",
     "js-yaml": "^4.1.0",
     "nest-winston": "^1.10.2",
+    "nodemailer": "^7.0.10",
     "reflect-metadata": "^0.1.13",
     "rxjs": "^7.2.0",
     "typeorm": "^0.3.20",

package.json

@@ -9,6 +9,7 @@ import { DiscordClientModule } from '@/discord-client/discord.client.module';
 import { CohortWaitlist } from '@/entities/cohort-waitlist.entity';
 import { APITask } from '@/entities/api-task.entity';
 import { User } from '@/entities/user.entity';
+import { EmailModule } from '@/services/email/email.module';
 
 @Module({
     imports: [
@@ -21,6 +22,7 @@ import { User } from '@/entities/user.entity';
         ]),
         DbTransactionModule,
         DiscordClientModule,
+        EmailModule,
     ],
     providers: [CohortsService],
     controllers: [CohortsController],

src/cohorts/cohorts.module.ts

@@ -25,6 +25,7 @@ import { CohortType } from '@/common/enum';
 import { CohortWaitlist } from '@/entities/cohort-waitlist.entity';
 import { APITask } from '@/entities/api-task.entity';
 import { TaskType } from '@/task-processor/task.enums';
+import { AutomatedEmailService } from '@/services/email/automated-email.service';
 
 @Injectable()
 export class CohortsService {
@@ -47,6 +48,7 @@ export class CohortsService {
         private readonly dbTransactionService: DbTransactionService,
         private readonly discordClient: DiscordClient,
         private readonly configService: ConfigService,
+        private readonly automatedEmailService: AutomatedEmailService,
     ) {
         this.masteringBitcoinDiscordRoleId =
             this.configService.getOrThrow<string>(
@@ -464,6 +466,15 @@ export class CohortsService {
         waitlistEntry.type = body.type;
 
         await this.cohortWaitlistRepository.save(waitlistEntry);
+
+        // Send automated welcome email to the user
+        const userName =
+            user.name || user.discordGlobalName || user.discordUserName;
+        await this.automatedEmailService.sendWaitlistWelcomeEmail(
+            user.email,
+            userName,
+            body.type,
+        );
     }
 
     async getUserWaitlist(user: User): Promise<UserCohortWaitlistResponseDto> {

src/cohorts/cohorts.service.ts

@@ -169,6 +169,50 @@ class AppConfig {
     auth: AppAuthConfig;
 }
 
+class EmailSmtpConfig {
+    @IsString()
+    @IsNotEmpty()
+    host: string;
+
+    @IsInt()
+    @Min(1)
+    @Max(65535)
+    port: number;
+
+    @IsBoolean()
+    secure: boolean;
+
+    @IsString()
+    @IsNotEmpty()
+    user: string;
+
+    @IsString()
+    @IsNotEmpty()
+    pass: string;
+}
+
+class EmailFromConfig {
+    @IsString()
+    @IsNotEmpty()
+    email: string;
+
+    @IsString()
+    @IsNotEmpty()
+    name: string;
+}
+
+class EmailConfig {
+    @IsDefined()
+    @ValidateNested()
+    @Type(() => EmailSmtpConfig)
+    smtp: EmailSmtpConfig;
+
+    @IsDefined()
+    @ValidateNested()
+    @Type(() => EmailFromConfig)
+    from: EmailFromConfig;
+}
+
 export class Config {
     @IsDefined()
     @ValidateNested()
@@ -189,4 +233,9 @@ export class Config {
     @ValidateNested()
     @Type(() => AppConfig)
     app: AppConfig;
+
+    @IsOptional()
+    @ValidateNested()
+    @Type(() => EmailConfig)
+    email?: EmailConfig;
 }