# MailslurpJavascriptApollo.InboxControllerApi

All URIs are relative to https://api.mailslurp.com

Method HTTP request Description
createInbox POST /inboxes Create an Inbox (email address)
deleteAllInboxes DELETE /inboxes Delete all inboxes
deleteInbox DELETE /inboxes/{inboxId} Delete inbox
getAllInboxes GET /inboxes/paginated List Inboxes Paginated
getEmails GET /inboxes/{inboxId}/emails Get emails in an Inbox
getInbox GET /inboxes/{inboxId} Get Inbox
getInboxEmailsPaginated GET /inboxes/{inboxId}/emails/paginated Get inbox emails paginated
getInboxSentEmails GET /inboxes/{inboxId}/sent Get Inbox Sent Emails
getInboxTags GET /inboxes/tags Get inbox tags
getInboxes GET /inboxes List Inboxes / Email Addresses
sendEmail POST /inboxes/{inboxId} Send Email
sendEmailAndConfirm POST /inboxes/{inboxId}/confirm Send email and return sent confirmation
setInboxFavourited PUT /inboxes/{inboxId}/favourite Set inbox favourited state
updateInbox PATCH /inboxes/{inboxId} Update Inbox

# createInbox

Inbox createInbox(opts)

Create an Inbox (email address)

Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty.

# Example

