temp-disposable-email 0.0.0

package/.nvmrc

@@ -0,0 +1 @@
+20.x.x

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Pirasanthan Jesugeevegan
+
+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,196 @@
+<h1 align="center">Temp Disposable Email</h1>
+<p align="center">
+<a href="#feature">Features</a> |
+<a href="#install">Install</a> |
+<a href="#usage">Usage </a>|
+<a href="#example">Examples </a>|
+<a href="#doc">API Document</a>
+</p>
+
+<div align="center">
+  <span style="display: inline-block; margin-right: 10px;">
+    <a href="https://www.npmjs.com/package/gmail-tester">
+      <img src="https://badge.fury.io/js/temp-disposable-email.svg" alt="npm version" />
+    </a>
+  </span>
+  <span style="display: inline-block; margin-right: 10px;">
+    <img src="https://img.shields.io/npm/d18m/temp-disposable-email" alt="NPM Downloads" />
+  </span>
+  <span style="display: inline-block; margin-right: 10px;">
+    <a href="https://opensource.org/licenses/MIT">
+      <img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT" />
+    </a>
+  </span>
+  <span style="display: inline-block;">
+    <a href="https://github.com/pirasanthan-jesugeevegan/temp-disposable-email">
+      <img src="https://img.shields.io/github/stars/pirasanthan-jesugeevegan/temp-disposable-email?style=social" alt="GitHub stars" />
+    </a>
+  </span>
+</div>
+
+This npm package provides a simple interface for temp email. You can use it to create disposable email accounts, retrieve messages, and delete accounts when done. It includes polling functionality to wait for messages in the inbox and fetch their content.
+
+<p id="feature"></p>
+
+## Features
+
+- **Create Inbox**: Generate a unique, random email address and create an inbox.
+- **Fetch Messages**: Retrieve the latest messages from the inbox.
+- **Read Message Content**: Get the content (HTML and text) of a specific message.
+- **Delete Messages**: Delete a specific message from the inbox.
+- **Delete Account**: Remove the temporary account after usage
+
+<p id="install"></p>
+
+## Installation
+
+You can install this package via npm:
+
+```bash
+npm install temp-disposable-email
+```
+
+<p id="usage"></p>
+
+## Usage
+
+### 1\. Importing the package
+
+To use the package, import the functions in your TypeScript or JavaScript project:
+
+#### Using ES Modules (Recommended)
+
+```typescript
+import { createInbox, getMessage, deleteAccount } from 'temp-disposable-email';
+```
+
+#### Using CommonJS
+
+```javascript
+const {
+  createInbox,
+  getMessage,
+  deleteAccount,
+} = require('temp-disposable-email');
+```
+
+### 2\. Create an Inbox
+
+This function creates a new disposable email account using a random username or a specified one. It also authenticates and generates a token for accessing messages.
+
+```typescript
+const email = await createInbox(); // or pass a custom username
+console.log('Created email address:', email);
+```
+
+#### Parameters
+
+- `username` (Optional): The username for the new email address. If not provided, a random username will be generated.
+
+#### Returns
+
+- `Promise<string>`: The generated email address.
+
+### 3\. Fetch Recent Email
+
+This function retrieves the latest message from the created inbox. You can specify polling options (timeout, interval, logging) for periodic checks when no message is immediately available.
+
+```typescript
+const message = await getRecentEmail();
+console.log('Message received:', message);
+```
+
+#### Parameters
+
+- `options` (Optional): Polling options that can include:
+  - `maxWaitTime`: Maximum polling time in milliseconds (default: 30,000ms).
+  - `waitInterval`: Interval between polling attempts in milliseconds (default: 2,000ms).
+  - `logPolling`: Enable or disable logging of polling attempts (default: false).
+  - `deleteAfterRead`: Whether to delete the latest message after reading, helpful for parallel run
+
+#### Returns
+
+- `Promise<object | null>`: An object containing email details like `from`, `to`, `subject`, `intro`, `text`, and `html`.
+
+### 4\. Delete the Created Account
+
+Once you're done with the email inbox, you can delete the account to clean up resources.
+
+```typescript
+await deleteAccount();
+console.log('Account deleted');
+```
+
+#### Returns
+
+- `Promise<void>`: Resolves when the account is successfully deleted.
+
+<p id="example"></p>
+
+## Example Workflow
+
+Here's a complete example of creating an inbox, retrieving a message, and deleting the account:
+
+```typescript
+import { createInbox, getMessage, deleteAccount } from 'temp-disposable-email';
+
+async function run() {
+  try {
+    // Create a new inbox
+    const email = await createInbox();
+    console.log('Created email:', email);
+
+    // Get the first available message from the inbox
+    const message = await getMessage({
+      maxWaitTime: 50000,
+      waitInterval: 3000,
+      logPolling: true,
+    });
+    console.log('Received message:', message);
+
+    // Delete the inbox
+    await deleteAccount();
+    console.log('Account deleted successfully');
+  } catch (error) {
+    console.error('Error:', error.message);
+  }
+}
+
+run();
+```
+
+<p id="doc"></p>
+
+## API Documentation
+
+### `createInbox(username?: string): Promise<string>`
+
+- **Description**: Creates a disposable inbox with a randomly generated or provided username.
+- **Parameters**:
+  - `username` (Optional): A custom username for the email address.
+- **Returns**: A promise that resolves to the generated email address.
+
+### `getRecentEmail(options?: GetEmailOptions): Promise<any | null>`
+
+- **Description**: Retrieves the latest message from the inbox, polling if necessary.
+- **Parameters**:
+  - `options` (Optional): Polling configuration for waiting for messages. See GetEmailOptions.
+- **Returns**: A promise that resolves to the message content (or `null` if no messages are found).
+
+### `deleteAccount(): Promise<void>`
+
+- **Description**: Deletes the inbox and its associated account.
+- **Returns**: A promise that resolves when the account is successfully deleted.
+
+## Get Email Options
+
+You can configure polling behavior by passing an options object to `getMessage`. The available options are:
+
+- `maxWaitTime` (Optional): The maximum time to wait for messages (in milliseconds).
+- `waitInterval` (Optional): The interval between polling attempts (in milliseconds).
+- `logPolling` (Optional): Whether to log each polling attempt for debugging purposes.
+- `deleteAfterRead` (Optional): Whether to delete messages after reading
+
+## License
+
+This project is licensed under the MIT License.

