Send transactional emails through Mailgun's powerful API with an elegant, type-safe interface. This package seamlessly integrates with the @push.rocks/smartmail ecosystem and provides automatic SMTP fallback for edge cases.

Why @apiclient.xyz/mailgun? 💡

🎯 TypeScript Native - Full type safety with excellent IntelliSense support
🔄 Smart Fallback - Automatically falls back to SMTP when API limitations are hit
📎 Attachment Support - Hassle-free file attachments with built-in handling
🌍 Multi-Region - Support for both EU and US Mailgun regions
📬 Message Retrieval - Fetch stored messages from Mailgun's API
🔗 Webhook Integration - Easy integration with Mailgun webhooks
⚡ Modern API - Clean, fluent interface powered by smartrequest v4

Installation

npm install @apiclient.xyz/mailgun
# or
pnpm install @apiclient.xyz/mailgun
# or
yarn add @apiclient.xyz/mailgun

Quick Start 🚀

import { MailgunAccount } from '@apiclient.xyz/mailgun';
import { Smartmail } from '@push.rocks/smartmail';

// Initialize your Mailgun account
const mailgun = new MailgunAccount({
  apiToken: 'your-mailgun-api-token',
  region: 'eu' // or 'us'
});

// Create and send an email
const email = new Smartmail({
  from: 'Your App <noreply@yourdomain.com>',
  subject: 'Welcome to Our Service! 🎉',
  body: '<h1>Hello!</h1><p>Thanks for signing up.</p>'
});

await mailgun.sendSmartMail(email, 'user@example.com');

Core Features

📧 Sending Emails

The primary way to send emails is through the sendSmartMail() method, which accepts a Smartmail object:

import { MailgunAccount } from '@apiclient.xyz/mailgun';
import { Smartmail } from '@push.rocks/smartmail';

const mailgun = new MailgunAccount({
  apiToken: process.env.MAILGUN_API_TOKEN,
  region: 'eu'
});

// Create a rich HTML email
const email = new Smartmail({
  from: 'Team <hello@yourdomain.com>',
  subject: 'Monthly Newsletter',
  body: `
    <html>
      <body>
        <h1>What's New This Month</h1>
        <p>Check out our latest updates...</p>
      </body>
    </html>
  `
});

// Send to a recipient
await mailgun.sendSmartMail(email, 'subscriber@example.com');

📎 Email Attachments

Add attachments seamlessly using the smartmail interface:

import { SmartFile } from '@push.rocks/smartfile';

const email = new Smartmail({
  from: 'Sales <sales@yourdomain.com>',
  subject: 'Your Invoice',
  body: '<p>Please find your invoice attached.</p>'
});

// Add attachment from file
const pdfFile = await SmartFile.fromFilePath('./invoice.pdf');
email.addAttachment(pdfFile);

await mailgun.sendSmartMail(email, 'customer@example.com');

🔄 SMTP Fallback

For edge cases where the Mailgun API has limitations (like empty email bodies), the package automatically falls back to SMTP:

// Configure SMTP credentials for fallback
// Format: domain|username|password
await mailgun.addSmtpCredentials(
  'yourdomain.com|postmaster@yourdomain.com|your-smtp-password'
);

// This email with empty body will automatically use SMTP
const emptyBodyEmail = new Smartmail({
  from: 'System <system@yourdomain.com>',
  subject: 'System Notification',
  body: ''
});

await mailgun.sendSmartMail(emptyBodyEmail, 'admin@example.com');
// ✅ Automatically sent via SMTP instead of API

📬 Retrieving Messages

Fetch stored messages from Mailgun's API:

// Retrieve by message URL (from Mailgun storage)
const message = await mailgun.retrieveSmartMailFromMessageUrl(
  'https://sw.api.mailgun.net/v3/domains/yourdomain.com/messages/...'
);

if (message) {
  console.log('Subject:', message.options.subject);
  console.log('From:', message.options.from);
  console.log('Body:', message.options.body);

  // Attachments are automatically fetched
  console.log('Attachments:', message.attachments.length);
}

