dx-mail 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,273 @@
+# 📬 DX Mail
+
+![npm](https://img.shields.io/npm/v/dx-mail)
+![downloads](https://img.shields.io/npm/dm/dx-mail)
+![license](https://img.shields.io/npm/l/dx-mail)
+
+Fast temporary email client with realtime inbox updates powered by WebSocket.
+
+Create temporary emails, receive messages instantly, and integrate easily with Telegram bots, WhatsApp bots, web dashboards, or Node.js applications.
+
+✨ Features
+
+- 🚀 Create random or custom temporary email addresses
+- ⚡ Realtime inbox updates using WebSocket
+- 📥 Fetch message history
+- 🤖 Perfect for Telegram and WhatsApp bots
+- 🌐 Works for web inbox applications
+- 🔑 API Key authentication
+- 📦 Lightweight and easy to use
+
+---
+
+Installation
+
+npm install dx-mail
+
+---
+
+Quick Start
+
+const dxMail = require("dx-mail");
+
+const app = dxMail({
+  baseUrl: "https://your-server.com",
+  token: "dxm_your_api_key"
+});
+
+async function main() {
+  const res = await app.createMail();
+
+  console.log("Email:");
+  console.log(res.inbox.address);
+}
+
+main();
+
+---
+
+Authentication
+
+Option 1
+
+const app = dxMail({
+  baseUrl: "https://your-server.com",
+  token: "dxm_your_api_key"
+});
+
+Option 2
+
+const app = dxMail();
+
+app.setBaseUrl("https://your-server.com");
+app.auth("dxm_your_api_key");
+
+---
+
+API
+
+createMail()
+
+Create a random email address.
+
+const res = await app.createMail();
+
+console.log(res.inbox.address);
+
+Example:
+
+m7fa8d3c21a@danxy.web.id
+
+---
+
+createMail(name)
+
+Create a custom email address.
+
+const res = await app.createMail("test");
+
+console.log(res.inbox.address);
+
+Output:
+
+test@danxy.web.id
+
+---
+
+createMail(callback)
+
+Callback style.
+
+app.createMail((res) => {
+  console.log(res.inbox.address);
+});
+
+---
+
+createMail(name, callback)
+
+app.createMail("test", (res) => {
+  console.log(res.inbox.address);
+});
+
+---
+
+listMail()
+
+Get all inboxes owned by your API key.
+
+const res = await app.listMail();
+
+console.log(res.inboxes);
+
+Example:
+
+[
+  {
+    id: "...",
+    name: "test",
+    address: "test@danxy.web.id"
+  }
+]
+
+---
+
+getMail(name)
+
+Get message history.
+
+const res = await app.getMail("test");
+
+console.log(res.messages);
+
+---
+
+watchMail(name)
+
+Receive emails instantly.
+
+app.watchMail("test", (event) => {
+  console.log(event.message.subject);
+  console.log(event.message.text);
+});
+
+Example:
+
+📩 New Email
+Subject: Hello
+Text: Welcome to DX Mail
+
+---
+
+HTML Emails
+
+DX Mail supports HTML emails.
+
+app.watchMail("test", (event) => {
+  console.log(event.message.html);
+});
+
+Useful for:
+
+- OpenAI verification emails
+- GitHub notifications
+- Discord verification emails
+- Banking emails
+- Newsletter emails
+- OTP services
+
+---
+
+waitMail(name)
+
+Wait until a new email arrives.
+
+const event = await app.waitMail("test");
+
+console.log(event.message.subject);
+
+With timeout:
+
+const event = await app.waitMail("test", {
+  timeoutMs: 30000
+});
+
+---
+
+watchAll()
+
+Watch all inboxes owned by the API key.
+
+app.watchAll((event) => {
+  console.log(event.inbox.address);
+  console.log(event.message.subject);
+});
+
+---
+
+close()
+
+Close WebSocket connection.
+
+app.close();
+
+---
+
+Message Object
+
+{
+  id: "...",
+  to: "test@danxy.web.id",
+  from: "noreply@example.com",
+  subject: "Hello",
+  text: "Welcome!",
+  html: "<h1>Welcome!</h1>",
+  attachments: [],
+  receivedAt: "2026-06-27T14:00:00.000Z"
+}
+
+---
+
+Telegram Example
+
+const dxMail = require("dx-mail");
+
+const app = dxMail({
+  baseUrl: "https://your-server.com",
+  token: "dxm_your_api_key"
+});
+
+const inbox = await app.createMail();
+
+app.watchMail(inbox.inbox.name, (event) => {
+  bot.telegram.sendMessage(
+    chatId,
+    `📩 ${event.message.subject}\n\n${event.message.text}`
+  );
+});
+
+---
+
+Web Dashboard Example
+
+app.watchMail("test", (event) => {
+  renderMessage(event.message);
+});
+
+---
+
+Requirements
+
+- Node.js 18+
+- DX Mail Server
+- Valid API Key
+
+---
+
+License
+
+MIT
+
+---
+
+Made with ❤️ for developers who need fast temporary emails and realtime inbox updates.

package/a.js

@@ -1,7 +1,7 @@
 const mail = require("./index.js");
 const app = mail();
 
-app.setBaseUrl("https://mailsrv-1a31daad9cb8.herokuapp.com");
+//app.setBaseUrl("https://mailsrv-1a31daad9cb8.herokuapp.com");
 app.auth("dxm_46a9ac05fd8230b856f6d4fb1e1f4c5af63f6b045cda4a48");
 
 app.createMail("anj", (res) => {

package/index.js

@@ -2,7 +2,7 @@ const { io } = require("socket.io-client");
 const EventEmitter = require("events");
 
 function cleanBaseUrl(url) {
-  return String(url || "http://localhost:3000").replace(/\/+$/, "");
+  return String(url || "https://mailsrv-1a31daad9cb8.herokuapp.com/").replace(/\/+$/, "");
 }
 
 function cleanLocalPart(value) {
@@ -43,7 +43,7 @@ class DxMailClient extends EventEmitter {
     this.baseUrl = cleanBaseUrl(
       options.baseUrl ||
       process.env.DX_MAIL_BASE_URL ||
-      "http://localhost:3000"
+      "https://mailsrv-1a31daad9cb8.herokuapp.com"
     );
 
     this.token = options.token || process.env.DX_MAIL_TOKEN || null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dx-mail",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "DX Mail client for temp mail API and realtime inbox watcher",
   "main": "index.js",
   "keywords": [