package/cypress.config.ts

@@ -0,0 +1,12 @@
+import { defineConfig } from 'cypress';
+
+export default defineConfig({
+  e2e: {
+    specPattern: 'examples/cypress/e2e/**/*.cy.ts',
+    supportFile: 'examples/cypress/support/e2e.ts',
+    fixturesFolder: 'examples/cypress/fixtures',
+    setupNodeEvents(on, config) {
+      // implement node event listeners here
+    },
+  },
+});

package/dist/cjs/index.d.ts

@@ -0,0 +1,4 @@
+export { createInbox, deleteAccount } from './services/accountService';
+export { getRecentEmail, deleteMessage, MessageContent, GetEmailOptions, } from './services/messageService';
+export { getVerificationCode } from './utils/getVerificationCode';
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AACvE,OAAO,EACL,cAAc,EACd,aAAa,EACb,cAAc,EACd,eAAe,GAChB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC"}

package/dist/cjs/index.js

@@ -0,0 +1,47 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getVerificationCode = exports.deleteMessage = exports.getRecentEmail = exports.deleteAccount = exports.createInbox = void 0;
+const dotenv = __importStar(require("dotenv"));
+dotenv.config();
+var accountService_1 = require("./services/accountService");
+Object.defineProperty(exports, "createInbox", { enumerable: true, get: function () { return accountService_1.createInbox; } });
+Object.defineProperty(exports, "deleteAccount", { enumerable: true, get: function () { return accountService_1.deleteAccount; } });
+var messageService_1 = require("./services/messageService");
+Object.defineProperty(exports, "getRecentEmail", { enumerable: true, get: function () { return messageService_1.getRecentEmail; } });
+Object.defineProperty(exports, "deleteMessage", { enumerable: true, get: function () { return messageService_1.deleteMessage; } });
+var getVerificationCode_1 = require("./utils/getVerificationCode");
+Object.defineProperty(exports, "getVerificationCode", { enumerable: true, get: function () { return getVerificationCode_1.getVerificationCode; } });
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAAiC;AACjC,MAAM,CAAC,MAAM,EAAE,CAAC;AAEhB,4DAAuE;AAA9D,6GAAA,WAAW,OAAA;AAAE,+GAAA,aAAa,OAAA;AACnC,4DAKmC;AAJjC,gHAAA,cAAc,OAAA;AACd,+GAAA,aAAa,OAAA;AAIf,mEAAkE;AAAzD,0HAAA,mBAAmB,OAAA"}

