feat: SMTP OTP bridge (#790)

Co-authored-by: Douglas Gubert <[email protected]>
Co-authored-by: Rafael Tapia <[email protected]>

deno-runtime/lib/accessors/modify/ModifyCreator.ts

@@ -1,5 +1,6 @@
 import type { IModifyCreator } from '@rocket.chat/apps-engine/definition/accessors/IModifyCreator.ts';
 import type { IUploadCreator } from '@rocket.chat/apps-engine/definition/accessors/IUploadCreator.ts';
+import type { IEmailCreator } from '@rocket.chat/apps-engine/definition/accessors/IEmailCreator.ts';
 import type { ILivechatCreator } from '@rocket.chat/apps-engine/definition/accessors/ILivechatCreator.ts';
 import type { IMessage } from '@rocket.chat/apps-engine/definition/messages/IMessage.ts';
 import type { IRoom } from '@rocket.chat/apps-engine/definition/rooms/IRoom.ts';
@@ -85,6 +86,26 @@ export class ModifyCreator implements IModifyCreator {
         ) as IUploadCreator;
     }
 
+    getEmailCreator(): IEmailCreator {
+        return new Proxy(
+            { __kind: 'getEmailCreator' },
+            {
+                get: (_target: unknown, prop: string) => 
+                        (...params: unknown[]) =>
+                            prop === 'toJSON'
+                                ? {}
+                                : this.senderFn({
+                                    method: `accessor:getModifier:getCreator:getEmailCreator:${prop}`,
+                                    params
+                                })
+                                    .then((response) => response.result)
+                                    .catch((err) => {
+                                        throw new Error(err.error);
+                                    }),
+            }
+        )
+    }
+
     getBlockBuilder() {
         return new BlockBuilder();
     }

src/definition/accessors/IEmailCreator.ts

@@ -0,0 +1,10 @@
+import type { IEmail } from '../email';
+
+export interface IEmailCreator {
+    /**
+     * Sends an email through Rocket.Chat
+     *
+     * @param email the email data
+     */
+    send(email: IEmail): Promise<void>;
+}

src/definition/accessors/IModifyCreator.ts

@@ -12,6 +12,7 @@ import type { IRoomBuilder } from './IRoomBuilder';
 import type { IUploadCreator } from './IUploadCreator';
 import type { IUserBuilder } from './IUserBuilder';
 import type { IVideoConferenceBuilder } from './IVideoConferenceBuilder';
