Skip to content

Latest commit

 

History

History
2438 lines (1993 loc) · 71.9 KB

README.md

File metadata and controls

2438 lines (1993 loc) · 71.9 KB
Raw

mailgun.js / Exports

Mailgun.js

A javascript sdk for Mailgun built with webpack, babel & es6. This can be used in node or in the browser*.

NOTE: If used in the browser, a proxy is required to communicate with the Mailgun api due to cors limitations. Also, do not publish your private api key in frontend code.

Table of Contents

Documentation

Mailgun API Documentation:

Install

  • Requires node.js >= 18.x

Install mailgun.js with:

npm install mailgun.js

Setup Client

Next, require the module and instantiate a mailgun client by calling new Mailgun(formData) and then using mailgun.client setup the client with basic auth credentials (username: 'api', key: 'key-yourkeyhere').

NOTE: starting from version 3.0 you need to pass FormData (we need this to keep library universal). For node.js you can use form-data library.

IMPORTANT: if you are using EU infrastructure, you need to also pass url: 'https://api.eu.mailgun.net' together with auth credentials as stated in Mailgun docs

Imports

Once the package is installed, you can import the library using import or require approach:

  const formData = require('form-data');
  const Mailgun = require('mailgun.js');
  const mailgun = new Mailgun(formData);
  const mg = mailgun.client({username: 'api', key: process.env.MAILGUN_API_KEY || 'key-yourkeyhere'});
  import FormData from 'form-data';
  import Mailgun from 'mailgun.js';
  const mailgun = new Mailgun(FormData);
  const mg = mailgun.client({username: 'api', key: process.env.MAILGUN_API_KEY || 'key-yourkeyhere'});

Using Subaccounts

Primary accounts can make API calls on behalf of their subaccounts. API documentation

  import FormData from 'form-data';
  import Mailgun from 'mailgun.js';
  const mailgun = new Mailgun(FormData);
  const mg = mailgun.client({username: 'api', key: process.env.MAILGUN_API_KEY || 'key-yourkeyhere'});
  mg.setSubaccount('subaccount-id');
  // then, if you need to reset it back to the primary account:
  mg.resetSubaccount();

Proxy configuration

By leveraging client configuration options, users can effortlessly establish proxy connections that align with their network requirements. Ex:

  import FormData from 'form-data';
  import Mailgun from 'mailgun.js';
  const mailgun = new Mailgun(FormData);

  const mg = mailgun.client({
    username: 'api',
    key: process.env.MAILGUN_API_KEY || 'key-yourkeyhere',
    proxy: {
      protocol: 'https' // 'http' ,
      host: '127.0.0.1', // use your proxy host here
      port: 9000, // use your proxy port here
      auth: { // may be omitted if proxy doesn't require authentication
        username: 'user_name', // provide username
        password: 'user_password' // provide password
      }
    },
  });

Types imports

Starting from version 9.0.0. Types can be includes as named import:

 import Mailgun, { MailgunClientOptions, MessagesSendResult } from 'mailgun.js';

Interfaces and Enums imports

Starting from version 9.0.0. Interfaces and Enums can be imported in the next way:

  import Mailgun, { Interfaces, Enums } from 'mailgun.js';
  ...
  const mailgunClient: Interfaces.IMailgunClient = mailgun.client(clientOptions);
  const yes = Enums.YesNo.YES;
  ...

Generated docs

The list of all available Types, Interfaces and Enums is auto-generated and located in the docs folder.

Methods

The following service methods are available to instantiated clients. The examples assume you have already created a mailgun client as mg with valid credentials.

Method naming conventions:

  • get or get{{Item}} - expected response for client is a single object
  • list or list{{Items}} - expected response for client is a list of objects
  • create or create{{Item}} - expected response for client is a single object
  • update or update{{Item}} - expected response is an object with a status message
  • destroy or destroy{{Item}} - expected response is an object with a status message

Messages

  • create

    mg.messages.create(domain, data) - api docs

    Options:

    Parameter Description
    to Email address of the recipient(s). Example: "Bob [email protected]". You can use commas to separate multiple recipients (e.g.: "[email protected],[email protected]" or ["[email protected]", "[email protected]"]).
    cc Same as To but for carbon copy
    bcc Same as To but for blind carbon copy
    subject Subject of the message.
    html HTML version of the message.
    text Text version of the message.
    message MIME string of the message. Make sure to use multipart/form-data to send this as a file upload.
    attachment File attachment. You can post multiple attachment values. Important: You must use multipart/form-data encoding when sending attachments. Also you can use {data: file, filename: filename} to define custom filename.
    o:tag Tag string. See Tagging for more information.
    o:campaign Id of the campaign the message belongs to. See um-campaign-analytics for details.
    o:deliverytime Desired time of delivery. See Date Format. Note: Messages can be scheduled for a maximum of 3 days in the future.
    o:dkim Enables/disabled DKIM signatures on per-message basis. Pass yes or no
    o:testmode Enables sending in test mode. Pass yes if needed. See Sending in Test Mode
    o:tracking Toggles tracking on a per-message basis, see Tracking Messages for details. Pass yes or no.
    o:tracking-clicks Toggles clicks tracking on a per-message basis. Has higher priority than domain-level setting. Pass yes, no or htmlonly.
    o:tracking-opens Toggles opens tracking on a per-message basis. Has higher priority than domain-level setting. Pass yes or no.
    h:X-My-Header h: prefix followed by an arbitrary value allows to append a custom MIME header to the message (X-My-Header in this case). For example, h:Reply-To to specify Reply-To address.
    v:my-var v: prefix followed by an arbitrary name allows to attach a custom JSON data to the message. See Attaching Data to Messages for more information.

    • HTML/TEXT Example:

      mg.messages.create('sandbox-123.mailgun.org', {
    from: "Excited User <[email protected]>",
    to: ["[email protected]"],
    subject: "Hello",
    text: "Testing some Mailgun awesomness!",
    html: "<h1>Testing some Mailgun awesomness!</h1>"
  })
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

    • MIME Example:

      mg.messages.create('sandbox-123.mailgun.org', {
    from: "Excited User <[email protected]>",
    to: ["[email protected]"],
    subject: "Hello",
    message: "<mime encoded string here>"
  })
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

    • Messages with attachments:

      • Node.js example of send file as an attachment

          const fsPromises = require('fs').promises;
  const path = require('path');
  const filepath = path.resolve(__dirname, '../test.pdf');
  let messageParams = {
      from: "Excited User <[email protected]>",
      to: ["[email protected]"],
      subject: "Test subject",
      text: "Hello here is a file in the attachment"
  }

  fsPromises.readFile(filepath)
  .then(data => {
    const file = {
        filename: 'test-rename.pdf',
        data
    }
    messageParams.attachment = file;
    return mg.messages.create('sandbox-123.mailgun.org', messageParams);
  })
  .then(response => {
      console.log(response);
  })

      • Node.js example of send multiple files as an attachment

        const fsPromises = require('fs').promises;