package/dist/cjs/services/accountService.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Creates a new email inbox with a unique address.
+ *
+ * This function selects an available domain, generates an email
+ * address, and attempts to create an account on the Mail.tm service.
+ * If account creation is rate-limited, the function retries with a
+ * delay. Upon successful creation, it authenticates the account and
+ * stores the token and account ID for future API calls.
+ *
+ * @param {string} [username] - Optional username; a random one is generated if not provided.
+ * @returns {Promise<string>} The generated email address.
+ *
+ * @throws {Error} If no domains are available or account creation fails.
+ *
+ * @example
+ * const email = await createInbox("customUser");
+ * console.log(email); // Outputs: "customUser@mail.tm"
+ */
+export declare const createInbox: (username?: string) => Promise<string>;
+/**
+ * Deletes the account created during `createInbox`.
+ *
+ * This function removes the email account from the Mail.tm service
+ * and clears the stored authentication token and account ID.
+ * Subsequent API calls requiring authentication will fail until a
+ * new account is created.
+ *
+ * @returns {Promise<void>} Resolves when the account is successfully deleted.
+ *
+ * @throws {Error} If no account is authenticated or deletion fails.
+ *
+ * @example
+ * await deleteAccount();
+ * console.log("Account deleted successfully.");
+ */
+export declare const deleteAccount: () => Promise<void>;
+//# sourceMappingURL=accountService.d.ts.map

package/dist/cjs/services/accountService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"accountService.d.ts","sourceRoot":"","sources":["../../../src/services/accountService.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;;;;GAiBG;AAEH,eAAO,MAAM,WAAW,cAAqB,MAAM,KAAG,OAAO,CAAC,MAAM,CA2CnE,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,aAAa,QAAa,OAAO,CAAC,IAAI,CAelD,CAAC"}

package/dist/cjs/services/accountService.js

