Mailosaur Servers API

Operations for creating and managing your Mailosaur inboxes (servers). Inboxes group your tests together, each with its own domain and SMTP/POP3/IMAP credentials.

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/servers List inboxes · List servers #
Ask an LLM
“Which test inboxes do I have on my account?”
“Can I see all my servers in alphabetical order?”
Tell an agent
List all my inboxes.
Show every server on my account with its ID.
POST /api/servers Create a new inbox · Create a server #
Ask an LLM
“How do I set up a new test inbox for my QA team?”
“Can I give a new server a name when I create it?”
Tell an agent
Create a new inbox called {name}.
Set up a fresh server for staging tests.
GET /api/servers/{serverId} Get an inbox's details · Get a server #
Ask an LLM
“What settings and user access does a specific inbox have?”
“How many messages are sitting in one of my servers right now?”
Tell an agent
Show the details of inbox {serverId}.
Look up server {serverId} and tell me its name.
PUT /api/servers/{serverId} Rename an inbox or change its users · Update a server #
Ask an LLM
“How do I rename an existing inbox?”
“Can I change which users have access to a restricted server?”
Tell an agent
Rename inbox {serverId} to {name}.
Set the users with access to server {serverId} to {users}.
DELETE /api/servers/{serverId} Delete an inbox and all its messages · Delete a server #
Ask an LLM
“How do I permanently delete a test inbox I no longer use?”
“Does removing a server also wipe its messages and attachments?”
Tell an agent destructive · confirm first
Delete inbox {serverId} permanently.
Remove server {serverId} along with everything stored in it.
GET /api/servers/{serverId}/password Get an inbox's SMTP/POP3/IMAP password · Get server password #
Ask an LLM
“Where do I find the password to connect to my inbox over SMTP?”
“What credentials do I use for POP3 or IMAP access to a test server?”
Tell an agent
Get the password for inbox {serverId}.
Fetch the SMTP and IMAP password for server {serverId}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/mailosaur:mailosaur-servers-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

mailosaur-servers-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Mailosaur Servers API
  description: REST API for email and SMS testing. Provides endpoints for managing test inboxes (servers), retrieving and searching messages, running deliverability checks, generating OTPs for authenticator testing, and accessing account usage data. All requests authenticate via HTTP Basic Auth using an API key.
  version: 1.0.0
  contact:
    name: Mailosaur Support
    url: https://mailosaur.com/docs/api
  termsOfService: https://mailosaur.com/terms
  license:
    name: Commercial
    url: https://mailosaur.com/terms
servers:
- url: https://mailosaur.com
  description: Mailosaur production API
security:
- basicAuth: []
tags:
- name: Servers
  description: Operations for creating and managing your Mailosaur inboxes (servers). Inboxes group your tests together, each with its own domain and SMTP/POP3/IMAP credentials.
paths:
  /api/servers:
    get:
      operationId: listServers
      summary: List servers
      description: Returns a list of your inboxes (servers). Inboxes (servers) are returned sorted in alphabetical order.
      tags:
      - Servers
      responses:
        '200':
          description: A list of inboxes (servers).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerListResult'
    post:
      operationId: createServer
      summary: Create a server
      description: Creates a new inbox (server).
      tags:
      - Servers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServerCreateOptions'
      responses:
        '200':
          description: The newly-created inbox (server).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Server'
  /api/servers/{serverId}:
    get:
      operationId: getServer
      summary: Get a server
      description: Retrieves the detail for a single inbox (server).
      tags:
      - Servers
      parameters:
      - $ref: '#/components/parameters/serverId'
      responses:
        '200':
          description: The inbox (server).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Server'
    put:
      operationId: updateServer
      summary: Update a server
      description: Updates the attributes of an inbox (server).
      tags:
      - Servers
      parameters:
      - $ref: '#/components/parameters/serverId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Server'
      responses:
        '200':
          description: The updated inbox (server).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Server'
    delete:
      operationId: deleteServer
      summary: Delete a server
      description: Permanently delete an inbox (server). This will also delete all messages, associated attachments, etc. within the inbox (server). This operation cannot be undone.
      tags:
      - Servers
      parameters:
      - $ref: '#/components/parameters/serverId'
      responses:
        '204':
          description: The inbox (server) was successfully deleted.
  /api/servers/{serverId}/password:
    get:
      operationId: getServerPassword
      summary: Get server password
      description: Retrieves the password for an inbox (server). This password can be used for SMTP, POP3, and IMAP connectivity.
      tags:
      - Servers
      parameters:
      - $ref: '#/components/parameters/serverId'
      responses:
        '200':
          description: The password for the inbox (server).
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: string
                    description: The password value.
components:
  schemas:
    ServerCreateOptions:
      type: object
      description: Options used to create a new Mailosaur inbox (server).
      properties:
        name:
          type: string
          description: A name used to identify the inbox (server).
    ServerListResult:
      type: object
      description: The result of a request to list Mailosaur inboxes (servers).
      properties:
        items:
          type: array
          description: A list of inboxes (servers).
          items:
            $ref: '#/components/schemas/Server'
    Server:
      type: object
      description: A Mailosaur inbox (server) — a virtual SMTP/SMS endpoint.
      properties:
        id:
          type: string
          description: Unique identifier for the inbox (server).
        name:
          type: string
          description: The name of the inbox (server).
        users:
          type: array
          description: Users (excluding administrators) who have access to the inbox (server) when access is restricted.
          items:
            type: string
        messages:
          type: integer
          description: The number of messages currently in the inbox (server).
  parameters:
    serverId:
      name: serverId
      in: path
      required: true
      description: The unique identifier of the inbox (server).
      schema:
        type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Auth using your Mailosaur API key as the username and an empty password, or your API key as both username and password.