const path = require('path');
const filepath = path.resolve(__dirname, '../test.pdf');
const filepath1 = path.resolve(__dirname, '../test.jpg');

let messageParams = {
    from: "Excited User <[email protected]>",
    to: ["[email protected]"],
    subject: "Test subject",
    text: "Test message"
}

(async () =>{
    try {
        const firstFile = {
            filename: 'test.pdf',
            data: await fsPromises.readFile(filepath)
        }

        const secondFile = {
            filename: 'test.jpg',
            data: await fsPromises.readFile(filepath1)
        }

        messageParams.attachment = [firstFile, secondFile];
        const result =  await mg.messages.create('sandbox-123.mailgun.org', messageParams);
        console.log(result);
        } catch (error) {
            console.error(error);
        }
})()

      • Node.js example of send file as inline image

          const fsPromises = require('fs').promises;
  const path = require('path');
  const filepath = path.resolve(__dirname, '../test.jpg');
  let messageParams = {
      from: "Excited User <[email protected]>",
      to: ["[email protected]"],
      subject: "Test subject",
      html: '<div><img alt="image" id="1" src="cid:test.jpg"/></div> Some extra text'
  }

  fsPromises.readFile(filepath)
  .then(data => {
    const file = {
        filename: 'test.jpg',
        data
    }

    messageParams.inline = file;
    return mg.messages.create('sandbox-123.mailgun.org', messageParams);
  })
  .then(response => console.log(response))

      • Browser example of send file

        Before sending the file you need to somehow get the Blob of the file. Usually can get it from the onChange event of input tag with type file.

        const handleFileSelected = async (event) => {
  const files = Array.from(event.target.files)
  const fileBuffer = await files[0];
}
<input type="file" onChange={handleFileSelected} name="file-uploader"/>

        Then you can use the same approach as shown above for node.js apps.

          const file = {
    filename: 'test.pdf',
    data: fileBuffer
  };

  let messageParams = {
    from: "Excited User <[email protected]>",
    to: ["[email protected]"],
    subject: "Test subject",
    text: "Hello here is a file in the attachment",
    attachment: file
  };

  const res = await mg.messages.create(DOMAIN, messageParams);

    Promise returns:

    {
  id: '<[email protected]>',
  message: 'Queued. Thank you.'
}

Templates

Mailgun’s templates uses a fork of the very popular template engine handlebars.

To provide values for a substitution you need to use 'h:X-Mailgun-Variables' property in the message description.

Make sure that this property is a JSON string like:

JSON.stringify({
  "title": "A title",
  "body": "The body"
})