import MailslurpJavascriptApollo from 'mailslurp-javascript-apollo';
let defaultClient = MailslurpJavascriptApollo.ApiClient.instance;
// Configure API key authorization: API_KEY
let API_KEY = defaultClient.authentications['API_KEY'];
API_KEY.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.apiKeyPrefix = 'Token';
let apiInstance = new MailslurpJavascriptApollo.InboxControllerApi();
let opts = {
  'description': "description_example", // String | Optional description for an inbox.
  'emailAddress': "emailAddress_example", // String | Optional email address including domain you wish inbox to use (eg: test123@mydomain.com). Only supports domains that you have registered and verified with MailSlurp using dashboard or `createDomain` method.
  'expiresAt': new Date("2013-10-20T19:20:30+01:00"), // Date | Optional expires at timestamp. If your plan supports this feature you can specify when an inbox should expire. If left empty inbox will exist permanently or expire when your plan dictates
  'favourite': true, // Boolean | Is inbox favourited.
  'name': "name_example", // String | Optional name for an inbox.
  'tags': ["null"] // [String] | Optional tags for an inbox. Can be used for searching and filtering inboxes.
};
apiInstance.createInbox(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

# Parameters

Name Type Description Notes
description String Optional description for an inbox. [optional]
emailAddress String Optional email address including domain you wish inbox to use (eg: test123@mydomain.com). Only supports domains that you have registered and verified with MailSlurp using dashboard or `createDomain` method. [optional]
expiresAt Date Optional expires at timestamp. If your plan supports this feature you can specify when an inbox should expire. If left empty inbox will exist permanently or expire when your plan dictates [optional]
favourite Boolean Is inbox favourited. [optional]
name String Optional name for an inbox. [optional]
tags [String] Optional tags for an inbox. Can be used for searching and filtering inboxes. [optional]

# Return type

Inbox

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# deleteAllInboxes

deleteAllInboxes()

Delete all inboxes

Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have.

# Example

import MailslurpJavascriptApollo from 'mailslurp-javascript-apollo';
let defaultClient = MailslurpJavascriptApollo.ApiClient.instance;
// Configure API key authorization: API_KEY
let API_KEY = defaultClient.authentications['API_KEY'];
API_KEY.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.apiKeyPrefix = 'Token';
let apiInstance = new MailslurpJavascriptApollo.InboxControllerApi();
apiInstance.deleteAllInboxes((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

# Parameters

This endpoint does not need any parameter.

# Return type

null (empty response body)

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

# deleteInbox

deleteInbox(inboxId)

Delete inbox

Permanently delete an inbox and associated email address aswell as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request.

# Example

import MailslurpJavascriptApollo from 'mailslurp-javascript-apollo';
let defaultClient = MailslurpJavascriptApollo.ApiClient.instance;
// Configure API key authorization: API_KEY
let API_KEY = defaultClient.authentications['API_KEY'];
API_KEY.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.apiKeyPrefix = 'Token';
let apiInstance = new MailslurpJavascriptApollo.InboxControllerApi();
let inboxId = null; // String | inboxId
apiInstance.deleteInbox(inboxId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

# Parameters

Name Type Description Notes
inboxId String inboxId

# Return type

null (empty response body)

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

# getAllInboxes

PageInboxProjection getAllInboxes(opts)

List Inboxes Paginated

List inboxes in paginated form. Allows for page index, page size, and sort direction. Can also filter by favourited or email address like pattern.

# Example

import MailslurpJavascriptApollo from 'mailslurp-javascript-apollo';
let defaultClient = MailslurpJavascriptApollo.ApiClient.instance;
// Configure API key authorization: API_KEY
let API_KEY = defaultClient.authentications['API_KEY'];
API_KEY.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.apiKeyPrefix = 'Token';
let apiInstance = new MailslurpJavascriptApollo.InboxControllerApi();
let opts = {
  'favourite': false, // Boolean | Optionally filter results for favourites only
  'page': 0, // Number | Optional page index in inbox list pagination
  'search': "search_example", // String | Optionally filter by search words partial matching ID, tags, name, and email address
  'size': 20, // Number | Optional page size in inbox list pagination
  'sort': "'ASC'", // String | Optional createdAt sort direction ASC or DESC
  'tag': "tag_example" // String | Optionally filter by tags
};
apiInstance.getAllInboxes(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

# Parameters

Name Type Description Notes
favourite Boolean Optionally filter results for favourites only [optional] [default to false]
page Number Optional page index in inbox list pagination [optional] [default to 0]
search String Optionally filter by search words partial matching ID, tags, name, and email address [optional]
size Number Optional page size in inbox list pagination [optional] [default to 20]
sort String Optional createdAt sort direction ASC or DESC [optional] [default to 'ASC']
tag String Optionally filter by tags [optional]

# Return type

PageInboxProjection

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# getEmails

[EmailPreview] getEmails(inboxId, opts)

Get emails in an Inbox

List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the `minCount` parameter. The server will retry the inbox database until the `minCount` is satisfied or the `retryTimeout` is reached

# Example

import MailslurpJavascriptApollo from 'mailslurp-javascript-apollo';
let defaultClient = MailslurpJavascriptApollo.ApiClient.instance;
// Configure API key authorization: API_KEY
let API_KEY = defaultClient.authentications['API_KEY'];
API_KEY.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.apiKeyPrefix = 'Token';
let apiInstance = new MailslurpJavascriptApollo.InboxControllerApi();
let inboxId = null; // String | Id of inbox that emails belongs to
let opts = {
  'limit': 56, // Number | Limit the result set, ordered by received date time sort direction
  'minCount': 789, // Number | Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
  'retryTimeout': 789, // Number | Maximum milliseconds to spend retrying inbox database until minCount emails are returned
  'since': new Date("2013-10-20T19:20:30+01:00"), // Date | Exclude emails received before this ISO 8601 date time
  'sort': "sort_example" // String | Sort the results by received date and direction ASC or DESC
};
apiInstance.getEmails(inboxId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

# Parameters

Name Type Description Notes
inboxId String Id of inbox that emails belongs to
limit Number Limit the result set, ordered by received date time sort direction [optional]
minCount Number Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. [optional]
retryTimeout Number Maximum milliseconds to spend retrying inbox database until minCount emails are returned [optional]
since Date Exclude emails received before this ISO 8601 date time [optional]
sort String Sort the results by received date and direction ASC or DESC [optional]

# Return type

[EmailPreview]

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# getInbox

Inbox getInbox(inboxId)

Get Inbox

Returns an inbox's properties, including its email address and ID.

# Example

import MailslurpJavascriptApollo from 'mailslurp-javascript-apollo';
let defaultClient = MailslurpJavascriptApollo.ApiClient.instance;
// Configure API key authorization: API_KEY
let API_KEY = defaultClient.authentications['API_KEY'];
API_KEY.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.apiKeyPrefix = 'Token';
let apiInstance = new MailslurpJavascriptApollo.InboxControllerApi();
let inboxId = null; // String | inboxId
apiInstance.getInbox(inboxId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

# Parameters

Name Type Description Notes
inboxId String inboxId

# Return type

Inbox

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# getInboxEmailsPaginated

PageEmailPreview getInboxEmailsPaginated(inboxId, opts)

Get inbox emails paginated

Get a paginated list of emails in an inbox. Does not hold connections open.

# Example

import MailslurpJavascriptApollo from 'mailslurp-javascript-apollo';
let defaultClient = MailslurpJavascriptApollo.ApiClient.instance;
// Configure API key authorization: API_KEY
let API_KEY = defaultClient.authentications['API_KEY'];
API_KEY.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.apiKeyPrefix = 'Token';
let apiInstance = new MailslurpJavascriptApollo.InboxControllerApi();
let inboxId = null; // String | Id of inbox that emails belongs to
let opts = {
  'page': 0, // Number | Optional page index in inbox emails list pagination
  'size': 20, // Number | Optional page size in inbox emails list pagination
  'sort': "'ASC'" // String | Optional createdAt sort direction ASC or DESC
};
apiInstance.getInboxEmailsPaginated(inboxId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

# Parameters

Name Type Description Notes
inboxId String Id of inbox that emails belongs to
page Number Optional page index in inbox emails list pagination [optional] [default to 0]
size Number Optional page size in inbox emails list pagination [optional] [default to 20]
sort String Optional createdAt sort direction ASC or DESC [optional] [default to 'ASC']

# Return type

PageEmailPreview

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# getInboxSentEmails

PageSentEmailProjection getInboxSentEmails(inboxId, opts)

Get Inbox Sent Emails

Returns an inbox's sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead.

# Example

import MailslurpJavascriptApollo from 'mailslurp-javascript-apollo';
let defaultClient = MailslurpJavascriptApollo.ApiClient.instance;
// Configure API key authorization: API_KEY
let API_KEY = defaultClient.authentications['API_KEY'];
API_KEY.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.apiKeyPrefix = 'Token';
let apiInstance = new MailslurpJavascriptApollo.InboxControllerApi();
let inboxId = null; // String | inboxId
let opts = {
  'page': 0, // Number | Optional page index in inbox sent email list pagination
  'size': 20, // Number | Optional page size in inbox sent email list pagination
  'sort': "'ASC'" // String | Optional createdAt sort direction ASC or DESC
};
apiInstance.getInboxSentEmails(inboxId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

# Parameters

Name Type Description Notes
inboxId String inboxId
page Number Optional page index in inbox sent email list pagination [optional] [default to 0]
size Number Optional page size in inbox sent email list pagination [optional] [default to 20]
sort String Optional createdAt sort direction ASC or DESC [optional] [default to 'ASC']

# Return type

PageSentEmailProjection

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# getInboxTags

[String] getInboxTags()

Get inbox tags

Get all inbox tags

# Example

import MailslurpJavascriptApollo from 'mailslurp-javascript-apollo';
let defaultClient = MailslurpJavascriptApollo.ApiClient.instance;
// Configure API key authorization: API_KEY
let API_KEY = defaultClient.authentications['API_KEY'];
API_KEY.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.apiKeyPrefix = 'Token';
let apiInstance = new MailslurpJavascriptApollo.InboxControllerApi();
apiInstance.getInboxTags((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

# Parameters

This endpoint does not need any parameter.

# Return type

[String]

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# getInboxes

[Inbox] getInboxes()

List Inboxes / Email Addresses

List the inboxes you have created

# Example

import MailslurpJavascriptApollo from 'mailslurp-javascript-apollo';
let defaultClient = MailslurpJavascriptApollo.ApiClient.instance;
// Configure API key authorization: API_KEY
let API_KEY = defaultClient.authentications['API_KEY'];
API_KEY.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.apiKeyPrefix = 'Token';
let apiInstance = new MailslurpJavascriptApollo.InboxControllerApi();
apiInstance.getInboxes((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

# Parameters

This endpoint does not need any parameter.

# Return type

[Inbox]

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# sendEmail

sendEmail(inboxId, opts)

Send Email

Send an email from an inbox's email address. The request body should contain the `SendEmailOptions` that include recipients, attachments, body etc. See `SendEmailOptions` for all available properties. Note the `inboxId` refers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method `sendEmailAndConfirm`.

# Example

import MailslurpJavascriptApollo from 'mailslurp-javascript-apollo';
let defaultClient = MailslurpJavascriptApollo.ApiClient.instance;
// Configure API key authorization: API_KEY
let API_KEY = defaultClient.authentications['API_KEY'];
API_KEY.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.apiKeyPrefix = 'Token';
let apiInstance = new MailslurpJavascriptApollo.InboxControllerApi();
let inboxId = null; // String | ID of the inbox you want to send the email from
let opts = {
  'sendEmailOptions': new MailslurpJavascriptApollo.SendEmailOptions() // SendEmailOptions | Options for the email
};
apiInstance.sendEmail(inboxId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

# Parameters

Name Type Description Notes
inboxId String ID of the inbox you want to send the email from
sendEmailOptions SendEmailOptions Options for the email [optional]

# Return type

null (empty response body)

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

# sendEmailAndConfirm

SentEmailDto sendEmailAndConfirm(inboxId, opts)

Send email and return sent confirmation

Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with link the the sent object created for it.

# Example

import MailslurpJavascriptApollo from 'mailslurp-javascript-apollo';
let defaultClient = MailslurpJavascriptApollo.ApiClient.instance;
// Configure API key authorization: API_KEY
let API_KEY = defaultClient.authentications['API_KEY'];
API_KEY.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.apiKeyPrefix = 'Token';
let apiInstance = new MailslurpJavascriptApollo.InboxControllerApi();
let inboxId = null; // String | ID of the inbox you want to send the email from
let opts = {
  'sendEmailOptions': new MailslurpJavascriptApollo.SendEmailOptions() // SendEmailOptions | Options for the email
};
apiInstance.sendEmailAndConfirm(inboxId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

# Parameters

Name Type Description Notes
inboxId String ID of the inbox you want to send the email from
sendEmailOptions SendEmailOptions Options for the email [optional]

# Return type

SentEmailDto

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

# setInboxFavourited

Inbox setInboxFavourited(inboxId, setInboxFavouritedOptions)

Set inbox favourited state

Set and return new favourite state for an inbox

# Example

import MailslurpJavascriptApollo from 'mailslurp-javascript-apollo';
let defaultClient = MailslurpJavascriptApollo.ApiClient.instance;
// Configure API key authorization: API_KEY
let API_KEY = defaultClient.authentications['API_KEY'];
API_KEY.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.apiKeyPrefix = 'Token';
let apiInstance = new MailslurpJavascriptApollo.InboxControllerApi();
let inboxId = null; // String | inboxId
let setInboxFavouritedOptions = new MailslurpJavascriptApollo.SetInboxFavouritedOptions(); // SetInboxFavouritedOptions | setInboxFavouritedOptions
apiInstance.setInboxFavourited(inboxId, setInboxFavouritedOptions, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

# Parameters

Name Type Description Notes
inboxId String inboxId
setInboxFavouritedOptions SetInboxFavouritedOptions setInboxFavouritedOptions

# Return type

Inbox

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

# updateInbox

Inbox updateInbox(inboxId, updateInboxOptions)

Update Inbox

Update editable fields on an inbox

# Example

import MailslurpJavascriptApollo from 'mailslurp-javascript-apollo';
let defaultClient = MailslurpJavascriptApollo.ApiClient.instance;
// Configure API key authorization: API_KEY
let API_KEY = defaultClient.authentications['API_KEY'];
API_KEY.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.apiKeyPrefix = 'Token';
let apiInstance = new MailslurpJavascriptApollo.InboxControllerApi();
let inboxId = null; // String | inboxId
let updateInboxOptions = new MailslurpJavascriptApollo.UpdateInboxOptions(); // UpdateInboxOptions | updateInboxOptions
apiInstance.updateInbox(inboxId, updateInboxOptions, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

# Parameters

Name Type Description Notes
inboxId String inboxId
updateInboxOptions UpdateInboxOptions updateInboxOptions

# Return type

Inbox

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: application/json
  • Accept: application/json