🔔 Webhook Integration

Process Mailgun webhook notifications:

// In your webhook handler
app.post('/webhooks/mailgun', async (req, res) => {
  const payload = req.body;

  // Retrieve the full message from the webhook payload
  const message = await mailgun.retrieveSmartMailFromNotifyPayload(payload);

  if (message) {
    // Process the received email
    console.log('Received email:', message.options.subject);
  }

  res.status(200).send('OK');
});

API Reference

MailgunAccount

Constructor

new MailgunAccount(options: {
  apiToken: string;  // Your Mailgun API token
  region: 'eu' | 'us';  // Mailgun region
})

Methods

`sendSmartMail(smartmail, recipient, data?)`

Send an email through Mailgun.

await mailgun.sendSmartMail(
  smartmailInstance,
  'recipient@example.com',
  { customData: 'optional' }  // Optional template data
);

`addSmtpCredentials(credentials)`

Configure SMTP fallback credentials.

await mailgun.addSmtpCredentials('domain|username|password');

`retrieveSmartMailFromMessageUrl(url)`

Retrieve a stored message by its Mailgun URL.

const message = await mailgun.retrieveSmartMailFromMessageUrl(messageUrl);

`retrieveSmartMailFromNotifyPayload(payload)`

Extract and retrieve a message from a Mailgun webhook payload.

const message = await mailgun.retrieveSmartMailFromNotifyPayload(webhookPayload);

Region Support 🌍

Mailgun operates in multiple regions. Choose the appropriate one for your needs:

eu - European region (GDPR compliant, data stored in EU)
us - US region (data stored in US)

// EU region
const mailgunEU = new MailgunAccount({
  apiToken: 'your-token',
  region: 'eu'
});

// US region
const mailgunUS = new MailgunAccount({
  apiToken: 'your-token',
  region: 'us'
});

Advanced Usage

Template Variables with Smartmail

Use template variables in your emails:

import { Smartmail } from '@push.rocks/smartmail';

const welcomeEmail = new Smartmail({
  from: 'Welcome Team <welcome@yourdomain.com>',
  subject: 'Welcome {{userName}}!',
  body: '<h1>Hi {{userName}}</h1><p>Your account is ready!</p>'
});

// Pass template data
await mailgun.sendSmartMail(
  welcomeEmail,
  'newuser@example.com',
  { userName: 'John Doe' }
);

Error Handling

try {
  await mailgun.sendSmartMail(email, 'user@example.com');
  console.log('✅ Email sent successfully');
} catch (error) {
  console.error('❌ Failed to send email:', error.message);
}

Batch Sending

Send multiple emails efficiently:

const recipients = [
  'user1@example.com',
  'user2@example.com',
  'user3@example.com'
];

const email = new Smartmail({
  from: 'Newsletter <news@yourdomain.com>',
  subject: 'Weekly Update',
  body: '<p>Here is your weekly update...</p>'
});

// Send to all recipients
await Promise.all(
  recipients.map(recipient =>
    mailgun.sendSmartMail(email, recipient)
  )
);

TypeScript Support 📘

This package is written in TypeScript and provides full type definitions out of the box:

import {
  MailgunAccount,
  IMailgunAccountContructorOptions,
  IMailgunMessage
} from '@apiclient.xyz/mailgun';

// Full IntelliSense support
const options: IMailgunAccountContructorOptions = {
  apiToken: 'token',
  region: 'eu'
};

const mailgun = new MailgunAccount(options);

Dependencies

This package leverages the powerful @push.rocks ecosystem:

@push.rocks/smartrequest - Modern HTTP client
@push.rocks/smartmail - Email composition
@push.rocks/smartsmtp - SMTP fallback
@push.rocks/smartfile - File handling
@push.rocks/smartstring - String utilities

Links & Resources

📦 NPM Package
💻 GitLab Repository
🪞 GitHub Mirror
📚 TypeDoc Documentation
🌐 Mailgun API Docs

License and Legal Information

This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the license file within this repository.

Please note: The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.

Trademarks

This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.

readme.md

@apiclient.xyz/mailgun