@travetto/email-nodemailer 3.0.0-rc.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 ArcSine Technologies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,56 @@
+<!-- This file was generated by @travetto/doc and should not be modified directly -->
+<!-- Please modify https://github.com/travetto/travetto/tree/main/module/email-nodemailer/doc.ts and execute "npx trv doc" to rebuild -->
+# Email
+## Email transmission module.
+
+**Install: @travetto/email-nodemailer**
+```bash
+npm install @travetto/email-nodemailer
+```
+
+Given the integration with [nodemailer](https://nodemailer.com/about/), all extensions should be usable out of the box. The primary [nodemailer](https://nodemailer.com/about/) modules are provided (assuming dependencies are installed):
+
+**Code: sendmail to send all messages via the sendmail operation**
+```typescript
+import { InjectableFactory } from '@travetto/di';
+import { NodemailerTransport } from '@travetto/email';
+
+class Config {
+  @InjectableFactory()
+  static getTransport() {
+    return new NodemailerTransport({ sendmail: true });
+  }
+}
+```
+
+**Code: smtp to send all messages via the smtp operation**
+```typescript
+import { InjectableFactory } from '@travetto/di';
+import { NodemailerTransport } from '@travetto/email';
+
+class Config {
+  @InjectableFactory()
+  static getTransport() {
+    return new NodemailerTransport({
+      service: 'smtp'
+    });
+  }
+}
+```
+
+**Code: ses to send all messages via the ses operation**
+```typescript
+import { SESClient } from '@aws-sdk/client-ses';
+
+import { InjectableFactory } from '@travetto/di';
+import { NodemailerTransport } from '@travetto/email';
+
+class Config {
+  @InjectableFactory()
+  static getTransport() {
+    return new NodemailerTransport({
+      SES: SESClient
+    });
+  }
+}
+```

package/index.ts

@@ -0,0 +1 @@
+export * from './src/nodemailer';

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@travetto/email-nodemailer",
+  "displayName": "Email",
+  "version": "3.0.0-rc.0",
+  "description": "Email transmission module.",
+  "keywords": [
+    "email",
+    "nodemailer",
+    "travetto",
+    "typescript"
+  ],
+  "homepage": "https://travetto.io",
+  "license": "MIT",
+  "author": {
+    "email": "travetto.framework@gmail.com",
+    "name": "Travetto Framework"
+  },
+  "files": [
+    "index.ts",
+    "src"
+  ],
+  "main": "index.ts",
+  "repository": {
+    "url": "https://github.com/travetto/travetto.git",
+    "directory": "module/email-nodemailer"
+  },
+  "dependencies": {
+    "@travetto/email": "^3.0.0-rc.0",
+    "@types/nodemailer": "^6.4.5",
+    "nodemailer": "^6.7.8"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "docDependencies": {
+    "@aws-sdk/client-ses": "^3.160.0"
+  }
+}

package/src/nodemailer.ts

@@ -0,0 +1,39 @@
+import * as nodemailer from 'nodemailer';
+import type * as json from 'nodemailer/lib/json-transport';
+import type * as smtp from 'nodemailer/lib/smtp-transport';
+import type * as ses from 'nodemailer/lib/ses-transport';
+import type * as sendmail from 'nodemailer/lib/sendmail-transport';
+
+import { MailTransport, MessageOptions, SentMessage } from '@travetto/email';
+
+type Transport = nodemailer.Transport | json.Options | smtp.Options | ses.Options | sendmail.Options;
+
+/**
+ * Nodemailer transport, takes in a transport factory as the input
+ */
+export class NodemailerTransport implements MailTransport {
+  #transport: nodemailer.Transporter;
+
+  constructor(transportFactory: Transport) {
+    this.#transport = nodemailer.createTransport(transportFactory);
+  }
+
+  async send<S extends SentMessage = SentMessage>(mail: MessageOptions): Promise<S> {
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    const res = await this.#transport.sendMail(mail) as {
+      messageId?: string;
+      envelope?: Record<string, string>;
+      accepted?: string[];
+      rejected?: string[];
+      pending?: string[];
+      response?: string;
+    };
+
+    if (res.rejected?.length) {
+      console.error('Unable to send emails', { recipientCount: res.rejected?.length });
+    }
+
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    return res as S;
+  }
+}