relaymail 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 RelayMail
+
+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,223 @@
+# RelayMail
+
+A simple and reliable Node.js client for sending emails through the RelayMail API.
+
+## Installation
+
+```bash
+npm install relaymail
+```
+
+## Quick Start
+
+```javascript
+const { RelayMail } = require('relaymail');
+
+// Initialize the client
+const relaymail = new RelayMail({
+  apiKey: 'your-api-key-here'
+});
+
+// Send an email
+async function sendEmail() {
+  try {
+    const result = await relaymail.send({
+      to: 'recipient@example.com',
+      subject: 'Hello from RelayMail!',
+      body: 'This is a test email sent using the RelayMail npm package.'
+    });
+    
+    console.log('Email sent successfully!', result);
+  } catch (error) {
+    console.error('Failed to send email:', error.message);
+  }
+}
+
+sendEmail();
+```
+
+## TypeScript Support
+
+This package is written in TypeScript and includes full type definitions.
+
+```typescript
+import { RelayMail, EmailOptions } from 'relaymail';
+
+const relaymail = new RelayMail({
+  apiKey: process.env.RELAYMAIL_API_KEY!
+});
+
+const emailOptions: EmailOptions = {
+  to: 'recipient@example.com',
+  subject: 'TypeScript Email',
+  html: '<h1>Hello from TypeScript!</h1>'
+};
+
+await relaymail.send(emailOptions);
+```
+
+## API Reference
+
+### Constructor
+
+```typescript
+new RelayMail(config: RelayMailConfig)
+```
+
+**Parameters:**
+- `config.apiKey` (string, required): Your RelayMail API key
+
+### Methods
+
+#### `send(options: EmailOptions): Promise<EmailResponse>`
+
+Send an email with custom options.
+
+**Parameters:**
+- `options.to` (string, required): Recipient email address
+- `options.subject` (string, required): Email subject line
+- `options.body` (string, optional): Plain text email body
+- `options.html` (string, optional): HTML email body
+
+**Note:** You must provide at least one of `body` or `html`. You can provide both for a multipart email.
+
+**Returns:** Promise resolving to an object with:
+- `id` (number): Email log ID
+- `message` (string): Success message
+
+**Example:**
+```javascript
+const result = await relaymail.send({
+  to: 'user@example.com',
+  subject: 'Welcome!',
+  body: 'Plain text content',
+  html: '<h1>HTML content</h1>'
+});
+```
+
+#### `sendText(to: string, subject: string, body: string): Promise<EmailResponse>`
+
+Convenience method for sending plain text emails.
+
+**Example:**
+```javascript
+await relaymail.sendText(
+  'user@example.com',
+  'Hello',
+  'This is a plain text email'
+);
+```
+
+#### `sendHtml(to: string, subject: string, html: string): Promise<EmailResponse>`
+
+Convenience method for sending HTML emails.
+
+**Example:**
+```javascript
+await relaymail.sendHtml(
+  'user@example.com',
+  'Newsletter',
+  '<h1>Welcome to our newsletter!</h1><p>Content here...</p>'
+);
+```
+
+## Usage Examples
+
+### Sending a Plain Text Email
+
+```javascript
+const { RelayMail } = require('relaymail');
+
+const client = new RelayMail({ apiKey: 'your-api-key' });
+
+await client.sendText(
+  'recipient@example.com',
+  'Simple Email',
+  'This is a simple plain text email.'
+);
+```
+
+### Sending an HTML Email
+
+```javascript
+await client.sendHtml(
+  'recipient@example.com',
+  'HTML Newsletter',
+  `
+    <html>
+      <body>
+        <h1>Welcome!</h1>
+        <p>This is a beautiful HTML email.</p>
+      </body>
+    </html>
+  `
+);
+```
+
+### Sending Both Plain Text and HTML
+
+```javascript
+await client.send({
+  to: 'recipient@example.com',
+  subject: 'Multipart Email',
+  body: 'This is the plain text version.',
+  html: '<h1>This is the HTML version</h1>'
+});
+```
+
+### Error Handling
+
+```javascript
+try {
+  await client.send({
+    to: 'invalid-email',
+    subject: 'Test',
+    body: 'Content'
+  });
+} catch (error) {
+  if (error.message.includes('RelayMail Error')) {
+    console.error('API Error:', error.message);
+  } else if (error.message.includes('Network Error')) {
+    console.error('Network issue:', error.message);
+  } else {
+    console.error('Unexpected error:', error.message);
+  }
+}
+```
+
+### Using Environment Variables
+
+```javascript
+require('dotenv').config();
+
+const relaymail = new RelayMail({
+  apiKey: process.env.RELAYMAIL_API_KEY
+});
+```
+
+## Getting Your API Key
+
+1. Sign up or log in to your RelayMail dashboard
+2. Navigate to the API Keys section
+3. Create a new API key
+4. Copy the key and use it in your application
+
+**Important:** Keep your API key secret and never commit it to version control.
+
+## Requirements
+
+- Node.js >= 14.0.0
+
+## License
+
+MIT
+
+## Support
+
+For issues and questions:
+- GitHub Issues: [Report a bug](https://github.com/AkiTheMemeGod/RelayMail/issues)
+- Email: relaymailingservices@gmail.com
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.

package/dist/index.d.ts

@@ -0,0 +1,67 @@
+import { EmailOptions, RelayMailConfig, EmailResponse } from './types';
+/**
+ * RelayMail Client - Send emails through the RelayMail API
+ */
+export declare class RelayMail {
+    private apiKey;
+    private client;
+    /**
+     * Create a new RelayMail client
+     * @param config - Configuration object with API key
+     * @example
+     * ```typescript
+     * const relaymail = new RelayMail({
+     *   apiKey: 'your-api-key-here'
+     * });
+     * ```
+     */
+    constructor(config: RelayMailConfig);
+    /**
+     * Send an email
+     * @param options - Email options including recipient, subject, and body/html
+     * @returns Promise resolving to email response with ID and message
+     * @throws Error if the email fails to send
+     * @example
+     * ```typescript
+     * // Send plain text email
+     * await relaymail.send({
+     *   to: 'recipient@example.com',
+     *   subject: 'Hello World',
+     *   body: 'This is a plain text email'
+     * });
+     *
+     * // Send HTML email
+     * await relaymail.send({
+     *   to: 'recipient@example.com',
+     *   subject: 'Hello World',
+     *   html: '<h1>This is an HTML email</h1>'
+     * });
+     *
+     * // Send email with both plain text and HTML
+     * await relaymail.send({
+     *   to: 'recipient@example.com',
+     *   subject: 'Hello World',
+     *   body: 'Plain text version',
+     *   html: '<h1>HTML version</h1>'
+     * });
+     * ```
+     */
+    send(options: EmailOptions): Promise<EmailResponse>;
+    /**
+     * Send a plain text email (convenience method)
+     * @param to - Recipient email address
+     * @param subject - Email subject
+     * @param body - Plain text email body
+     * @returns Promise resolving to email response
+     */
+    sendText(to: string, subject: string, body: string): Promise<EmailResponse>;
+    /**
+     * Send an HTML email (convenience method)
+     * @param to - Recipient email address
+     * @param subject - Email subject
+     * @param html - HTML email body
+     * @returns Promise resolving to email response
+     */
+    sendHtml(to: string, subject: string, html: string): Promise<EmailResponse>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,aAAa,EAAiB,MAAM,SAAS,CAAC;AAEtF;;GAEG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,MAAM,CAAgB;IAE9B;;;;;;;;;OASG;gBACS,MAAM,EAAE,eAAe;IAkBnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,IAAI,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,aAAa,CAAC;IAmCzD;;;;;;OAMG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAIjF;;;;;;OAMG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;CAGlF"}

package/dist/index.js

@@ -0,0 +1,120 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RelayMail = void 0;
+const axios_1 = __importDefault(require("axios"));
+/**
+ * RelayMail Client - Send emails through the RelayMail API
+ */
+class RelayMail {
+    /**
+     * Create a new RelayMail client
+     * @param config - Configuration object with API key
+     * @example
+     * ```typescript
+     * const relaymail = new RelayMail({
+     *   apiKey: 'your-api-key-here'
+     * });
+     * ```
+     */
+    constructor(config) {
+        if (!config.apiKey) {
+            throw new Error('API key is required');
+        }
+        this.apiKey = config.apiKey;
+        const baseUrl = 'https://relaymail.pythonanywhere.com';
+        this.client = axios_1.default.create({
+            baseURL: baseUrl,
+            headers: {
+                'Content-Type': 'application/json',
+                'Authorization': `Bearer ${this.apiKey}`
+            },
+            timeout: 30000 // 30 seconds timeout
+        });
+    }
+    /**
+     * Send an email
+     * @param options - Email options including recipient, subject, and body/html
+     * @returns Promise resolving to email response with ID and message
+     * @throws Error if the email fails to send
+     * @example
+     * ```typescript
+     * // Send plain text email
+     * await relaymail.send({
+     *   to: 'recipient@example.com',
+     *   subject: 'Hello World',
+     *   body: 'This is a plain text email'
+     * });
+     *
+     * // Send HTML email
+     * await relaymail.send({
+     *   to: 'recipient@example.com',
+     *   subject: 'Hello World',
+     *   html: '<h1>This is an HTML email</h1>'
+     * });
+     *
+     * // Send email with both plain text and HTML
+     * await relaymail.send({
+     *   to: 'recipient@example.com',
+     *   subject: 'Hello World',
+     *   body: 'Plain text version',
+     *   html: '<h1>HTML version</h1>'
+     * });
+     * ```
+     */
+    async send(options) {
+        // Validation
+        if (!options.to) {
+            throw new Error('Recipient email address (to) is required');
+        }
+        if (!options.subject) {
+            throw new Error('Email subject is required');
+        }
+        if (!options.body && !options.html) {
+            throw new Error('Email content is required. Provide either "body" (text) or "html"');
+        }
+        try {
+            const response = await this.client.post('/api/v1/send', {
+                to: options.to,
+                subject: options.subject,
+                body: options.body,
+                html: options.html
+            });
+            return response.data;
+        }
+        catch (error) {
+            if (axios_1.default.isAxiosError(error)) {
+                const axiosError = error;
+                if (axiosError.response?.data?.error) {
+                    throw new Error(`RelayMail Error: ${axiosError.response.data.error}`);
+                }
+                throw new Error(`Network Error: ${axiosError.message}`);
+            }
+            throw error;
+        }
+    }
+    /**
+     * Send a plain text email (convenience method)
+     * @param to - Recipient email address
+     * @param subject - Email subject
+     * @param body - Plain text email body
+     * @returns Promise resolving to email response
+     */
+    async sendText(to, subject, body) {
+        return this.send({ to, subject, body });
+    }
+    /**
+     * Send an HTML email (convenience method)
+     * @param to - Recipient email address
+     * @param subject - Email subject
+     * @param html - HTML email body
+     * @returns Promise resolving to email response
+     */
+    async sendHtml(to, subject, html) {
+        return this.send({ to, subject, html });
+    }
+}
+exports.RelayMail = RelayMail;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAyD;AAGzD;;GAEG;AACH,MAAa,SAAS;IAIpB;;;;;;;;;OASG;IACH,YAAY,MAAuB;QACjC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,MAAM,OAAO,GAAG,sCAAsC,CAAC;QAEvD,IAAI,CAAC,MAAM,GAAG,eAAK,CAAC,MAAM,CAAC;YACzB,OAAO,EAAE,OAAO;YAChB,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,eAAe,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE;aACzC;YACD,OAAO,EAAE,KAAK,CAAC,qBAAqB;SACrC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,KAAK,CAAC,IAAI,CAAC,OAAqB;QAC9B,aAAa;QACb,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAC9D,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC/C,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;QACvF,CAAC;QAED,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAgB,cAAc,EAAE;gBACrE,EAAE,EAAE,OAAO,CAAC,EAAE;gBACd,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,IAAI,EAAE,OAAO,CAAC,IAAI;aACnB,CAAC,CAAC;YAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,eAAK,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC9B,MAAM,UAAU,GAAG,KAAkC,CAAC;gBACtD,IAAI,UAAU,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;oBACrC,MAAM,IAAI,KAAK,CAAC,oBAAoB,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;gBACxE,CAAC;gBACD,MAAM,IAAI,KAAK,CAAC,kBAAkB,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;YAC1D,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,OAAe,EAAE,IAAY;QACtD,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,OAAe,EAAE,IAAY;QACtD,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1C,CAAC;CACF;AAtHD,8BAsHC"}

package/dist/types.d.ts

@@ -0,0 +1,37 @@
+/**
+ * RelayMail Email Sending Options
+ */
+export interface EmailOptions {
+    /** Recipient email address */
+    to: string;
+    /** Email subject line */
+    subject: string;
+    /** Plain text email body (optional if html is provided) */
+    body?: string;
+    /** HTML email body (optional if body is provided) */
+    html?: string;
+}
+/**
+ * RelayMail Client Configuration
+ */
+export interface RelayMailConfig {
+    /** Your RelayMail API key */
+    apiKey: string;
+}
+/**
+ * Email sending response
+ */
+export interface EmailResponse {
+    /** Email log ID */
+    id: number;
+    /** Success message */
+    message: string;
+}
+/**
+ * Error response from the API
+ */
+export interface ErrorResponse {
+    /** Error message */
+    error: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,8BAA8B;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,yBAAyB;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,2DAA2D;IAC3D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qDAAqD;IACrD,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,6BAA6B;IAC7B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,mBAAmB;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,sBAAsB;IACtB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;CACf"}

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "relaymail",
+  "version": "1.0.0",
+  "description": "A simple and reliable email sending client for RelayMail API",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "email",
+    "smtp",
+    "mail",
+    "relaymail",
+    "send-email",
+    "email-api"
+  ],
+  "author": "AkiTheMemeGod",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^20.10.0",
+    "typescript": "^5.3.0"
+  },
+  "dependencies": {
+    "axios": "^1.6.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/yourusername/relaymail"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=14.0.0"
+  }
+}