Library Reference

The Mailosaur Node.js library lets you integrate email and SMS testing into your continuous integration process.

This guide provides details on all the methods available within the library.

To check out some common use cases, take a look at getting started with Node.js.

Getting started

Install the Mailosaur Node library

Install the package via npm:

npm install mailosaur --save-dev

‘Hello world’

To use the library, simply add it as a dependency and create a client instance using your API key. You can then use any of the methods described in this document.

To try this out, create a single file called hello.js with the following code inside it:

const MailosaurClient = require('mailosaur');

(async() => {
  const client = new MailosaurClient('YOUR_API_KEY');

  const result = await client.servers.list();

  console.log('You have a server called:', result.items[0].name);
})();

Just replace YOUR_API_KEY with the your API key, then run the example with node hello.js. If everything is set up correctly, you should see a server name printed out.

Using a test framework

It’s more likely that you are using a testing framework, like Mocha. In this case, the concept is still very much the same:

const MailosaurClient = require('mailosaur');
const mailosaur = new MailosaurClient('YOUR_API_KEY');

const assert = require('assert');

describe('Password reset', function () {
  const server = 'SERVER_ID';

  it('sends a password reset email', async function () {
    // 1. Generate a unique email address for this test
    const emailAddress = mailosaur.servers.generateEmailAddress(server);

    // 2. **Your automation code that triggers an email to `emailAddress`**

    // 3. Wait for email to arrive at the target email address
    const email = await mailosaur.messages.get(server, {
      sentTo: emailAddress
    });

    // 4. Perform assertions on the email
    assert.equal(email.subject, 'Set a new password');
  });
});

To learn about Server IDs, and what to replace SERVER_ID with, see sending email to Mailosaur.

Messages

Messages is the collective name given to the email and/or SMS messages that are sent into Mailosaur for testing. The message object contains everything you need to perform in-depth automated testing.

messages.get(server, criteria, options)

Waits for a message to be found. Returns as soon as a message matching the specified search criteria is found.

Recommended: This is the most efficient method of looking up a message, therefore we recommend using it whereever possible.

const message = await mailosaur.messages.get('SERVER_ID', {
  sentTo: 'someone.SERVER_ID@mailosaur.io'
});

To learn about Server IDs, and what to replace SERVER_ID with, see sending email to Mailosaur.

Criteria

  • sentFrom - The full email address from which the target message was sent.
  • sentTo - The full email address to which the target message was sent.
  • subject - The subject line of the target email.
  • body - Search for part of the message body.
  • match - If set to ALL (default), then only results that match all specified criteria will be returned. If set to ANY, results that match any of the specified criteria will be returned.

Options

  • timeout - Specify how long to wait for a matching result (in milliseconds, default value is 10 seconds).
  • receivedAfter - Limits results to only messages received after this date/time (default 20 seconds ago).
const message = await mailosaur.messages.get('SERVER_ID', {
  sentTo: 'someone.SERVER_ID@mailosaur.io'
}, {
  // Search all messages received after midnight 5th Jan 2020
  receivedAfter: new Date(2020, 1, 5)
});

messages.list(server, options)

Returns a list of your messages in summary form. The summaries are returned sorted by received date, with the most recently-received messages appearing first.

Message summaries The method returns a message summary, rather than the full message object. This means that several properties, like the message body, are not included. To get this data, you’ll need to call getById. Alternatively, we recommend using the get method, which is a far more efficient approach.
// List the most recent messages
const result = await mailosaur.messages.list('SERVER_ID');

// Get the most recent message (the first one in the list)
const message = result.items[0];

console.log('Subject:', message.subject);

Options

  • receivedAfter - Allows you to customise how far back to look for messages.
  • page - Used alongside itemsPerPage to paginate through results. This is zero-based, meaning 0 is the first page of results.
  • itemsPerPage - A limit on the number of results to be returned. This can be set between 1 to 1000, with the default being 50.
// List all results received after midnight on 3rd January 2020
const result = await mailosaur.messages.list('SERVER_ID', {
  page: 0,
  itemsPerPage: 10,
  receivedAfter: new Date(2020, 1, 3)
});