@@ -0,0 +1,100 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteAccount = exports.createInbox = void 0;
+const axios_1 = __importDefault(require("axios"));
+const authService_1 = require("./authService");
+const generateRandomName_1 = require("../utils/generateRandomName");
+const delay_1 = require("../utils/delay");
+const constant_1 = require("../utils/constant");
+let accountId = null;
+/**
+ * Creates a new email inbox with a unique address.
+ *
+ * This function selects an available domain, generates an email
+ * address, and attempts to create an account on the Mail.tm service.
+ * If account creation is rate-limited, the function retries with a
+ * delay. Upon successful creation, it authenticates the account and
+ * stores the token and account ID for future API calls.
+ *
+ * @param {string} [username] - Optional username; a random one is generated if not provided.
+ * @returns {Promise<string>} The generated email address.
+ *
+ * @throws {Error} If no domains are available or account creation fails.
+ *
+ * @example
+ * const email = await createInbox("customUser");
+ * console.log(email); // Outputs: "customUser@mail.tm"
+ */
+const createInbox = async (username) => {
+    const domainsResponse = await axios_1.default.get(`${constant_1.BASE_URL}/domains`, {
+        headers: { accept: 'application/ld+json' },
+    });
+    const domains = domainsResponse.data['hydra:member'].map((domain) => domain.domain);
+    if (domains.length === 0)
+        throw new Error('No available domains.');
+    const emailAddress = `${username || (0, generateRandomName_1.generateRandomName)()}@${domains[0]}`;
+    const password = (0, generateRandomName_1.generateRandomName)();
+    let attempts = 0;
+    const maxRetries = 5;
+    while (attempts < maxRetries) {
+        try {
+            const accountResponse = await axios_1.default.post(`${constant_1.BASE_URL}/accounts`, { address: emailAddress, password }, {
+                headers: {
+                    accept: 'application/json',
+                    'Content-Type': 'application/json',
+                },
+            });
+            accountId = accountResponse.data.id;
+            await (0, authService_1.authenticate)(emailAddress, password);
+            return emailAddress;
+        }
+        catch (error) {
+            if (error.response?.status === 429) {
+                attempts++;
+                const retryAfter = error.response.headers['retry-after']
+                    ? parseInt(error.response.headers['retry-after'])
+                    : 5;
+                await (0, delay_1.delay)(retryAfter * 1000);
+            }
+            else {
+                throw error;
+            }
+        }
+    }
+    throw new Error('Failed to create account after multiple retries.');
+};
+exports.createInbox = createInbox;
+/**
+ * Deletes the account created during `createInbox`.
+ *
+ * This function removes the email account from the Mail.tm service
+ * and clears the stored authentication token and account ID.
+ * Subsequent API calls requiring authentication will fail until a
+ * new account is created.
+ *
+ * @returns {Promise<void>} Resolves when the account is successfully deleted.
+ *
+ * @throws {Error} If no account is authenticated or deletion fails.
+ *
+ * @example
+ * await deleteAccount();
+ * console.log("Account deleted successfully.");
+ */
+const deleteAccount = async () => {
+    const token = (0, authService_1.getToken)();
+    if (!token || !accountId) {
+        throw new Error('Account information missing. Create and authenticate an account first.');
+    }
+    await axios_1.default.delete(`${constant_1.BASE_URL}/accounts/${accountId}`, {
+        headers: {
+            accept: '*/*',
+            Authorization: `Bearer ${token}`,
+        },
+    });
+    accountId = null;
+};
+exports.deleteAccount = deleteAccount;
+//# sourceMappingURL=accountService.js.map

