first commit

Author: mat-sz

.eslintrc.json

@@ -0,0 +1,25 @@
+{
+  "env": {
+    "es6": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "globals": {
+    "Atomics": "readonly",
+    "SharedArrayBuffer": "readonly"
+  },
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 11,
+    "sourceType": "module"
+  },
+  "plugins": ["@typescript-eslint"],
+  "rules": {
+    "@typescript-eslint/ban-types": "off",
+    "@typescript-eslint/no-explicit-any": "off",
+    "no-empty": "off"
+  }
+}

.github/workflows/tests.yml

@@ -0,0 +1,27 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: yarn install
+      - run: yarn test

.gitignore

@@ -0,0 +1,7 @@
+node_modules
+yarn-error.log
+npm-error.log
+coverage
+vite*js
+
+lib

.npmignore

@@ -0,0 +1,12 @@
+src
+__tests__
+jest.config.js
+yarn-error.log
+yarn.lock
+.prettierrc
+tsconfig.json
+logo.png
+.github
+coverage
+vite*js
+vitest.config.ts

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "tabWidth": 2,
+  "singleQuote": true,
+  "semi": true,
+  "arrowParens": "avoid"
+}

LICENSE

@@ -0,0 +1,30 @@
+Copyright (c) 2023, Mat Sz
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted (subject to the limitations in the disclaimer
+below) provided that the following conditions are met:
+
+     * Redistributions of source code must retain the above copyright notice,
+     this list of conditions and the following disclaimer.
+
+     * Redistributions in binary form must reproduce the above copyright
+     notice, this list of conditions and the following disclaimer in the
+     documentation and/or other materials provided with the distribution.
+
+     * Neither the name of the copyright holder nor the names of its
+     contributors may be used to endorse or promote products derived from this
+     software without specific prior written permission.
+
+NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY
+THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
+IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,119 @@
+<h1 align="center">
+@typemail/smtp
+</h1>
+
+<p align="center">
+<img alt="workflow" src="https://img.shields.io/github/actions/workflow/status/typemail/smtp/tests.yml?branch=main">
+<a href="https://npmjs.com/package/@typemail/smtp">
+<img alt="npm" src="https://img.shields.io/npm/v/@typemail/smtp">
+<img alt="npm" src="https://img.shields.io/npm/dw/@typemail/smtp">
+<img alt="NPM" src="https://img.shields.io/npm/l/@typemail/smtp">
+</a>
+</p>
+
+@typemail/smtp is an SMTP library for node.js.
+
+## Server
+
+```js
+import { SMTPServer } from '@typemail/smtp/server';
+
+const server = new SMTPServer();
+
+server.on('connection', conn => {
+  conn.on('message', message => console.log(message));
+});
+```
+
+`message` will be of the type _SMTPMessage_:
+
+```ts
+export interface SMTPMessage {
+  recipients: string[];
+  sender: string;
+  message: string;
+}
+```
+
+The `message` is a raw message that needs to be parsed. [letterparser](https://github.com/mat-sz/letterparser) can be used to parse and extract data from the raw messages.
+
+### Options
+
+The constructor for `SMTPServer` accepts an options object.
+
+| Property       | Default value | Description                                                                                                              |
+| -------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------ |
+| `ip`           | `0.0.0.0`     | IP address to bind to.                                                                                                   |
+| `port`         | `25`          | Port to bind to. (Ports under 1024 usually require superuser privileges.)                                                |
+| `hostname`     | `localhost`   | Hostname advertised by the SMTP server.                                                                                  |
+| `size`         | `1000000`     | Maximum message size (in bytes).                                                                                         |
+| `tls`          | `undefined`   | [createSecureContext options](https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options) for STARTTLS support. |
+| `tlsPost`      | `465`         | Port for secure only communication, only enabled if `tls` is configured properly.                                        |
+| `authenticate` | `undefined`   | Authentication function. See [Authentication](#Authentication) for more details.                                         |
+| `authMethods`  | `undefined`   | Array of authentication method strings. See [Authentication](#Authentication) for more details.                          |
+
+### Events
+
+#### `listening`
+
+Emitted when all configured servers are listening.
+
+#### `message`
+
+Emitted when a message is succesfully received.
+
+#### `error`
+
+Emitted when an error occurs.
+
+#### `rejected`
+
+Emitted when a message is rejected. For now, this only happens when the message exceeds the maximum size.
+
+### Authentication
+
+To enable authentication, a function of following type must be passed with the options object:
+
+```ts
+  authenticate?: (
+    connection: SMTPServerConnection,
+    method: string,
+    payload?: { username: string; password: string; identity?: string; } | string[]
+  ) => boolean | Promise<boolean>;
+```
+
+Custom methods can be supported in the following way:
+
+```js
+import { SMTPServer } from '@typemail/smtp/server';
+
+const server = new SMTPServer({
+  supportedAuthenticationMethods: ['XOAUTH2', 'NTLM'],
+  authenticate: async (connection, method, payload) => {
+    switch (method) {
+      case 'XOAUTH2':
+        if (Array.isArray(payload) && typeof payload[0] === 'string') {
+          // Validate payload and return the result.
+          return true;
+        }
+        break;
+      case 'NTLM':
+        const negotiateResponse = await connection.challenge(
+          'ntlm supported',
+          true
+        );
+        // Test response.
+        const authenticateResponse = await connection.challenge('anything');
+        // Test response.
+        return true;
+        break;
+    }
+
+    return false;
+  },
+});
+
+server.on('connection', conn => {
+  conn.on('message', message => console.log(message));
+});
+```

__tests__/cert/server.cert

@@ -0,0 +1,31 @@
+-----BEGIN CERTIFICATE-----
+MIIFazCCA1OgAwIBAgIUQ5Hu/ZrmW2u34z01//6VEqcokn4wDQYJKoZIhvcNAQEL
+BQAwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoM
+GEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDAeFw0yMzA5MjgxNjQ1NDhaFw0zNDEy
+MTUxNjQ1NDhaMEUxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEw
+HwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwggIiMA0GCSqGSIb3DQEB
+AQUAA4ICDwAwggIKAoICAQCvDGqpZqFpW7HbIA6lZvyrwWxwttmwoz12qxskE1tk
+oVH6YZWJ3O7gMTqaCydcElsRrrgDq1xZpfhMaQ6WPK4iqu0Wtp3c1zUbXmIbQuzX
+V9QdKpLArH/B92tTVdB+UtJDwjRItxt4CVRpuvOATAB1Z1hSnhF2mYwnSMPLe7yq
+mO7fh02uaKyLCoMNnDpw6SCrF4TwFH4U2tLseQWnADOIL3Aw8HMKbYdy47+SbD+c
+sczbAoMTGX2zsPlphsncU4vl6txynr70ah2mmmNP95HiCixp07c3RTXopieeeNqs
+zWn50aoXQTBNfna2hA+d6VpYuVWZxm8y5KVhIr3os0J4mEQ3Cp6fA+pUFnr41/cF
+ZUn9Xijrd+yIj+lo1yA/0rXGONRdjWt9q4hjIMnTw5BuiHZCTrYEMUjUbRY9w3gY
+cMeJpF7dZKMTkF5cj96I0EUJ5slxqWdsq+YXZKLVmcwC54xbs5xU71o/HLJebSIW
+HQgfpxGigjQw5WGPB0EzwR40smnbvpVMSBYWTlBaE1DxEB0Zzxo2jMXl7dLPMp7W
+AsrVRFhh/V/pn4Qq/WaTJKuc/lQ0mZIjiqt7aO1gp48Nh0RM+oSLk6Tor8MCgBcM
+95KBfPKOMOgw8pOtVhRmDoODP3AxjUQWmt2StSvih3RsbEks4HUSylkYcH4mUBSF
+YQIDAQABo1MwUTAdBgNVHQ4EFgQU+5lf/ovvQskPBSnSLiO0F7L1r/YwHwYDVR0j
+BBgwFoAU+5lf/ovvQskPBSnSLiO0F7L1r/YwDwYDVR0TAQH/BAUwAwEB/zANBgkq
+hkiG9w0BAQsFAAOCAgEAXCrjZADEMJGuUUpM2funat+wFeS/U7zD7kSyNMWDsQgy
+GwzAm5sWncT/qfCZryzOS8K/Lqi10sMx9RZhGJquFjwtEhu45cY94fW7FIpkrEce
+frq34YGDrwlxJZW1/SK+pIsuGuB+apj8gbijh4nzw0wojs4EBEzo+Xi3zXN81U2L
+gN/XYypDt3YSUxI1MCrrWGiErDK7Ki3VAg+RwCJJGBjnQAbKrxIiSU2Wjgatb3NH
+MG9HgXgvDQAvxwF7a2k2eNrwOOjLgJaItYjeUygQ4KnxVYe8h5E3fx5guLQf9M1f
+HqlTVRR6EFCdhDTk/zLBuocMHa4mLF/bPhlK4mFVt743ga/Wv5IZtvTnuPRVbfch
+486JMzmbQYYk+O/ORidK72Qq8vza/CnpBkqhiv7vF9Lnx4Ybt71eHl05QuqxcsUR
+7BWnH7rnI6A/VyxQYJOPHi9JBWRcXSBn+L/A8glxhz2VWPxAV6AxGmtUbQ2QCM7q
+BBRorYijvQGufGTeaCXiYT8GtnwRtIj3zPbrMG7jbcNHPBF7uV3PIruoyNWWzQav
+FqFvsQHg0Ae9NlUn9P2lISwP/qEStYqzevTvX+oTBIsepKdIS+50WqYeiUzUwNsK
+yOpIA68GNplavExqyISECFqkOoRpDwJTKCgIWJ5H3rw+dyDA6IOPkRX/kZTCf1w=
+-----END CERTIFICATE-----

__tests__/cert/server.key

@@ -0,0 +1,52 @@
+-----BEGIN PRIVATE KEY-----
+MIIJQgIBADANBgkqhkiG9w0BAQEFAASCCSwwggkoAgEAAoICAQCvDGqpZqFpW7Hb
+IA6lZvyrwWxwttmwoz12qxskE1tkoVH6YZWJ3O7gMTqaCydcElsRrrgDq1xZpfhM
+aQ6WPK4iqu0Wtp3c1zUbXmIbQuzXV9QdKpLArH/B92tTVdB+UtJDwjRItxt4CVRp
+uvOATAB1Z1hSnhF2mYwnSMPLe7yqmO7fh02uaKyLCoMNnDpw6SCrF4TwFH4U2tLs
+eQWnADOIL3Aw8HMKbYdy47+SbD+csczbAoMTGX2zsPlphsncU4vl6txynr70ah2m
+mmNP95HiCixp07c3RTXopieeeNqszWn50aoXQTBNfna2hA+d6VpYuVWZxm8y5KVh
+Ir3os0J4mEQ3Cp6fA+pUFnr41/cFZUn9Xijrd+yIj+lo1yA/0rXGONRdjWt9q4hj
+IMnTw5BuiHZCTrYEMUjUbRY9w3gYcMeJpF7dZKMTkF5cj96I0EUJ5slxqWdsq+YX
+ZKLVmcwC54xbs5xU71o/HLJebSIWHQgfpxGigjQw5WGPB0EzwR40smnbvpVMSBYW
+TlBaE1DxEB0Zzxo2jMXl7dLPMp7WAsrVRFhh/V/pn4Qq/WaTJKuc/lQ0mZIjiqt7
+aO1gp48Nh0RM+oSLk6Tor8MCgBcM95KBfPKOMOgw8pOtVhRmDoODP3AxjUQWmt2S
+tSvih3RsbEks4HUSylkYcH4mUBSFYQIDAQABAoICADDcQWV5fTKAYrusTgpDHeH/
+QnqPv2G7nuthxVijgo4rLUu7M1dg8NhpRVc8J8deZEciQsDbcxKe7hi99lFfLKgG
+l9kQLi43b95s0OuVGbDeFhnyCTZ4r8x/eFixilnIWmKJcbieS6+MwyAkC9XS4Qnk
+R9X/wxYcs+8/M0+4ASiJOZvxE3DMTOUekQgahIGBwRmgnf25apv9nIRfH4HG35ty
+ylkOtL3DZtxdz9paFsNxKaI0KEwLgHfIvUWEVxIFy/XoQZJI1zo36IDZdUEb9H9o
+oY8Eho6J5gtDXamxSDCVwa/2owiMrKPk2dQGNqm4Ofyr9sXOirlk8viTDvlGGBZE
+hjA8LCUHGVN21iY5fM2iyb9hxzLbd5kStt4u3nNr6L5mSXzHVwTsUmLC4Z72YnBz
+1srDEb8MJB1uSzEsWhKOmh2SlMxnt53H6JgJ9Sp3agPPjGX7GWBNE0cRDNLnxBuT
+wgTMI096rz+idy0Cbco/oLqN63x0NtcAb6U4EoIqCUxZqqjll9JC6QEAxIrKMwqH
+X8R92/pR22xav1ROpv7EMUtJkuhhNuTvHEjJILT0g6NWlWwGgwHE94DbDodG7Yvm
+2ozgJIukucxVk2sjRAR6JOsaYk/qxVrYPJGcfH0ntRTA5UC23QharrOOPaQ0W2Fi
+ZzGB+cpdBaYRX/JIR5ylAoIBAQDpRPu1McFu0tYP1bwpw00Op5Qx5duJuMuHjZI2
+OmJNAFMkJqx0VPQ3EBjHE9ELv9pCtZADJdLRc/LAZB6d9lHUvUTpBL/ubcNZazWl
+CYaRPg/oDfhehs34Ka81WC5jHZwJ8ekk5r54B3S2VH4eOWragjR7IIE/6UYAyjAO
+kPuFJObD/5GSxQJXeZz0ViYO1c1khkacuhXuNvw8l9I8PaMkCQWx86zNxyUelwqE
+w9JA/8iE7RAO+xGaDnpi4P6dESAXakWHKvh4r4i5++cKh9wmQ/JhpcUVZ8a2hb3w
+con47UppBqzdkYJ7FZR1x7Rmx29UWD/JSotcIxnPxA0f43uLAoIBAQDAGxWEBXjR
+sljBrB8WXLVAWZTbK46DxKSi0Oc3MGxtpmpKtmjOIwCVsDYDRqxUkx4yl0dPSus4
+zIE/ToC41jgtyFowhap58ciEchifDKUJBBrDGWIKcS0+M+OuUg6N3cg6Csl17Hca
+y8vC5oZtdiSkQq/XF9jl4iNmB9lXtt0b5GQu1NXcJbZ8AYdrR+R2e2GMPMz9DNgW
+rQ3LqASW8o2NJ50RXLCJvrfomArNVkz/mIUNgl4LnkX1ITKj2BhanMmenV336cay
+7ofd70oNEyXQ01WrVrenvGaEjcMo7E0Skx9wIHkOKdmcRlwGatJBF7a39ZLS95Wm
+xrWwRkkLx5BDAoIBAGu/sYTAtti6CqbF02R3EeDzB0EFK6Mx+NFkU2U5Eq7+t2i7
+dG1H0IaeqNNMFAOZWvf1ZdAOaJLXPAoiNQJCBQp/YpU/3GgFy3ZCT0UsYTw1rqNB
+0LfZDMrUdlntoX+m7ayqUUb6ToCi8QZHgPn1C6Zi/lrhaNJcrjkvK4OO9J9LrExc
+gKGK3soJIra6FFpF59nHLFa4neiq/Vf/yNyKnBDJGhhYtjlXA45dtj4dNcFQZQ8B
+cal5z2eZyG5j/zgN8QTf0b3d22fjrQQ7lz0GBGqoeA0ixSZeCSvGGzY1sgWJlhVt
+P+wYimzQSwMce/f9py8OlGgmRrkIfaO6q1VPfoECggEBAKmyQxtQSh3S0ZyjkwKJ
++oJRn7DLlSTI/DXnG5gg6mch7hr5bzNIsCeKdOwH7gr3umEuSQu+PnL6E+H8UrD0
+asPmi+T47lKyRlLZBu7YmKCSQ6G8NmLK/xBHfgRq7/hZxZmgFb5ZmAzPobsVMAJZ
+rpx7XCFBK5RGYsaqgE9/dWpCIk1MLW4+0ihQoXMfGq2e59idjOasBeZiECGq1gMR
+WAEs0Q6ZNkk3c/W++SvR5EqUTFRWqQTSVzHmlXkuVrUUcvXuRSfOFnvRQavGyT8r
+fugtByxHegxt3JGTOKZZtuuFkuvVg5oDVfs6G+h/TCO78uglwgEiO8wLFEwWikgh
+jUkCggEASPbT3Vtbt+AAekn1b8fShllInIZSDt/20VQnbj8z39sieaFzB1Nl/Wqq
+Vvdmn3fPFv4jrgEDCjKD9PKPo95S9zSMb0l/limYj4B4I125jRB1lQOVIrRgp7rw
+YiSaMLiP95wO8GlNjJDNtMMWAGauRe7J9Inv4R618KI3I6lmwbj9h+wPtSIWRvfQ
+I+NzWjN1KOjJwUzq4G8v4NvTyQhRp2mXZj4wCnp5y/Eus2W43MaWeNSW3i5BlbIM
+c04IjvSlqkJ2mEjjRBxsqjz9cPFJDRuP19Nhle6py3FP+i9ofcBMSsrBkj9wjsP0
+PGggbVpwhCRGZk36lamfUBzEbQ5CvA==
+-----END PRIVATE KEY-----

__tests__/client/index.test.ts

@@ -0,0 +1,69 @@
+import { sendmail, SMTPServer, SMTPClient } from '../../src/index.js';
+
+const HOST = '127.0.0.1';
+const PORT = 5525;
+let server: SMTPServer;
+
+describe('client', () => {
+  // TODO: TLS tests
+  // TODO: Error handling tests
+  // TODO:  Auth tests
+  // TODO: Capability tests
+  // TODO: Greeting tests
+
+  beforeAll(() => {
+    server = new SMTPServer({
+      hostname: 'localhost',
+    });
+    server.listen(PORT, HOST);
+  });
+
+  describe('SMTPClient', () => {
+    it('sends emails', () => {
+      const message = {
+        sender: 'a@localhost',
+        recipients: ['b@localhost'],
+        message: 'Test',
+      };
+
+      return new Promise(resolve => {
+        server.once('connection', connection => {
+          connection.on('message', msg => {
+            expect(msg).toMatchObject(message);
+            resolve(true);
+          });
+        });
+
+        const client = new SMTPClient({ hostname: HOST, port: PORT });
+        client.on('ready', () => {
+          client.mail(message);
+        });
+      });
+    });
+  });
+
+  describe('sendmail', () => {
+    it('sends emails', () => {
+      const message = {
+        sender: 'a@localhost',
+        recipients: ['b@localhost'],
+        message: 'Test',
+      };
+
+      return new Promise(resolve => {
+        server.once('connection', connection => {
+          connection.on('message', msg => {
+            expect(msg).toMatchObject(message);
+            resolve(true);
+          });
+        });
+
+        sendmail(message, { smtp: { hostname: HOST, port: PORT } });
+      });
+    });
+  });
+
+  afterAll(() => {
+    server.close();
+  });
+});