metigan v1.0.0

Metigan - Email Sending Library

A simple and robust library for sending emails through the Metigan API with support for browser and Node.js environments.

Features

• 📧 Simple API for sending emails with HTML content
• 📎 File attachment support (up to 7MB per file)
• 🔄 Automatic retries with exponential backoff
• 📊 Built-in logging and monitoring
• 🌐 Works in both browser and Node.js environments
• ✅ Comprehensive email validation
• 👥 Support for CC, BCC, and Reply-To fields

Installation

npm install metigan
# or
yarn add metigan

Quick Start

import Metigan from 'metigan';

// Initialize with your API key
const metigan = new Metigan('your-api-key');

// Send a basic email
try {
  const response = await metigan.sendEmail({
    from: 'sender@example.com',
    recipients: ['recipient@example.com'],
    subject: 'Hello from Metigan',
    content: '<h1>Hello World!</h1><p>This is a test email from Metigan.</p>'
  });
  
  console.log('Email sent successfully!', response);
} catch (error) {
  console.error('Failed to send email:', error.message);
}

Advanced Usage

With Attachments (Browser)

// In a browser environment with file input
const fileInput = document.getElementById('fileInput');
const files = fileInput.files;

try {
  const response = await metigan.sendEmail({
    from: 'Your Name <sender@example.com>',
    recipients: ['recipient1@example.com', 'recipient2@example.com'],
    subject: 'Email with attachments',
    content: '<p>Please find the attached files.</p>',
    attachments: Array.from(files),
    cc: ['cc@example.com'],
    bcc: ['bcc@example.com'],
    replyTo: 'reply@example.com'
  });
  
  console.log('Email with attachments sent!', response);
} catch (error) {
  console.error('Error:', error.message);
}

With Attachments (Node.js)

import fs from 'fs';
import path from 'path';

// In Node.js environment
const filePath = path.resolve('./document.pdf');
const fileBuffer = fs.readFileSync(filePath);

try {
  const response = await metigan.sendEmail({
    from: 'sender@example.com',
    recipients: ['recipient@example.com'],
    subject: 'Document attached',
    content: '<p>Here is the document you requested.</p>',
    attachments: [{
      buffer: fileBuffer,
      originalname: 'document.pdf',
      mimetype: 'application/pdf'
    }]
  });
  
  console.log('Email with attachment sent!', response);
} catch (error) {
  console.error('Error:', error.message);
}

Custom Configuration

const metigan = new Metigan('your-api-key', {
  userId: 'user-123', // User ID for logging
  disableLogs: false, // Enable or disable logging
  retryCount: 5, // Number of retry attempts
  retryDelay: 1000, // Base delay between retries in milliseconds
  timeout: 60000 // Request timeout in milliseconds
});

API Reference

new Metigan(apiKey, options)

Creates a new Metigan client instance.

sendEmail(options)

Sends an email with the provided options.

enableLogging() and disableLogging()

Enable or disable logging during runtime.

Attachment Types

The library supports different attachment formats depending on the environment:

Browser

In the browser, use the native File object:

attachments: [
  fileInput.files[0],
  // ... more File objects
]

Node.js

In Node.js, use the NodeAttachment format:

attachments: [{
  buffer: Buffer.from('...'),
  originalname: 'filename.ext',
  mimetype: 'application/octet-stream'
}]

Custom Format

Or use the custom format that works in any environment:

attachments: [{
  content: Buffer.from('...') || arrayBuffer || 'base64string',
  filename: 'filename.ext',
  contentType: 'application/octet-stream'
}]

Error Handling

The library uses a custom MetiganError class that can be imported:

import { Metigan, MetiganError } from 'metigan';

try {
  await metigan.sendEmail(options);
} catch (error) {
  if (error instanceof MetiganError) {
    // Handle Metigan-specific errors
    console.error('Metigan error:', error.message);
  } else {
    // Handle other errors
    console.error('Unexpected error:', error);
  }
}

Response Format

A successful response will have this structure:

{
  success: true,
  message: "Emails sent successfully",
  successfulEmails: [
    {
      success: true,
      recipient: "recipient@example.com",
      messageId: "message-id-123"
    }
  ],
  failedEmails: [], // Any failed recipients
  recipientCount: 1,
  hasAttachments: false,
  attachmentsCount: 0
}

Limitations

• Maximum attachment size: 7MB per file
• HTML content is supported

Support

For issues, feature requests, or questions, please open an issue on our GitHub repository or contact support@savanapoint.com.

License

MIT