package/dist/cjs/services/accountService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accountService.js","sourceRoot":"","sources":["../../../src/services/accountService.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAC1B,+CAAuD;AACvD,oEAAiE;AACjE,0CAAuC;AACvC,gDAA6C;AAE7C,IAAI,SAAS,GAAkB,IAAI,CAAC;AACpC;;;;;;;;;;;;;;;;;GAiBG;AAEI,MAAM,WAAW,GAAG,KAAK,EAAE,QAAiB,EAAmB,EAAE;IACtE,MAAM,eAAe,GAAG,MAAM,eAAK,CAAC,GAAG,CAAC,GAAG,mBAAQ,UAAU,EAAE;QAC7D,OAAO,EAAE,EAAE,MAAM,EAAE,qBAAqB,EAAE;KAC3C,CAAC,CAAC;IACH,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,GAAG,CACtD,CAAC,MAA0B,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAC9C,CAAC;IACF,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAEnE,MAAM,YAAY,GAAG,GAAG,QAAQ,IAAI,IAAA,uCAAkB,GAAE,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IACzE,MAAM,QAAQ,GAAG,IAAA,uCAAkB,GAAE,CAAC;IAEtC,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,MAAM,UAAU,GAAG,CAAC,CAAC;IAErB,OAAO,QAAQ,GAAG,UAAU,EAAE,CAAC;QAC7B,IAAI,CAAC;YACH,MAAM,eAAe,GAAG,MAAM,eAAK,CAAC,IAAI,CACtC,GAAG,mBAAQ,WAAW,EACtB,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,EACnC;gBACE,OAAO,EAAE;oBACP,MAAM,EAAE,kBAAkB;oBAC1B,cAAc,EAAE,kBAAkB;iBACnC;aACF,CACF,CAAC;YACF,SAAS,GAAG,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;YACpC,MAAM,IAAA,0BAAY,EAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;YAC3C,OAAO,YAAY,CAAC;QACtB,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,IAAI,KAAK,CAAC,QAAQ,EAAE,MAAM,KAAK,GAAG,EAAE,CAAC;gBACnC,QAAQ,EAAE,CAAC;gBACX,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC;oBACtD,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;oBACjD,CAAC,CAAC,CAAC,CAAC;gBACN,MAAM,IAAA,aAAK,EAAC,UAAU,GAAG,IAAI,CAAC,CAAC;YACjC,CAAC;iBAAM,CAAC;gBACN,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;IACH,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;AACtE,CAAC,CAAC;AA3CW,QAAA,WAAW,eA2CtB;AAEF;;;;;;;;;;;;;;;GAeG;AACI,MAAM,aAAa,GAAG,KAAK,IAAmB,EAAE;IACrD,MAAM,KAAK,GAAG,IAAA,sBAAQ,GAAE,CAAC;IACzB,IAAI,CAAC,KAAK,IAAI,CAAC,SAAS,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CACb,wEAAwE,CACzE,CAAC;IACJ,CAAC;IAED,MAAM,eAAK,CAAC,MAAM,CAAC,GAAG,mBAAQ,aAAa,SAAS,EAAE,EAAE;QACtD,OAAO,EAAE;YACP,MAAM,EAAE,KAAK;YACb,aAAa,EAAE,UAAU,KAAK,EAAE;SACjC;KACF,CAAC,CAAC;IACH,SAAS,GAAG,IAAI,CAAC;AACnB,CAAC,CAAC;AAfW,QAAA,aAAa,iBAexB"}

package/dist/cjs/services/authService.d.ts

@@ -0,0 +1,3 @@
+export declare const authenticate: (email: string, password: string) => Promise<void>;
+export declare const getToken: () => string | null;
+//# sourceMappingURL=authService.d.ts.map

package/dist/cjs/services/authService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authService.d.ts","sourceRoot":"","sources":["../../../src/services/authService.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,YAAY,UAChB,MAAM,YACH,MAAM,KACf,OAAO,CAAC,IAAI,CAYd,CAAC;AAEF,eAAO,MAAM,QAAQ,QAAO,MAAM,GAAG,IAAa,CAAC"}

package/dist/cjs/services/authService.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getToken = exports.authenticate = void 0;
+const axios_1 = __importDefault(require("axios"));
+const constant_1 = require("../utils/constant");
+let token = null;
+const authenticate = async (email, password) => {
+    const response = await axios_1.default.post(`${constant_1.BASE_URL}/token`, { address: email, password }, {
+        headers: {
+            accept: 'application/json',
+            'Content-Type': 'application/json',
+        },
+    });
+    token = response.data.token;
+};
+exports.authenticate = authenticate;
+const getToken = () => token;
+exports.getToken = getToken;
+//# sourceMappingURL=authService.js.map

