No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.


MailSlurp API

  • API version: 0.0.1-alpha
    • Build date: 2019-02-07T21:55:45.681Z

Documentation for MailSlurp's public REST API. ### About MailSlurp is a SAAS API for sending and receiving emails from ephemeral email inboxes. These inboxes can be created on the fly and each has a unique email address. ### Why MailSlurp was built for testing software or processes that interact with email in some way. For more information see the homepage. ### Links - Get API Key - API Documentation - Official SDK Libraries - Support / Issues - Swagger JSON ### Use You can call the MailSlurp API from any HTTP client in any language. Or you use one of the official generated SDK Libraries. - Official Typescript SDK - Official Python SDK - Official C# SDK - Official Java SDK - Official Swift SDK - Official Golang SDK - Official Javascript SDK - Official PHP SDK - Official Ruby SDK You can also compile your own library with SwaggerCodegen and the Swagger Spec. Lastly, there is an interactive GUI available at for testing requests. ### Auth An API Key must be passed as a header in all requests. To get an API Key sign up and log in to the MailSlurp Dashboard web app. ### Terms - Inbox - A unique email address - Unlimited in number - Can send and receive emails - Email - Belongs to an inbox - Contains summary and body - Raw content stored on S3 ### Issues If you encounter issues please contact the developers or open a ticket in GitHub.

For more information, please visit

Automatically generated by the Swagger Codegen


Building the API client library requires:

  1. Java 1.7+
  2. Maven/Gradle


To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:


Gradle users

Add this dependency to your project's build file:

compile "com.mailslurp.api:mailslurpclient:1.0.0"


At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/mailslurpclient-1.0.0.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import mailslurp.*;
import mailslurp.auth.*;
import mailslurpmodels.*;
import mailslurpapi.EmailControllerApi;

import java.util.*;

public class EmailControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure API key authorization: API_KEY
        ApiKeyAuth API_KEY = (ApiKeyAuth) defaultClient.getAuthentication("API_KEY");
        API_KEY.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)

        EmailControllerApi apiInstance = new EmailControllerApi();
        String id = "id_example"; // String | id
        try {
        } catch (ApiException e) {
            System.err.println("Exception when calling EmailControllerApi#deleteMessageUsingDELETE");

Documentation for API Endpoints

All URIs are relative to

Class Method HTTP request Description
EmailControllerApi deleteMessageUsingDELETE DELETE /emails/{id} Delete Email
EmailControllerApi getMessageAnalyticsUsingGET GET /emails/{id}/analytics Get Email Analytics
EmailControllerApi getMessageUsingGET GET /emails/{id} Get Email Content
InboxControllerApi createInboxUsingPOST POST /inboxes Create Inbox
InboxControllerApi deleteInboxUsingDELETE DELETE /inboxes/{id} Delete Inbox
InboxControllerApi getInboxUsingGET GET /inboxes/{id} Get Inbox
InboxControllerApi getInboxesUsingGET GET /inboxes List Inboxes
InboxControllerApi getMessagesUsingGET GET /inboxes/{id}/messages List Inbox's Emails
InboxControllerApi sendMessageUsingPOST POST /inboxes/{id} Send Email
ManageEntitiesApi deleteInboxUsingDELETE DELETE /inboxes/{id} Delete Inbox
ManageEntitiesApi deleteMessageUsingDELETE DELETE /emails/{id} Delete Email
ManageEntitiesApi getInboxUsingGET GET /inboxes/{id} Get Inbox
ManageEntitiesApi getInboxesUsingGET GET /inboxes List Inboxes
ReceiveEmailsApi createInboxUsingPOST POST /inboxes Create Inbox
ReceiveEmailsApi getMessageAnalyticsUsingGET GET /emails/{id}/analytics Get Email Analytics
ReceiveEmailsApi getMessageUsingGET GET /emails/{id} Get Email Content
ReceiveEmailsApi getMessagesUsingGET GET /inboxes/{id}/messages List Inbox's Emails
SendEmailsApi createInboxUsingPOST POST /inboxes Create Inbox
SendEmailsApi sendMessageUsingPOST POST /inboxes/{id} Send Email

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:


  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header


It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.