Skip to main content

Mailosaur

Mailosaur is an email and SMS testing platform used to validate transactional emails, SMS, and voice messages in development and QA environments. It provides virtual SMTP servers, message capture and search, and virtual security devices for one-time password (OTP) testing, all accessible through a REST API.

Mailosaur icon

Power end-to-end data operations for your Mailosaur API with Nexla. Our bi-directional Mailosaur connector is purpose-built for Mailosaur, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Mailosaur or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Mailosaur workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Mailosaur credential, you need a Mailosaur account and an API key. Mailosaur authenticates API requests using HTTP Basic Auth, with your API key supplied as the credential value and requests sent to the base URL https://mailosaur.com/api.

To obtain your Mailosaur API key, follow these steps:

  1. Sign in to your Mailosaur account at mailosaur.com.

  2. Open the Mailosaur Dashboard and navigate to the API keys section under your account settings.

  3. Create a new API key (or copy an existing one). Mailosaur supports both account-level and server-level API keys, so choose a key with access to the servers and messages you intend to work with in Nexla.

  4. Copy the API key and store it securely. You will provide it when configuring your Nexla credential.

Mailosaur transmits the API key as the HTTP Basic Auth username value, and all API traffic must occur over HTTPS. Treat your API key as sensitive information, and revoke and regenerate it from the dashboard if it is ever exposed. For more details, see the Mailosaur API Reference.

Authenticate

Credentials required

FieldRequiredSecretDescription
Username Or API KeyYesYesYour username or personal API Key
PasswordYesYesYour password
Base URLYesNoThe base URL for the Mailosaur API.

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. In the Username Or API Key field, enter your Mailosaur API key (or username). Mailosaur uses HTTP Basic Auth with the API key supplied as the username value.

  4. In the Password field, enter your password. When authenticating with an API key, Mailosaur does not require a password, so this may be left as configured for your account's authentication method.

  5. In the Base URL field, enter the base URL for the Mailosaur API. This defaults to https://mailosaur.com/api.

  6. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

    Your API key grants access to your Mailosaur servers and captured messages and should be kept confidential. If your API key is compromised, revoke it in the Mailosaur Dashboard and generate a new one.

    For detailed information about authentication and available endpoints, see the Mailosaur API Reference.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Mailosaur connector tile, then select the credential that will be used to connect to Mailosaur, and click Next; or, create a new Mailosaur credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Mailosaur endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List Messages

Returns a list of messages from your Mailosaur account.

This endpoint retrieves captured messages and supports pagination, so Nexla automatically fetches subsequent pages of results. For details on the response structure, see the Mailosaur Messages API.

[Rest API] Search Messages

Searches for messages matching criteria such as sender, recipient, subject, or body.

This endpoint accepts search criteria and returns matching messages, with pagination handled automatically by Nexla. For details on supported search parameters, see the Mailosaur Messages API.

[Rest API] Get Message

Retrieves a specific message by its unique identifier.

  • Provide the Message ID of the message to retrieve.

For details on the message response structure, see the Mailosaur Messages API.

[Rest API] List Servers

Returns a list of mail servers in your Mailosaur account.

For details on the server response structure, see the Mailosaur Servers API.

[Rest API] Get Server

Retrieves details for a specific virtual SMTP server by its identifier.

  • Provide the Server ID of the server to retrieve.

For details on the server response structure, see the Mailosaur Servers API.

[Rest API] Get Server Password

Retrieves the SMTP password for a specified virtual server.

  • Provide the Server ID of the server whose SMTP password will be retrieved.

For details on the server response structure, see the Mailosaur Servers API.

[Rest API] List Devices

Returns a list of all virtual security devices in your Mailosaur account.

For details on the device response structure, see the Mailosaur Devices API.

[Rest API] Get Device OTP

Retrieves the current one-time password for a specified virtual security device.

  • Provide the Device ID of the virtual device whose OTP will be retrieved.

For details on the device response structure, see the Mailosaur Devices API.

[Rest API] List Usage Transactions

Returns a list of usage transactions for your Mailosaur account.

For details on the usage response structure, see the Mailosaur Usage API.

[Rest API] Get Usage Limits

Retrieves account usage limits and current usage for servers, users, email, SMS, and more.

For details on the usage response structure, see the Mailosaur Usage API.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Mailosaur data sources can also be manually configured to ingest data from any valid Mailosaur API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Mailosaur data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Mailosaur destination, and select the Send to Destination option from the menu. Select the Mailosaur connector from the list of available destination connectors, then select the credential that will be used to connect to Mailosaur, and click Next; or, create a new Mailosaur credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Mailosaur endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Create Message

Sends a new email message to a verified address via a specified server.

  • Provide the Server ID of the server through which the message will be sent. Each record from your Nexset is sent as a JSON request body to create a new message.

For details on the request body format, see the Mailosaur Messages API.

[Rest API] Forward Message

Forwards a specific message to a verified email address.

  • Provide the Message ID of the message to forward. Each record from your Nexset is sent as a JSON request body.

For details on the request body format, see the Mailosaur Messages API.

[Rest API] Reply To Message

Sends a reply to a specific message.

  • Provide the Message ID of the message to reply to. Each record from your Nexset is sent as a JSON request body.

For details on the request body format, see the Mailosaur Messages API.

[Rest API] Delete Message

Permanently deletes a specific message by its identifier.

  • Provide the Message ID of the message to delete.

This operation permanently removes the message and cannot be undone. For details, see the Mailosaur Messages API.

[Rest API] Delete All Messages

Permanently deletes all messages for a specified server.

  • Provide the Server ID of the server whose messages will be deleted.

This operation permanently removes all captured messages for the server and cannot be undone. For details, see the Mailosaur Messages API.

[Rest API] Create Server

Creates a new virtual SMTP server in your Mailosaur account.

  • Each record from your Nexset is sent as a JSON request body to create a new server.

For details on the request body format, see the Mailosaur Servers API.

[Rest API] Update Server

Updates the name of an existing virtual SMTP server.

  • Provide the Server ID of the server to update. Each record from your Nexset is sent as a JSON request body.

For details on the request body format, see the Mailosaur Servers API.

[Rest API] Delete Server

Permanently deletes a specified virtual SMTP server and all associated messages.

  • Provide the Server ID of the server to delete.

This operation permanently removes the server and its messages and cannot be undone. For details, see the Mailosaur Servers API.

[Rest API] Create Device

Creates a new virtual security device for OTP generation in your Mailosaur account.

  • Each record from your Nexset is sent as a JSON request body to create a new device.

For details on the request body format, see the Mailosaur Devices API.

[Rest API] Delete Device

Permanently deletes a specified virtual security device from your Mailosaur account.

  • Provide the Device ID of the virtual device to delete.

This operation permanently removes the device and cannot be undone. For details, see the Mailosaur Devices API.

Manual configuration

Mailosaur destinations can also be manually configured to send data to any valid Mailosaur API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Mailosaur APIs expect JSON format for create, update, forward, and reply operations. For operations that target a specific resource, include the ID of the object (such as a message, server, or device) in the request configuration.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Mailosaur endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Mailosaur endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.