package/dist/cjs/services/authService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authService.js","sourceRoot":"","sources":["../../../src/services/authService.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAC1B,gDAA6C;AAE7C,IAAI,KAAK,GAAkB,IAAI,CAAC;AAEzB,MAAM,YAAY,GAAG,KAAK,EAC/B,KAAa,EACb,QAAgB,EACD,EAAE;IACjB,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,IAAI,CAC/B,GAAG,mBAAQ,QAAQ,EACnB,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,EAC5B;QACE,OAAO,EAAE;YACP,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,kBAAkB;SACnC;KACF,CACF,CAAC;IACF,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;AAC9B,CAAC,CAAC;AAfW,QAAA,YAAY,gBAevB;AAEK,MAAM,QAAQ,GAAG,GAAkB,EAAE,CAAC,KAAK,CAAC;AAAtC,QAAA,QAAQ,YAA8B"}

package/dist/cjs/services/messageService.d.ts

@@ -0,0 +1,54 @@
+export interface MessageContent {
+    from: {
+        address: string;
+    };
+    to: {
+        address: string;
+    }[];
+    subject: string;
+    intro: string;
+    text: string;
+    html: string;
+}
+export interface GetEmailOptions {
+    maxWaitTime?: number;
+    waitInterval?: number;
+    logPolling?: boolean;
+    deleteAfterRead?: boolean;
+}
+/**
+ * Retrieves the latest message from the inbox.
+ *
+ * If messages are available, this function fetches the first one and
+ * returns its details. Polling options can be specified to wait for
+ * messages if the inbox is empty. Optionally, the message can be
+ * deleted after reading.
+ *
+ * @param {GetEmailOptions} [options] - Optional settings for polling and deletion.
+ * @returns {Promise<MessageContent | null>} The email content (sender, recipient, subject, text, HTML), or `null` if no messages are found.
+ *
+ * @throws {Error} If no messages are available within the polling timeout or authentication fails.
+ *
+ * @example
+ * const message = await getRecentEmail({ maxWaitTime: 5000, waitInterval: 1000, logPolling: true });
+ * console.log(message.subject); // Outputs: "Hello!"
+ */
+export declare const getRecentEmail: (options?: GetEmailOptions) => Promise<MessageContent | null>;
+/**
+ * Deletes a message by its unique ID from the Mail.tm inbox.
+ *
+ * This function requires a valid authentication token. If the
+ * token is not set, an error is thrown. The message is deleted
+ * using the Mail.tm API, and a success or failure message is logged.
+ *
+ * @param {string} messageId - The unique ID of the message to delete.
+ * @returns {Promise<void>} Resolves after the message is deleted.
+ *
+ * @throws {Error} If authentication is missing or the deletion fails.
+ *
+ * @example
+ * await deleteMessage("12345");
+ * console.log("Message deleted successfully.");
+ */
+export declare const deleteMessage: (messageId: string) => Promise<void>;
+//# sourceMappingURL=messageService.d.ts.map

package/dist/cjs/services/messageService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messageService.d.ts","sourceRoot":"","sources":["../../../src/services/messageService.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1B,EAAE,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AACD,MAAM,WAAW,eAAe;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,cAAc,aACf,eAAe,KACxB,OAAO,CAAC,cAAc,GAAG,IAAI,CAkF/B,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,aAAa,cAAqB,MAAM,KAAG,OAAO,CAAC,IAAI,CAenE,CAAC"}

package/dist/cjs/services/messageService.js