You can find few examples of how to use templates below.

  • Providing values for title and slug variables to render in template

      ...
  const {
    title,
    slug,
  } = someDataSource;

  const mailgunData = {
    from: '[email protected]>',
    to: '[email protected]',
    subject: `Email ${title}`,
    template: 'name-of-the-template-you-made-in-mailgun-web-portal',
    'h:X-Mailgun-Variables': JSON.stringify({ // be sure to stringify your payload
      title,
      slug,
    }),
    'h:Reply-To': '[email protected]',
  };

  try {
    const response = await mailgun.messages.create(DOMAIN_NAME, mailgunData);
  ...

  • Providing an array of objects to render them in the template

      ...
  const mailgunData = {
    from: '[email protected]>',
    to: '[email protected]',
    subject: `Email ${title}`,
    template: 'name-of-the-another-template-you-made-in-mailgun-web-portal',
    'h:X-Mailgun-Variables': JSON.stringify({
    "arrayItems": [
        {
            "question": "test_question",
            "answer": "test_answer"
        },
        {
            "question": "test_question",
            "answer": "test_answer"
        }
    ]})
  };
  try {
    const response = await mailgun.messages.create(DOMAIN_NAME, mailgunData);
  ...

Recipient Variables

Docs

Recipient Variables are custom variables that you define, which you can then reference in the message body. They give you the ability to send a custom message to each recipient while still using a single API Call.

...
const mailgunData = {
    from: 'Example.com Mailer <[email protected]>',
    to: ['[email protected]', '[email protected]'],
    subject: 'Recipient - %recipient.title%',
    html: 'Here\'s %recipient.title% and <a href="%recipient.link%">link</a>',
    'recipient-variables': JSON.stringify({
      '[email protected]': {
        title: 'Me',
        link: 'href-var',
      },
      '[email protected]': {
        title: 'You',
        link: 'slug-recipient-var-c',
      },
    }),
  };

  try {
    const response = await mailgun.messages.create(DOMAIN_NAME, mailgunData);
...

Domains

  • list

    mg.domains.list(query) - api docs

    Example:

    mg.domains.list()
  .then(domains => console.log(domains)) // logs array of domains
  .catch(err => console.error(err)); // logs any error

    Promise returns: array of Domain instances

    [{
  created_at: 'Sun, 19 Oct 2014 18:49:36 GMT',
  name: 'testing.example.com',
  receiving_dns_records: null,
  require_tls: true,
  sending_dns_records: null,
  skip_verification: true,
  smtp_login: '[email protected]',
  smtp_password: 'password',
  spam_action: 'disabled',
  state: 'unverified',
  type: 'custom',
  wildcard: true
}]

    Query data may have next properties:

    Property Description
    limit Maximum number of records to return. (100 by default)
    skip Number of records to skip. (0 by default)

  • get

    mg.domains.get(domain)

    Example:

    mg.domains.get('testing.example.com')
  .then(domains => console.log(domains)) // logs domain object
  .catch(err => console.error(err)); // logs any error

    Promise returns: Domain instance

    {
  created_at: 'Sun, 19 Oct 2014 18:49:36 GMT',
  name: 'testing.example.com',
  receiving_dns_records: [{
      "name": "testing.example.com",
      "record_type": "TXT",
      "valid": "unknown",
      "value": "v=spf1 include:mailgun.org ~all"
    },
    {
      "name": "k1._domainkey.testing.example.com",
      "record_type": "TXT",
      "valid": "unknown",
      "value": "k=rsa; 123456"
    },
    {
      "name": "email.testing.example.com",
      "record_type": "CNAME",
      "valid": "unknown",
      "value": "mailgun.org"
    }],
  require_tls: true,
  sending_dns_records: [{
      "priority": "10",
      "record_type": "MX",
      "valid": "unknown",
      "value": "mxa.mailgun.org"
    },
    {
      "priority": "10",
      "record_type": "MX",
      "valid": "unknown",
      "value": "mxb.mailgun.org"
    }],
  skip_verification: true,
  smtp_login: '[email protected]',
  smtp_password: 'password',
  spam_action: 'disabled',
  state: 'unverified',
  type: 'custom',
  wildcard: true,
  id: '64a4291ebbe4ec7e1d78bc80',
  is_disabled: false,
  web_prefix: 'email',
  web_scheme: 'http'
}

  • create

    mg.domains.create(data)

    Example:

    mg.domains.create({name: 'foobar.example.com'})
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

    Create method accepts data object with next properties:

    Parameter Description
    name Name of the domain (ex. domain.com)
    smtp_password Password for SMTP authentication
    spam_action disabled, block, or tag
    If disabled, no spam filtering will occur for inbound messages.
    If block, inbound spam messages will not be delivered.
    If tag, inbound messages will be tagged with a spam header. Spam Filter
    The default is disabled.
    wildcard Can be string 'true' or 'false' or boolean
    Determines whether the domain will accept email for sub-domains when sending messages.
    The default is false.
    force_dkim_authority Can be string 'true' or 'false' or boolean
    If set to true, the domain will be the DKIM authority for itself even if the root domain is registered on the same mailgun account
    If set to false, the domain will have the same DKIM authority as the root domain registered on the same mailgun account
    The default is false.
    dkim_key_size 1024 or 2048
    Set the length of your domain’s generated DKIM key
    The default is 1024
    ips An optional, comma-separated list of IP addresses to be assigned to this domain. If not specified, all dedicated IP addresses on the account will be assigned. If the request cannot be fulfilled (e.g. a requested IP is not assigned to the account, etc), a 400 will be returned.
    pool_id The id of the IP Pool that you wish to assign to the domain. The pool must contain at least 1 IP. (Note: IP Pools are only available on certain plans; see http://mailgun.com/pricing)
    web_scheme String with http or https
    Set your open, click and unsubscribe URLs to use http or https
    The default is http

    Promise returns:

    name: 'foobar.example.com',
require_tls: false,
skip_verification: false,
state: 'unverified',
wildcard: false,
spam_action: 'disabled',
created_at: 'Tue, 04 Jul 2023 14:09:18 GMT',
smtp_password: undefined,
smtp_login: '[email protected]',
type: 'custom',
receiving_dns_records: [{
    "name": "foobar.example.com",
    "record_type": "TXT",
    "valid": "unknown",
    "value": "v=spf1 include:mailgun.org ~all"
  },
  {
    "name": "k1._domainkey.foobar.example.com",
    "record_type": "TXT",
    "valid": "unknown",
    "value": "k=rsa; 123456"
  },
  {
    "name": "email.foobar.example.com",
    "record_type": "CNAME",
    "valid": "unknown",
    "value": "mailgun.org"
  }
],
sending_dns_records: [{
    "priority": "10",
    "record_type": "MX",
    "valid": "unknown",
    "value": "mxa.mailgun.org"
  },
  {
    "priority": "10",
    "record_type": "MX",
    "valid": "unknown",
    "value": "mxb.mailgun.org"
}],
id: '64a4291ebbe4ec7e1d78bc80',
is_disabled: false,
web_prefix: 'email',
web_scheme: 'http'

  • update

    mg.domains.update(domain, options)

    Example:

    mg.domains.update('foobar.example.com',{
    wildcard: 'true',
    web_scheme: 'http',
    spam_action: 'disabled',
  })
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

    Update method accepts data object with next properties:

    Property Description
    spam_action Can be string with value disabled, block, or tag. If disabled, no spam filtering will occur for inbound messages. If block, inbound spam messages will not be delivered. If tag, inbound messages will be tagged with a spam header. See Spam Filter.
    web_scheme Can be string with value http or https. Set your open, click and unsubscribe URLs to use http or https. The default is http
    wildcard Can be string 'true' or 'false' or boolean. Determines whether the domain will accept email for sub-domains. The default is false.

    Promise returns:

    {
  name: 'foobar.example.com',
  require_tls: false,
  skip_verification: false,
  state: 'unverified',
  wildcard: true,
  spam_action: 'disabled',
  created_at: 'Tue, 04 Jul 2023 14:09:18 GMT',
  smtp_password: undefined,
  smtp_login: '[email protected]',
  type: 'custom',
  receiving_dns_records: [
    {
      is_active: true,
      cached: [],
      priority: '10',
      record_type: 'MX',
      valid: 'unknown',
      value: 'mxa.mailgun.org'
    },
    {
      is_active: true,
      cached: [],
      priority: '10',
      record_type: 'MX',
      valid: 'unknown',
      value: 'mxb.mailgun.org'
    }
  ],
  sending_dns_records: [
    {
      is_active: true,
      cached: [],
      name: 'foobar.example.com',
      record_type: 'TXT',
      valid: 'unknown',
      value: 'v=spf1 include:mailgun.org ~all'
    },
    {
      is_active: true,
      cached: [],
      name: 'email.foobar.example.com',
      record_type: 'CNAME',
      valid: 'unknown',
      value: 'mailgun.org'
    }
  ],
  id: '64a5880eere4eg7e1d85bc69',
  is_disabled: false,
  web_prefix: 'email',
  web_scheme: 'http'
}

  • destroy

    mg.domains.destroy(domainAddress)

    Example:

    mg.domains.destroy('foobar.example.com')
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

    Promise returns:

    {
  message: "Domain has been deleted"
}

  • getTracking

    mg.domains.getTracking(domainAddress)

    Example:

    mg.domains.getTracking('foobar.example.com')
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

    Promise returns:

    {
  "click": {
    "active": false
  },
  "open": {
    "active": false
  },
  "unsubscribe": {
    "active": false,
    "html_footer": "\n<br>\n<p><a href=\"%unsubscribe_url%\">unsubscribe</a></p>\n",
    "text_footer": "\n\nTo unsubscribe click: <%unsubscribe_url%>\n\n"
  }
}

  • updateTracking

    mg.domains.updateTracking(domain, trackingType, data)

    • Open Tracking Example:

      mg.domains.updateTracking('foobar.example.com', 'open', {active: true})
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

      Open tracking data object properties:

      Property Description
      active Boolean, enables or disables open tracking

      Promise returns:

      {
  message: 'Tracking settings have been updated',
  open: {
    active: true
  }
}

    • Click Tracking Example:

      mg.domains.updateTracking('foobar.example.com', 'click', {active: true})
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

      Click tracking data object properties:

      Property Description
      active Boolean, enables or disables click tracking

      Promise returns:

      {
  message: 'Tracking settings have been updated',
  click: {
    active: true
  }
}

    • Unsubscribe Tracking Example:

      mg.domains.updateTracking('foobar.example.com', 'unsubscribe', {
    active: true,
    html_footer: "\n<br>\n<p><a href=\"%unsubscribe_url%\">unsubscribe</a></p>\n",
    text_footer: "\n\nTo unsubscribe click: <%unsubscribe_url%>\n\n"
  })
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

      Unsubscribe Tracking data object properties:

      Property Description
      active Boolean, enables or disables unsubscribe tracking
      html_footer string appended to html emails for managing unsubscribe links
      text_footer string appended to html emails for managing unsubscribe links

      Promise returns:

      {
  message: 'Tracking settings have been updated',
  "unsubscribe": {
    "active": true,
    "html_footer": "\n<br>\n<p><a href=\"%unsubscribe_url%\">unsubscribe</a></p>\n",
    "text_footer": "\n\nTo unsubscribe click: <%unsubscribe_url%>\n\n"
  }
}

  • getIps

    mg.domains.getIps(domain)

    Example:

    mg.domains.getIps('foobar.example.com')
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

    Promise returns:

    ["192.168.0.1", "192.168.0.2"]

  • assignIp

    mg.domains.assignIp(domain, ip)

    Example:

    mg.domains.assignIp('foobar.example.com', "192.168.0.3")
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error
    {
  message: 'success',
  status: 200,
}

  • deleteIp

    mg.domains.deleteIp(domain, ip)

    Example:

    mg.domains.deleteIp('foobar.example.com', "192.168.0.3")
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error
    {
  message: 'success'
}

Events

  • get

    mg.events.get(domain, data)

    Example:

    mg.events.get('foobar.example.com', {
    page: 'mypageid',
    event: 'opened'
}).then(data => console.log(data.items)) // logs array of event objects
  .catch(err => console.error(err)); // logs any error

    Options:

    Parameter Description
    page Fetches the specified page of log records, assuming that the URL was returned by the previous request
    begin The beginning of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds. Refer to Time Range for details.
    end The end of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds. Refer to Time Range for details.
    ascending Defines the direction of the search time range if the range end time is not specified. Can be either yes or no. Refer to Time Range for details.
    limit Number of entries to return. (300 max)
    field field is the name of the Filter Field. The value of the parameter should be a valid Filter Expression. Several field filters can be specified in one request. If the same field is mentioned, more then once, then all its filter expressions are combined with AND operator.

    • Example with Date and Filter field

        const date = new Date(2023, 7, 2, 0, 0, 0, 0); // Wed Aug 02 2023 00:00:00 GMT+0300
    const events = await mg.events.get('foobar.example.com', {
      begin: date.toUTCString(), // 'Tue, 01 Aug 2023 21:00:00 GMT'
      ascending: 'yes',
      limit: 5,
      event: 'delivered'
    });

    Promise returns: items (array of event objects), pages (paging keys grouped by id)

    {
items: [{
    type: 'accepted',
    summary: 'got it',
    content: { more: 'data' },
    timestamp: Wed Nov 19 2014 10:32:57 GMT-0800 (PST) },
  }],
  pages: {
    first: { id: 'first', number: 'W3siYSI6IGZhbHNlLC', url: 'apiurl' },
    last: { id: 'last', number: 'W3siYSI6IGZhbHNlLC', url: 'apiurl' },
    next: { id: 'next', number: W3siYSI6IGZhbHNlLC'', url: 'apiurl' },
    previous: { id: 'previous', number: 'W3siYSI6IGZhbHNlLC', url: 'apiurl' }
  }
}

Stats

  • Stats Options

    Parameter Description
    event The type of the event. For a complete list of all events written to the log see the Event Types table below. (Required)
    start The starting time. Should be in :rfc:2822#page-14 or unix epoch format. Default: 7 days from the current time.
    end The ending date. Should be in :rfc:2822#page-14 or unix epoch format. Default: current time.
    resolution Can be either hour, day or month. Default: day
    duration Period of time with resolution encoded. If provided, overwrites the start date. See list below.

    Duration is a string that represents a period of time with some resolution. It has a format [0-9]+[m,d,h] where

    • h - an hour
    • d - a day
    • m - a month

    Examples:

    • 24h - a period of 24 hours (a day) with hourly resolution
    • 1d - a period of 1 day with daily resolution
    • 2m - a period of 2 months with monthly resolution

    Event Types

    Event Type Description
    accepted Mailgun accepted the request to send/forward the email and the message has been placed in queue.
    delivered Mailgun sent the email and it was accepted by the recipient email server.
    failed Mailgun could not deliver the email to the recipient email server.
    opened The email recipient opened the email and enabled image viewing. Open tracking must be enabled in the Mailgun control panel, and the CNAME record must be pointing to mailgun.org.
    clicked The email recipient clicked on a link in the email. Click tracking must be enabled in the Mailgun control panel, and the CNAME record must be pointing to mailgun.org.
    unsubscribed The email recipient clicked on the unsubscribe link. Unsubscribe tracking must be enabled in the Mailgun control panel.
    complained The email recipient clicked on the spam complaint button within their email client. Feedback loops enable the notification to be received by Mailgun.
    stored Mailgun has stored an incoming message

  • getDomain

    mg.stats.getDomain(domain, query)

    Example:

    mg.stats.getDomain('foobar.example.com', {event: ['delivered', 'accepted', 'failed', 'complained']})
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

    Promise returns:

    {
  start: Sun Mar 15 2015 17:00:00 GMT-0700 (PDT),
  end: Sun Mar 22 2015 17:00:00 GMT-0700 (PDT),
  resolution: 'day',
  stats: [{
    time: Sun Mar 15 2015 17:00:00 GMT-0700 (PDT),
    delivered: { smtp: 2, http: 1, total: 3 }
  }]
}

  • getAccount

    mg.stats.getDomain(domain, query)

    Example:

    mg.stats.getDomain('foobar.example.com', {event: ['delivered', 'accepted', 'failed', 'complained']})
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

    Promise returns:

    {
  start: Sun Mar 15 2015 17:00:00 GMT-0700 (PDT),
  end: Sun Mar 22 2015 17:00:00 GMT-0700 (PDT),
  resolution: 'day',
  stats: [{
    time: Sun Mar 15 2015 17:00:00 GMT-0700 (PDT),
    delivered: { smtp: 2, http: 1, total: 3 }
  }]
}

Suppressions

  • list

    mg.suppressions.list(domain, suppressionType, query?)

    • Bounces Example:

      mg.suppressions.list('foobar.example.com', 'bounces')
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

    • Unsubscribes Example:

      mg.suppressions.list('foobar.example.com', 'unsubscribes')
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

    • Complaints Example:

      mg.suppressions.list('foobar.example.com', 'complaints')
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

      Promise returns:

      {
items: [
  {
    type: "bounces",
    address: "[email protected]",
    code: 550,
    error: "No such mailbox",
    created_at: Fri Oct 21 2011 04:02:55 GMT-0700 (PDT)
  }],
pages: {
  first: { id: "first", page: "", address: "", url: "apiurl" },
  last: { id: "last", page: "", address: "", url: "apiurl" },
  next: { id: "next", page: "", address: "", url: "apiurl" },
  previous: { id: "prev", page: "", address: "", url: "apiurl" }
}
}

  • get

    mg.suppressions.get(domain, suppressionType, address)

    • Bounces Example:

      mg.suppressions.get('foobar.example.com', 'bounces', '[email protected]')
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

    • Unsubscribes Example:

      mg.suppressions.get('foobar.example.com', 'unsubscribes', '[email protected]')
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

    • Complaints Example:

      mg.suppressions.get('foobar.example.com', 'complaints', '[email protected]')
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

    Response example:

    {
  type: "bounces",
  address: "[email protected]",
  tags: [ "*" ],
  created_at: Fri Oct 21 2011 05:02:55 GMT-0700 (PDT)
}

  • create

    mg.suppressions.create(domain, suppressionType, data || data[])

    • Bounces Example:

      mg.suppressions.create('foobar.example.com', 'bounces', [{address: '[email protected]'}])
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

      Bounces Options: Contains an array with the following object properties

      Parameter Description
      address Valid email address
      code Error code (optional, default: 550)
      error Error description (optional, default: empty string)
      created_at Timestamp of a bounce event in RFC2822 format (optional, default: current time)

      Promise returns:

      {
  message: "1 address has been added to the bounces table"
}

    • Unsubscribes Example:

      mg.suppressions.create('foobar.example.com', 'unsubscribes', {address: '[email protected]'})
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

      Unsubscribes Options: Contains an array with the following object properties

      Parameter Description
      address Valid email address
      tag Tag to unsubscribe from, use * to unsubscribe an address from all domain’s correspondence (optional, default: *)
      tags Array with tags to unsubscribe from
      created_at Timestamp of a bounce event in RFC2822 format (optional, default: current time)

      Promise returns:

      {
  message: "1 address has been added to the unsubscribes table"
}

      • Unsubscribe from one tag

        mg.suppressions.create('foobar.example.com', 'unsubscribes', {address: '[email protected]', tag: 'your_tag_to_unsubscribe']})
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

        Promise returns:

        {
  message: "1 address has been added to the unsubscribes table"
}

      • Unsubscribe from particular tags

        mg.suppressions.create('foobar.example.com', 'unsubscribes', [{address: '[email protected]', tags: ['your_tag_to_unsubscribe', 'another_tag_to_unsubscribe']}])
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

        Promise returns:

        {
  message: "1 address has been added to the unsubscribes table"
}

    • Complaints Example:

      mg.suppressions.create('foobar.example.com', 'complaints', [{address: '[email protected]'}])
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

      Complaints Options: Contains an array with the following object properties

      Parameter Description
      address Valid email address
      created_at Timestamp of a bounce event in RFC2822 format (optional, default: current time)

      Promise returns:

      {
  message: "1 address has been added to the complaints table"
}

  • destroy

    mg.suppressions.destroy(domain, suppressionType, address)

    • Bounces Example:

      mg.suppressions.destroy('foobar.example.com', 'bounces', '[email protected]')
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

      Promise returns:

      {
  message: "Bounced address has been removed",
  value: "",
  address: "[email protected]",
  status: 200
}

    • Unsubscribes Example:

      mg.suppressions.destroy('foobar.example.com', 'unsubscribes', '[email protected]')
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

      Promise returns:

      {
  message: 'Unsubscribe event has been removed',
  value: '',
  address: '[email protected]',
  status: 200
}

    • Complaints Example:

      mg.suppressions.destroy('foobar.example.com', 'complaints', '[email protected]')
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

      Promise returns:

        message: 'Spam complaint has been removed',
  value: '',
  address: '[email protected]',
  status: 200

Webhooks

  • list

    mg.webhooks.list(domain, query)

    Example:

    mg.webhooks.list('foobar.example.com')
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

    Promise returns:

    {
  open: { 'url': 'http://requestb.in' },
  click: { 'url': 'http://requestb.in' },
  bounce: { 'url': 'http://requestb.in' },
  deliver: { 'url': 'http://requestb.in' },
  drop: { 'url': 'http://requestb.in' },
  spam: { 'url': 'http://requestb.in' },
  unsubscribe: { 'url': 'http://requestb.in' },
  click: { 'url': 'http://requestb.in' },
  open: { 'url': 'http://requestb.in' },
}

  • get

    mg.webhooks.get(domain, id)

    Example:

    mg.webhooks.get('foobar.example.com', 'open') // bounce, deliver, drop, spam, unsubscribe, click, open
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

    Promise returns:

    {
  'open': { 'url': 'http://requestb.in', 'urls': ['trackclick.com'] }
}

  • create

    mg.webhooks.create(domain, id, data, test)

    Example:

    mg.webhooks.create('foobar.example.com', 'open', 'http://requestb.in') // bounce, deliver, drop, spam, unsubscribe, click, open
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

    Promise returns:

    {
  'open': { 'url': 'http://requestb.in', 'urls': ['http://requestb.in'] }
}

    Test Webhook Example:

    mg.webhooks.get('foobar.example.com', 'open', 'http://requestb.in', true) // bounce, deliver, drop, spam, unsubscribe, click, open
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

    Promise returns:

    {
  'code': '500',
  'message': 'Hi!'
}

  • update

    mg.webhooks.update(domain, id, url, test)

    Example:

    mg.webhooks.update('foobar.example.com', 'open', 'http://requestb.in') // bounce, deliver, drop, spam, unsubscribe, click, open
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

    Promise returns:

    {
  'open': { 'url': 'http://requestb.in', 'urls': ['http://requestb.in'] }
}
    mg.webhooks.update('foobar.example.com', 'open', ['http://requestb.in', 'http://requestb1.in' ]) // bounce, deliver, drop, spam, unsubscribe, click, open
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

    Promise returns:

    {
  'open': { 'url': 'http://requestb.in', 'urls': ['http://requestb.in', 'http://requestb1.in'] }
}

  • destroy

    mg.webhooks.destroy(domain, id)

    Example:

    mg.webhooks.update('foobar.example.com', 'open') // bounce, deliver, drop, spam, unsubscribe, click, open
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

    Promise returns:

    {
  'open': { 'url': 'http://requestb.in', 'urls': ['http://requestb.in']}
}

Routes

  • list

    mg.routes.list(query)

    Example:

    mg.routes.list()
  .then(data => console.log(data)) // logs response body
  .catch(err => console.error(err)); // logs any error

    Promise returns:

    [
  {
    actions: [ 'forward("http://myhost.com/messages/")', 'stop()' ],
    created_at: 'Mon, 26 Oct 2015 03:56:51 GMT',
    description: 'sample',
    expression: 'match_recipient(".*@example.com")',
    id: '562da483125730608a7d1719',
    priority: 0
  }
]

  • get

    mg.routes.get(id)

    Example:

    mg.routes.get('562da483125730608a7d1719')
  .then(data => console.log(data)) // logs response body
  .catch(err => console.error(err)); // logs any error

    Promise returns: response body

    {
  actions: [ 'forward("http://myhost.com/messages/")', 'stop()' ],
  created_at: 'Mon, 26 Oct 2015 03:56:51 GMT',
  description: 'sample',
  expression: 'match_recipient(".*@example.com")',
  id: '562da483125730608a7d1719',
  priority: 0
}

  • create

    mg.routes.create(options)

    Example:

    mg.routes.create({
    priority: 0,
    description: 'sample',
    expression: 'match_recipient(".*@example.org")',
    action: ['forward("http://myhost.com/messages/")', 'stop()']
  })
  .then(data => console.log(data)) // logs response body
  .catch(err => console.error(err)); // logs any error

    Promise returns: response body

    {
  actions: [ 'forward("http://myhost.com/messages/")', 'stop()' ],
  created_at: 'Mon, 26 Oct 2015 03:56:51 GMT',
  description: 'sample',
  expression: 'match_recipient(".*@example.com")',
  id: '562da483125730608a7d1719',
  priority: 0
}

  • update

    mg.routes.update(id, options)

    Example:

    mg.routes.update('562da483125730608a7d1719', {
    priority: 0,
    description: 'sample',
    expression: 'match_recipient(".*@example.org")',
    action: ['forward("http://myhost.com/messages/")', 'stop()']
  })
  .then(data => console.log(data)) // logs response body
  .catch(err => console.error(err)); // logs any error

    Promise returns: response body

    {
  actions: [ 'forward("http://myhost.com/messages/")', 'stop()' ],
  created_at: 'Mon, 26 Oct 2015 03:56:51 GMT',
  description: 'sample',
  expression: 'match_recipient(".*@example.com")',
  id: '562da483125730608a7d1719',
  message: 'Route has been updated',
  priority: 0
}

  • destroy

    mg.routes.destroy(id)

    Example:

    mg.routes.destroy('562da483125730608a7d1719')
  .then(data => console.log(data)) // logs response body
  .catch(err => console.error(err)); // logs any error

    Promise returns: response body

    {
  id: '562da483125730608a7d1719',
  message: 'Route has been deleted'
}

Validation

  • get

    mg.validate.get(address)

    Example:

    mg.validate.get('[email protected]')
  .then(data => console.log(data)) // logs response body
  .catch(err => console.error(err)); // logs any error

    Promise returns: response body

    {
  address: '[email protected]',
  did_you_mean: null,
  is_valid: false,
  parts: {
     display_name: null,
      domain: null,
      local_part: null
  }
}

Multiple validation

https://documentation.mailgun.com/en/latest/api-email-validation.html#email-validation

  • create

    mg.validate.multipleValidation.create('name_of_the_list', { file })

    const fsPromises = require('fs').promises;
const filepath = path.resolve(__dirname, '../path_to_your_file_with_emails_list.csv');

...

(async () => {
  try {
    const file = {
      filename: 'test.csv',
      data: await fsPromises.readFile(filepath)
    };

    const validateBulkResult = await mg.validate.multipleValidation.create('name_of_the_list', { file });
    console.log('validateBulkResult', validateBulkResult);
  } catch (error) {
    console.error(error);
  }
})();

    Response shape:

    {
  "id": "name_of_the_list",
  "message": "The validation job was submitted."
}

  • list

    mg.validate.multipleValidation.list()

    mg.validate.multipleValidation.list()
  .then(data => console.log(data)) // logs response body
  .catch(err => console.error(err)); // logs any error

    Response shape:

    {
  "jobs": [
    {
      "created_at": 1643965937,
      "download_url": {
        "csv": "csv-url",
        "json": "json-url"
      },
      "id": "name_of_the_list",
      "quantity": 40,
      "records_processed": 40,
      "status": "uploaded",
      "summary": {
        "result": {
          "catch_all": 0,
          "deliverable": 0,
          "do_not_send": 0,
          "undeliverable": 0,
          "unknown": 40
        },
        "risk": { "high": 0, "low": 0, "medium": 0, "unknown": 40 }
      }
    }
  ],
  "paging": {
    "first": "https://api.mailgun.net/v4/address/validate/bulk?limit=100&page=first&pivot=",
    "last": "https://api.mailgun.net/v4/address/validate/bulk?limit=100&page=last&pivot=",
    "next": "https://api.mailgun.net/v4/address/validate/bulk?limit=100&page=next&pivot=b4808b5b-1111-2222-3333-6cd0b63f41ea",
    "prev": "https://api.mailgun.net/v4/address/validate/bulk?limit=100&page=prev&pivot="
  },
  "total": 1
}

  • get

    mg.validate.multipleValidation.get('name_of_the_list')

    mg.validate.multipleValidation.get('name_of_the_list')
  .then(data => console.log(data)) // logs response body
  .catch(err => console.error(err)); // logs any error

    Response shape:

    {
  "created_at": 1643965937,
  "download_url": {
    "csv": "csv-url",
    "json": "json-url"
  },
  "id": "name_of_the_list",
  "quantity": 40,
  "records_processed": 40,
  "responseStatusCode": 200,
  "status": "uploaded",
  "summary": {
    "result": {
      "catch_all": 0,
      "deliverable": 0,
      "do_not_send": 0,
      "undeliverable": 0,
      "unknown": 40
    },
    "risk": { "high": 0, "low": 0, "medium": 0, "unknown": 40 }
  }
}

  • destroy

    mg.validate.multipleValidation.destroy('name_of_the_list');

    cancels bulk validation job

    mg.validate.multipleValidation.destroy('name_of_the_list');
  .then(data => console.log(data)) // logs response body
  .catch(err => console.error(err)); // logs any error

    Response shape:

    {
  body: "Validation job canceled.",
  status: 200
}

Mailing lists

A client to manage mailing lists.

  • list

    mg.lists.list()

    Example:

    mg.lists.list()
  .then(data => console.log(data)) // logs response body
  .catch(err => console.error(err)); // logs any error

    Promise returns: response body

    [
  {
    access_level: 'readonly',
    address: '[email protected]',
    created_at: 'Wed, 27 Oct 2021 21:59:21 -0000',
    description: '',
    members_count: 0,
    name: '',
    reply_preference: 'list'
  }
]

  • get

    mg.lists.get(mailListAddress)

    Example:

    mg.lists.get('[email protected]')
  .then(data => console.log(data)) // logs response body
  .catch(err => console.error(err)); // logs any error

    Promise returns:

    {
  access_level: 'readonly',
  address: '[email protected]',
  created_at: 'Thu, 28 Oct 2021 00:16:56 -0000',
  description: '',
  members_count: 0,
  name: '',
  reply_preference: 'list'
}

  • create

    mg.lists.create(data)

    Example:

    mg.lists.create({
    address: '[email protected]',
    name: 'Reply Address', // optional, modifiable on website
    description: 'Mailing lists for repliable address', // optional, modifiable on website
    access_level: 'readonly', // optional, modifiable on website
    reply_preference: 'list', // optional, modifiable on website
  })
  .then(data => console.log(data)) // logs response body
  .catch(err => console.error(err)); // logs any error

    Promise returns:

    {
  access_level: 'readonly',
  address: '[email protected]',
  created_at: 'Thu, 28 Oct 2021 03:12:17 -0000',
  description: 'Mailing lists for repliable address',
  members_count: 0,
  name: 'Reply Address',
  reply_preference: 'list'
}

  • update

    mg.lists.update(mailListAddress)

    Example:

    mg.lists.update('[email protected]', {
    address: '[email protected]',
    name: 'Foo', // optional, modifiable on website
    description: 'Foo bar bat', // optional, modifiable on website
    access_level: 'members', // optional, modifiable on website
    reply_preference: 'sender', // optional, modifiable on website
  })
  .then(data => console.log(data)) // logs response body
  .catch(err => console.error(err)); // logs any error

    Promise returns:

    {
  access_level: 'members',
  address: '[email protected]',
  created_at: 'Thu, 28 Oct 2021 03:21:15 -0000',
  description: 'Foo bar bat',
  members_count: 0,
  name: 'Foo',
  reply_preference: 'sender'
}

  • destroy

    mg.lists.destroy(mailListAddress)

    Example:

    mg.lists.destroy('[email protected]')
  .then(data => console.log(data)) // logs response body
  .catch(err => console.error(err)); // logs any error

    Promise returns: response body

    {
  address: '[email protected]',
  message: 'Mailing list has been removed'
}

Mailing list members

A client to manage members within a specific mailing list.

  • listMembers

    mg.lists.members.listMembers(mailListAddress)

    Example:

    mg.lists.members.listMembers('[email protected]')
  .then(data => console.log(data)) // logs response body
  .catch(err => console.error(err)); // logs any error

    Promise returns:

    [
  {
    address: '[email protected]',
    name: 'Jane Doe',
    subscribed: true,
    vars: { age: 50 }
  }
]

  • getMember

    mg.lists.members.getMember(mailListAddress, mailListMemberAddress)

    Example:

    mg.lists.members.getMember('[email protected]', '[email protected]')
  .then(data => console.log(data)) // logs response body
  .catch(err => console.error(err)); // logs any error

    Promise returns:

    {
  address: '[email protected]',
  name: 'Jane Doe',
  subscribed: true,
  vars: { age: 50 }
}

  • createMember

    mg.lists.members.createMember(mailListAddress, data)

    Example:

    mg.lists.members.createMember('[email protected]', {
    address: '[email protected]',
    name: 'John Smith', // optional, modifiable on website
    vars: {hobby: "chess"}, // optional, modifiable on website
    subscribed: 'no', // optional, modifiable on website
    upsert: 'yes', // optional, choose yes to insert if not exist, or update it exist
  })
  .then(data => console.log(data)) // logs response body
  .catch(err => console.error(err)); // logs any error

    Promise returns: response body

    {
  address: '[email protected]',
  name: 'John Smith',
  subscribed: false,
  vars: { hobby: 'chess' }
}

  • createMembers

    mg.lists.members.createMembers(mailListAddress, data)

    Example:

    mg.lists.members.createMembers('[email protected]', {
    members: [
      {
        address: "[email protected]",
        name: "Bot1 Superbot",
        vars: {location: "loc1"},
        subscribed: true,
      },
      {
        address: "[email protected]",
        name: "Bot2 Superbot",
        vars: {location: "loc2"},
        subscribed: false,
      },
    ],
    upsert: "yes",
  })
  .then(data => console.log(data)) // logs response body
  .catch(err => console.error(err)); // logs any error

    Promise returns:

    {
  list: {
    access_level: 'readonly',
    address: '[email protected]',
    created_at: 'Thu, 28 Oct 2021 03:21:15 -0000',
    description: 'For reply purpose',
    members_count: 2,
    name: 'Reply',
    reply_preference: 'list'
  },
  message: 'Mailing list has been updated',
  'task-id': '575b943c37a211ec8a520242ac11000a'
}

  • updateMember

    mg.lists.members.updateMember(mailListAddress, mailListMemberAddress, data)

    Example:

    mg.lists.members.updateMember('[email protected]', '[email protected]', {
    address: '[email protected]',
    name: 'Bot0 Normalbot', // optional, modifiable on website
    vars: {location: "space"},
    subscribed: false,
  })
  .then(data => console.log(data)) // logs response body
  .catch(err => console.error(err)); // logs any error

    Promise returns: response body

    {
  address: '[email protected]',
  name: 'Bot0 Normalbot',
  subscribed: false,
  vars: { location: 'space' }
}

  • destroyMember

    mg.lists.members.destroyMember(mailListAddress, mailListMemberAddress)

    Example:

    mg.lists.members.destroyMember('[email protected]', '[email protected]')
  .then(data => console.log(data)) // logs response body
  .catch(err => console.error(err)); // logs any error

    Promise returns: response body

    {
  member: { address: '[email protected]' },
  message: 'Mailing list member has been deleted'
}

Subaccounts

A client to manage subaccounts.

  • list

    mg.subaccounts.list(query) - api docs

    Example:

    mg.subaccounts.list()
  .then(subaccounts => console.log(subaccounts)) // logs array of subaccounts
  .catch(err => console.error(err)); // logs any error

    Promise returns: array of Subaccounts instances

    [
  { id: "XYZ", name: "test.subaccount1", status: "open" },
  { id: "YYY", name: "test.subaccount2", status: "open" }
]

    Query data may have next properties:

    Property Description
    limit Maximum number of records to return. (10 by default)
    skip Number of records to skip. (0 by default)
    sort "asc" or "desc".
    enabled Returns all enabled/disabled subaccounts. (Defaults to all if omitted)

  • get

    mg.subaccounts.get(subaccount_id)

    Example:

    mg.subaccounts.get('123')
  .then(subaccount => console.log(subaccount)) // logs subaccount object
  .catch(err => console.error(err)); // logs any error

    Promise returns: Subaccount instance

    { id: "123", name: "test.subaccount1", status: "open" }

  • create

    mg.subaccounts.create(name)

    Example:

    mg.subaccounts.create('foobar')
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

    Promise returns: Subaccount instance

    { id: "123", name: "foobar", status: "open" }

    Create method accepts data object with next properties:

    Parameter Description
    name Name of the subaccount being created (ex. 'mysubaccount')

  • enable

    mg.subaccounts.enable(subaccount_id)

    Example:

    mg.subaccounts.enable('123')
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

    Promise returns: Subaccount instance

    { id: "123", name: "foobar", status: "open" }

  • disable

    mg.subaccounts.disable(subaccount_id)

    Example:

    mg.subaccounts.disable('123')
  .then(msg => console.log(msg)) // logs response data
  .catch(err => console.error(err)); // logs any error

    Promise returns: Subaccount instance

    { id: "123", name: "foobar", status: "disabled" }

Navigation thru lists

Most of the methods that return items in a list support pagination. There are two ways to receive part of the list:

  1. Provide properties 'limit' and 'page' in the query. This way uses more frequently in the SDK and works for the next methods:

  • mg.domains.domainTags.list()

  • mg.domains.domainTemplates.list()

  • mg.domains.domainTemplates.listVersions()

  • mg.events.get()

  • mg.lists.list()

  • mg.lists.members.listMembers()

  • mg.validate.list()

  • mg.suppressions.list()

    The general idea is that after you made the first call with a limit property in the query you will receive a response with a property called pages in it. This property implements the next interface:

    {
    previous: {
        id: string;
        page: string;
        iteratorPosition: string | undefined;
        url: string
    };
    first: {
        id: string;
        page: string;
        iteratorPosition: string | undefined;
        url: string
    };
    last: {
        id: string;
        page: string;
        iteratorPosition: string | undefined;
        url: string
    };
    next: {
        id: string;
        page: string;
        iteratorPosition: string | undefined;
        url: string
    };
}

    To receive the next page you need to add the page property to the query argument. This property should contain a string value from 'page' property in response.pages.(previous/first/last/next).

    Example:

    // first call
const listMembers = await mg.lists.members.listMembers('your_mailing_list', { limit: 2 });

/* response
{
  items: [
    {
      address: '[email protected]',
      name: 'test name 0',
      subscribed: true,
      vars: [Object]
    },
    {
      address: '[email protected]',
      name: 'test name 1',
      subscribed: true,
      vars: [Object]
    }
  ],
  pages: {
    first: {
      id: 'first',
      page: '?page=first&limit=2',
      iteratorPosition: undefined,
      url: 'https://your_domain/v3/lists/your_mailing_list/members/pages?page=first&limit=2'
    },
    last: {
      id: 'last',
      page: '?page=last&limit=2',
      iteratorPosition: undefined,
      url: 'https://your_domain/v3/lists/your_mailing_list/members/pages?page=last&limit=2'
    },
    next: {
      id: 'next',
      page: '?page=next&address=test-1%40example.com&limit=2',
      iteratorPosition: '[email protected]',
      url: 'https://your_domain/v3/lists/your_mailing_list/members/pages?page=next&address=test-1%40example.com&limit=2'
    },
    previous: {
      id: 'previous',
      page: '?page=prev&address=test-0%40example.com&limit=2',
      iteratorPosition: '[email protected]',
      url: 'https://your_domain/v3/lists/your_mailing_list/members/pages?page=prev&address=test-0%40example.com&limit=2'
    }
  }
}
*/
// second call
const listMembers = await mg.lists.members.listMembers(
    'your_mailing_list',
    {
      limit: 2,
      page: '?page=next&address=test-1%40example.com&limit=2'
    }
  );

/* response
{
  items: [
    {
      address: '[email protected]',
      name: 'test name 2',
      subscribed: true,
      vars: [Object]
    },
    {
      address: '[email protected]',
      name: 'test name 3',
      subscribed: true,
      vars: [Object]
    }
  ],
  pages: {
    first: {
      id: 'first',
      page: '?page=first&limit=2',
      iteratorPosition: undefined,
      url: 'https://your_domain/v3/lists/your_mailing_list/members/pages?page=first&limit=2'
    },
    last: {
      id: 'last',
      page: '?page=last&limit=2',
      iteratorPosition: undefined,
      url: 'https://your_domain/v3/lists/your_mailing_list/members/pages?page=last&limit=2'
    },
    next: {
      id: 'next',
      page: '?page=next&address=test-3%40example.com&limit=2',
      iteratorPosition: '[email protected]',
      url: 'https://your_domain/v3/lists/your_mailing_list/members/pages?page=next&address=test-3%40example.com&limit=2'
    },
    previous: {
      id: 'previous',
      page: '?page=prev&address=test-2%40example.com&limit=2',
      iteratorPosition: '[email protected]',
      url: 'https://your_domain/v3/lists/your_mailing_list/members/pages?page=prev&address=test-2%40example.com&limit=2'
    }
  }
}
*/
    1. The second option of navigation is to provide properties 'limit' and 'skip' in the query. This way uses only in a few places for now:
    • mg.domains.list()
    • mg.domains.domainCredentials.list()
    • mg.routes.list()
    • mg.webhooks.list() The main idea here is quite simple you just need to provide how many records from the start of a list you want to skip and how many to receive. You can do it using the query parameter in each method. Example:
    const listDomainCredentials = await client.domains.domainCredentials.list(
'your_domain_name',
{
  skip: 10,
  limit: 1
}
);

Browser Demo

image

For this demo to work, you'll need to install and run http-proxy locally. Install it with:

npm install -g http-proxy

Then run the following command from the mailgun-js directory:

http-server -p 4001 --proxy="https://api.mailgun.net"

Demo should be up and running at http://0.0.0.0:4001/examples/

Development

Requirements

  • Requires node.js >= 4.x

Install node dependencies with:

npm install

Build

Build for dev purposes(without minimizing)

npm run build

Build for release purposes(include minimizing)

npm run build:release

Merging changes

Before PR merge check that commits info will be correctly added to the CHANGELOG.md file: 'npm run release -- --dry-run'

CI process isn't working currently, so please manually run npm run test

Tests

npm run tests

Watch tests with

npm run watch-tests

To test new functionality locally using npm link please use npm script npm run link. This is needed for correct exporting d.ts files.

Release Process

Releases occur after feature branches have been tested and merged into master.

First, checkout master and pull the latest commits.

git checkout master
git pull

Next, run npm run release.

After that, cd ./dist and then run npm login and npm publish to publish changes on npm.