Skip to content

Latest commit

 

History

History
106 lines (80 loc) · 4.25 KB

mailgun.md

File metadata and controls

106 lines (80 loc) · 4.25 KB

Mailgun

Mailgun is an email service provider that offers a RESTful API for sending emails from your Node.js application. Their official npm module, mailgun.js, makes it easy to integrate Mailgun into your Node.js app and send emails using API requests.

Values to Update in Database

When using Mailgun to send emails via their API, you need to provide certain variables that hold the Mailgun configuration details. Here are the values you need to update in the table notify_providers:

Create a new entry in the table notify_providers and set the fields - name, application_id, user_id.

  • Set field channel_type = 2 (for Mailgun)
  • Set field is_enabled = 1 (to enable the newly created provider)

Then set the following configurations in the configuration field:

Key Description
MAILGUN_API_KEY Your Mailgun API key
MAILGUN_HOST Mailgun host; api.mailgun.net for US, api.eu.mailgun.net for EU
MAILGUN_DOMAIN Your Mailgun domain name 
// Sample JSON to set in the configuration field
{
  "MAILGUN_API_KEY": "your-api-key",
  "MAILGUN_HOST": "api.mailgun.net",
  "MAILGUN_DOMAIN": "your.mailgun.domain"
}

Make sure to replace your-api-key, api.mailgun.net, and your.mailgun.domain with the appropriate values as per your Mailgun account setup.

Sample Request Body

Here's a sample request body:

{
  // Set your respective providerId. ChannelType associated with providerId should be 2 (Mailgun)
  "providerId": 2,
  "data": {
    "from": "[email protected]",                   // Sender's email address
    "to": "[email protected]",                  // Recipient's email address
    "cc": "[email protected]",                         // CC email address (optional)
    "bcc": "[email protected]",                       // BCC email address (optional)
    "subject": "Test subject",                      // Email subject
    "text": "This is a test notification",          // Plain text version of the email
    "html": "<b>This is a test notification</b>",   // HTML version of the email
    "attachments": [                                 // Attachments (optional)
      {
        "filename": "names.txt",
        "content": "John Doe\nJane Doe",
      },
    ],
  }
}

In addition to the provided fields, there are several other options you can include when calling the messages.create method:

  • to: An array or comma-separated string of email addresses to send mail.
  • cc: An array or comma-separated string of CC email addresses.
  • bcc: An array or comma-separated string of BCC email addresses.
  • attachments: An array of attachment objects, each containing filename and content. Now we support multiple MIME types with Buffer from base64.

To create a base64 string from a file, you can use the following Node.js code:

const fs = require('fs');

const filePath = 'path/to/your/file.pdf';
const fileData = fs.readFileSync(filePath);
const base64String = fileData.toString('base64');

console.log(base64String);  // This is your base64 string

To create a base64 string from a file in .NET, you can use the following C# code:

using System;
using System.IO;

class Program
{
    static void Main()
    {
        string filePath = "path/to/your/file.pdf";
        byte[] fileBytes = File.ReadAllBytes(filePath);
        string base64String = Convert.ToBase64String(fileBytes);

        Console.WriteLine(base64String);  // This is your base64 string
    }
}

These options allow you to customize the email message according to your needs. Remember to adjust the options based on your specific use case and requirements.

Dependencies

Package Name Version Description
mailgun.js ^10.2.3 A Mailgun client for JavaScript
form-data ^4.0.0 Used by mailgun.js to handle form data for HTTP requests

Reference: Mailgun API Documentation