messages.search(server, criteria, options)

Returns a list of messages matching the specified search criteria, in summary form. The messages are returned sorted by received date, with the most recently-received messages appearing first.

Message summaries The method returns a message summary, rather than the full message object. This means that several properties, like the message body, are not included. To get this data, you’ll need to call getById. Alternatively, we recommend using the get method, which is a far more efficient approach.
const result = await mailosaur.messages.search('SERVER_ID', {
  sentTo: 'someone.SERVER_ID@mailosaur.io'
});

// Get the most recent match
const message = result.items[0];

console.log('Subject:', message.subject);

Criteria

  • sentFrom - The full email address from which the target message was sent.
  • sentTo - The full email address to which the target message was sent.
  • subject - The subject line of the target email.
  • body - Search for part of the message body.
  • match - If set to ALL (default), then only results that match all specified criteria will be returned. If set to ANY, results that match any of the specified criteria will be returned.

Options

  • timeout - If provided, determines how long to wait for a matching result (provided in milliseconds).
  • errorOnTimeout - When set to false, an error will not be throw if timeout is reached (default: true).
  • receivedAfter - Allows you to customise how far back to look for messages.
  • page - Used alongside itemsPerPage to paginate through results. This is zero-based, meaning 0 is the first page of results.
  • itemsPerPage - A limit on the number of results to be returned. This can be set between 1 to 1000, with the default being 50.
// Search for all messages sent to someone.SERVER_ID@mailosaur.io,
// received after midnight on 3rd Jan 2020. Limit results to
// the first 10 matches only.
const result = await mailosaur.messages.search('SERVER_ID', {
  sentTo: 'someone.SERVER_ID@mailosaur.io'
}, {
  page: 0,
  itemsPerPage: 10,
  receivedAfter: new Date(2020, 1, 3)
});

messages.getById(id)

Retrieves the detail for a single email message. Must be used in conjunction with either list or search in order to get the unique identifier for the required message. We always recommend using the get method instead.

const result = await mailosaur.messages.list('SERVER_ID');
const messageId = result.items[0].id;

const message = await mailosaur.messages.getById(messageId);

console.log('Subject:', message.subject);

messages.del(id)

Permanently deletes a message. Also deletes any attachments related to the message. This operation cannot be undone.

await mailosaur.messages.del(messageId)

messages.deleteAll(server)

Permanently deletes all messages held by the specified server. Also deletes any attachments related to each message. This operation cannot be undone.

await mailosaur.messages.deleteAll('SERVER_ID')

Servers

Servers contain all the configuration and set up for.

servers.list()

Returns a list of your virtual servers. Servers are returned sorted in alphabetical order.

const result = mailosaur.servers.list();

console.log('You have a server called:', result.items[0].name);

servers.create(server)

Creates a new virtual server. Only the name property is required to create a new server via the API.

await mailosaur.servers.create({
  name: 'My email tests'
});

servers.get(id)

Retrieves the detail for a single server. Simply supply the unique identifier for the required server.

const server = await mailosaur.servers.get('SERVER_ID');

servers.update(id, server)

Updates a single server.

await mailosaur.servers.update('SERVER_ID', {
  name: 'Updated server name'
});

servers.del(id)

Permanently deletes a server. Also deletes all messages and associated attachments within the server. This operation cannot be undone.

await mailosaur.servers.del('SERVER_ID');

servers.generateEmailAddress(id)

Utility method to help you generate a random email address for a given server.

const emailAddress = mailosaur.servers.generateEmailAddress('SERVER_ID');

console.log(emailAddress); // "bgwqj@SERVER_ID.mailosaur.io"

To learn about Server IDs, and what to replace SERVER_ID with, see sending email to Mailosaur.

Files

files.getEmail(messageId)

Downloads an EML file representing the specified email. Simply supply the unique identifier for the required email.

files.getAttachment(attachmentId)

Downloads a single attachment. Simply supply the unique identifier for the required attachment.

Analysis

analysis.spam(messageId)

Perform spam testing on the specified email.