@@ -0,0 +1,122 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteMessage = exports.getRecentEmail = void 0;
+const axios_1 = __importDefault(require("axios"));
+const authService_1 = require("./authService");
+const constant_1 = require("../utils/constant");
+const api_1 = require("../utils/api");
+/**
+ * Retrieves the latest message from the inbox.
+ *
+ * If messages are available, this function fetches the first one and
+ * returns its details. Polling options can be specified to wait for
+ * messages if the inbox is empty. Optionally, the message can be
+ * deleted after reading.
+ *
+ * @param {GetEmailOptions} [options] - Optional settings for polling and deletion.
+ * @returns {Promise<MessageContent | null>} The email content (sender, recipient, subject, text, HTML), or `null` if no messages are found.
+ *
+ * @throws {Error} If no messages are available within the polling timeout or authentication fails.
+ *
+ * @example
+ * const message = await getRecentEmail({ maxWaitTime: 5000, waitInterval: 1000, logPolling: true });
+ * console.log(message.subject); // Outputs: "Hello!"
+ */
+const getRecentEmail = async (options) => {
+    const token = (0, authService_1.getToken)();
+    const { maxWaitTime = 30000, waitInterval = 2000, logPolling = false, deleteAfterRead = false, } = options || {};
+    if (!token)
+        throw new Error('Authentication required. Call createInbox() first.');
+    if (!options) {
+        const messages = await (0, api_1.fetchMessages)();
+        if (messages.length === 0)
+            throw new Error('No messages available');
+        const messageId = messages[0].id;
+        const { from, to, subject, intro, text, html } = await (0, api_1.fetchMessageContent)(messageId);
+        if (deleteAfterRead) {
+            await (0, exports.deleteMessage)(messageId);
+        }
+        return {
+            from: from.address,
+            to: to[0].address,
+            subject,
+            intro,
+            text,
+            html,
+        };
+    }
+    const startTime = Date.now();
+    if (logPolling) {
+        console.log(`Polling started with a timeout of ${maxWaitTime / 1000}sec and interval of ${waitInterval / 1000}sec.`);
+    }
+    while (Date.now() - startTime < maxWaitTime) {
+        const messages = await (0, api_1.fetchMessages)();
+        if (messages.length > 0) {
+            if (logPolling) {
+                console.log(`Found ${messages.length} message(s), fetching details...`);
+            }
+            const messageId = messages[0].id;
+            if (logPolling) {
+                console.log(`Message retrieved`);
+            }
+            const { from, to, subject, intro, text, html } = await (0, api_1.fetchMessageContent)(messageId);
+            if (deleteAfterRead) {
+                await (0, exports.deleteMessage)(messageId);
+            }
+            return {
+                from: from.address,
+                to: to[0].address,
+                subject,
+                intro,
+                text,
+                html,
+            };
+        }
+        await new Promise((resolve) => setTimeout(resolve, waitInterval));
+        if (logPolling) {
+            console.log(`No messages found, waiting for ${waitInterval / 1000} seconds...`);
+        }
+    }
+    if (logPolling) {
+        console.log(`Waiting timeout of ${maxWaitTime / 1000} seconds reached. No messages found.`);
+    }
+    throw new Error(`No messages available within ${maxWaitTime / 1000} seconds timeout`);
+};
+exports.getRecentEmail = getRecentEmail;
+/**
+ * Deletes a message by its unique ID from the Mail.tm inbox.
+ *
+ * This function requires a valid authentication token. If the
+ * token is not set, an error is thrown. The message is deleted
+ * using the Mail.tm API, and a success or failure message is logged.
+ *
+ * @param {string} messageId - The unique ID of the message to delete.
+ * @returns {Promise<void>} Resolves after the message is deleted.
+ *
+ * @throws {Error} If authentication is missing or the deletion fails.
+ *
+ * @example
+ * await deleteMessage("12345");
+ * console.log("Message deleted successfully.");
+ */
+const deleteMessage = async (messageId) => {
+    const token = (0, authService_1.getToken)();
+    if (!token)
+        throw new Error('Authentication required. Call createInbox() first.');
+    try {
+        await axios_1.default.delete(`${constant_1.BASE_URL}/messages/${messageId}`, {
+            headers: {
+                accept: '*/*',
+                Authorization: `Bearer ${token}`,
+            },
+        });
+    }
+    catch (error) {
+        console.error(`Failed to delete message with ID ${messageId}: ${error}`);
+    }
+};
+exports.deleteMessage = deleteMessage;
+//# sourceMappingURL=messageService.js.map