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.


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.

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 0.0.1-alpha
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.PythonClientCodegen For more information, please visit


Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+

(you may need to run pip with root permission: sudo pip install git+

Then import the package:

import mailslurp 


Install via Setuptools.

python install --user

(or sudo python install to install the package for all users)

Then import the package:

import mailslurp

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import mailslurp
from import ApiException
from pprint import pprint

# Configure API key authorization: API_KEY
configuration = mailslurp.Configuration()
configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = mailslurp.EmailControllerApi(mailslurp.ApiClient(configuration))
id = 'id_example' # str | id

    # Delete Email
except ApiException as e:
    print("Exception when calling EmailControllerApi->delete_message_using_delete: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to

Class Method HTTP request Description
EmailControllerApi delete_message_using_delete DELETE /emails/{id} Delete Email
EmailControllerApi get_message_analytics_using_get GET /emails/{id}/analytics Get Email Analytics
EmailControllerApi get_message_using_get GET /emails/{id} Get Email Content
InboxControllerApi create_inbox_using_post POST /inboxes Create Inbox
InboxControllerApi delete_inbox_using_delete DELETE /inboxes/{id} Delete Inbox
InboxControllerApi get_inbox_using_get GET /inboxes/{id} Get Inbox
InboxControllerApi get_inboxes_using_get GET /inboxes List Inboxes
InboxControllerApi get_messages_using_get GET /inboxes/{id}/messages List Inbox's Emails
InboxControllerApi send_message_using_post POST /inboxes/{id} Send Email
ManageEntitiesApi delete_inbox_using_delete DELETE /inboxes/{id} Delete Inbox
ManageEntitiesApi delete_message_using_delete DELETE /emails/{id} Delete Email
ManageEntitiesApi get_inbox_using_get GET /inboxes/{id} Get Inbox
ManageEntitiesApi get_inboxes_using_get GET /inboxes List Inboxes
ReceiveEmailsApi create_inbox_using_post POST /inboxes Create Inbox
ReceiveEmailsApi get_message_analytics_using_get GET /emails/{id}/analytics Get Email Analytics
ReceiveEmailsApi get_message_using_get GET /emails/{id} Get Email Content
ReceiveEmailsApi get_messages_using_get GET /inboxes/{id}/messages List Inbox's Emails
SendEmailsApi create_inbox_using_post POST /inboxes Create Inbox
SendEmailsApi send_message_using_post POST /inboxes/{id} Send Email

Documentation For Models

Documentation For Authorization


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