+import type { IEmailCreator } from './IEmailCreator';
 
 export interface IModifyCreator {
     /**
@@ -25,6 +26,11 @@ export interface IModifyCreator {
      */
     getUploadCreator(): IUploadCreator;
 
+    /**
+     * Gets the creator object responsible for email sending
+     */
+    getEmailCreator(): IEmailCreator;
+
     /**
      * @deprecated please prefer the rocket.chat/ui-kit components
      *

src/definition/email/IEmail.ts

@@ -0,0 +1,9 @@
+export interface IEmail {
+    to: string | string[];
+    from: string;
+    replyTo?: string;
+    subject: string;
+    html?: string;
+    text?: string;
+    headers?: string;
+}

src/definition/email/index.ts

@@ -1,3 +1,4 @@
 export * from './IEmailDescriptor';
 export * from './IPreEmailSent';
 export * from './IPreEmailSentContext';
+export * from './IEmail';

src/server/accessors/EmailCreator.ts

@@ -0,0 +1,11 @@
+import type { AppBridges } from '../bridges';
+import type { IEmailCreator } from '../../definition/accessors/IEmailCreator';
+import type { IEmail } from '../../definition/email';
+
+export class EmailCreator implements IEmailCreator {
+    constructor(private readonly bridges: AppBridges, private readonly appId: string) {}
+
+    public async send(email: IEmail): Promise<void> {
+        return this.bridges.getEmailBridge().doSendEmail(email, this.appId);
+    }
+}

src/server/accessors/ModifyCreator.ts

@@ -28,15 +28,20 @@ import { RoomBuilder } from './RoomBuilder';
 import { UploadCreator } from './UploadCreator';
 import { UserBuilder } from './UserBuilder';
 import { VideoConferenceBuilder } from './VideoConferenceBuilder';
+import { EmailCreator } from './EmailCreator';
+import type { IEmailCreator } from '../../definition/accessors/IEmailCreator';
 
 export class ModifyCreator implements IModifyCreator {
     private livechatCreator: LivechatCreator;
 
     private uploadCreator: UploadCreator;
 
+    private emailCreator: EmailCreator;
+
     constructor(private readonly bridges: AppBridges, private readonly appId: string) {
         this.livechatCreator = new LivechatCreator(bridges, appId);
         this.uploadCreator = new UploadCreator(bridges, appId);
+        this.emailCreator = new EmailCreator(bridges, appId);
     }
 
     public getLivechatCreator(): ILivechatCreator {
@@ -47,6 +52,10 @@ export class ModifyCreator implements IModifyCreator {
         return this.uploadCreator;
     }
 
+    public getEmailCreator(): IEmailCreator {
+        return this.emailCreator;
+    }
+
     /**
      * @deprecated please prefer the rocket.chat/ui-kit components
      */

src/server/bridges/AppBridges.ts

@@ -17,6 +17,7 @@ import type { RoleBridge } from './RoleBridge';
 import type { RoomBridge } from './RoomBridge';
 import type { SchedulerBridge } from './SchedulerBridge';
 import type { ServerSettingBridge } from './ServerSettingBridge';
+import type { EmailBridge } from './EmailBridge';
 import type { ThreadBridge } from './ThreadBridge';
 import type { UiInteractionBridge } from './UiInteractionBridge';
 import type { UploadBridge } from './UploadBridge';
@@ -37,6 +38,7 @@ export type Bridge =
     | RoomBridge
     | IInternalBridge
     | ServerSettingBridge
+    | EmailBridge
     | UploadBridge
     | UserBridge
     | UiInteractionBridge
@@ -77,6 +79,8 @@ export abstract class AppBridges {
 
     public abstract getUploadBridge(): UploadBridge;
 
+    public abstract getEmailBridge(): EmailBridge;
+
     public abstract getUserBridge(): UserBridge;
 
     public abstract getUiInteractionBridge(): UiInteractionBridge;

src/server/bridges/EmailBridge.ts

@@ -0,0 +1,30 @@
+import type { IEmail } from '../../definition/email';
+import { PermissionDeniedError } from '../errors/PermissionDeniedError';
+import { AppPermissionManager } from '../managers/AppPermissionManager';
+import { AppPermissions } from '../permissions/AppPermissions';
+import { BaseBridge } from './BaseBridge';
+
+export abstract class EmailBridge extends BaseBridge {
+    public async doSendEmail(email: IEmail, appId: string): Promise<void> {
+        if (this.hasWritePermission(appId)) {
+            return this.sendEmail(email, appId);
+        }
+    }
+
+    protected abstract sendEmail(email: IEmail, appId: string): Promise<void>;
+
+    private hasWritePermission(appId: string): boolean {
+        if (AppPermissionManager.hasPermission(appId, AppPermissions.email.send)) {
+            return true;
+        }
+
+        AppPermissionManager.notifyAboutError(
+            new PermissionDeniedError({
+                appId,
+                missingPermissions: [AppPermissions.email.send],
+            }),
+        );
+
+        return false;
+    }
+}

src/server/bridges/index.ts

@@ -4,6 +4,7 @@ import { AppBridges } from './AppBridges';
 import { AppDetailChangesBridge } from './AppDetailChangesBridge';
 import { CloudWorkspaceBridge } from './CloudWorkspaceBridge';
 import { CommandBridge } from './CommandBridge';
+import { EmailBridge } from './EmailBridge';
 import { EnvironmentalVariableBridge } from './EnvironmentalVariableBridge';
 import { HttpBridge, IHttpBridgeRequestInfo } from './HttpBridge';
 import { IInternalBridge } from './IInternalBridge';
@@ -40,6 +41,7 @@ export {
     ServerSettingBridge,
     UserBridge,
     UploadBridge,
+    EmailBridge,
     UiInteractionBridge,
     SchedulerBridge,
     AppBridges,

src/server/permissions/AppPermissions.ts

@@ -25,6 +25,9 @@ export const AppPermissions = {
         read: { name: 'upload.read' },
         write: { name: 'upload.write' },
     },
+    email: {
+        send: { name: 'email.send' },
+    },
     ui: {
         interaction: { name: 'ui.interact' },
         registerButtons: { name: 'ui.registerButtons' },

tests/test-data/bridges/appBridges.ts

@@ -22,6 +22,7 @@ import { AppBridges } from '../../../src/server/bridges';
 import type { CloudWorkspaceBridge } from '../../../src/server/bridges/CloudWorkspaceBridge';
 import type { IInternalFederationBridge } from '../../../src/server/bridges/IInternalFederationBridge';
 import type { OAuthAppsBridge } from '../../../src/server/bridges/OAuthAppsBridge';
+import type { EmailBridge } from '../../../src/server/bridges/EmailBridge';
 import type { ThreadBridge } from '../../../src/server/bridges/ThreadBridge';
 import { TestsActivationBridge } from './activationBridge';
 import { TestsApiBridge } from './apiBridge';
@@ -41,6 +42,7 @@ import { TestsRoleBridge } from './roleBridge';
 import { TestsRoomBridge } from './roomBridge';
 import { TestSchedulerBridge } from './schedulerBridge';
 import { TestsServerSettingBridge } from './serverSettingBridge';
+import { TestsEmailBridge } from './emailBridge';
 import { TestsThreadBridge } from './threadBridge';
 import { TestsUiIntegrationBridge } from './uiIntegrationBridge';
 import { TestUploadBridge } from './uploadBridge';
@@ -80,6 +82,8 @@ export class TestsAppBridges extends AppBridges {
 
     private readonly uploadBridge: TestUploadBridge;
 
+    private readonly emailBridge: EmailBridge;
+
     private readonly uiIntegrationBridge: TestsUiIntegrationBridge;
 
     private readonly schedulerBridge: TestSchedulerBridge;
@@ -119,6 +123,7 @@ export class TestsAppBridges extends AppBridges {
         this.oauthBridge = new TestOAuthAppsBridge();
         this.internalFederationBridge = new TestsInternalFederationBridge();
         this.threadBridge = new TestsThreadBridge();
+        this.emailBridge = new TestsEmailBridge();
     }
 
     public getCommandBridge(): TestsCommandBridge {
@@ -189,6 +194,10 @@ export class TestsAppBridges extends AppBridges {
         return this.livechatBridge;
     }
 
+    public getEmailBridge(): EmailBridge {
+        return this.emailBridge;
+    }
+
     public getUploadBridge(): UploadBridge {
         return this.uploadBridge;
     }

tests/test-data/bridges/emailBridge.ts

@@ -0,0 +1,8 @@
+import type { IEmail } from '../../../src/definition/email';
+import { EmailBridge } from '../../../src/server/bridges/EmailBridge';
+
+export class TestsEmailBridge extends EmailBridge {
+    protected sendEmail(email: IEmail, appId: string): Promise<void> {
+        throw new Error('Method not implemented.');
+    }
+}