Mailboxlayer API

Mailboxlayer provides comprehensive email validation and verification services through a simple REST-based JSON API, enabling businesses to thoroughly check email addresses, detect disposable emails, validate domain information, and ensure data quality at the point of entry.

Power end-to-end data operations for your Mailboxlayer API API with Nexla. Our bi-directional Mailboxlayer API connector is purpose-built for Mailboxlayer API, 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 Mailboxlayer API or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Mailboxlayer API 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 Mailboxlayer API credential, you need to sign up for a Mailboxlayer account and obtain your API access key. Mailboxlayer provides email validation and verification services through a REST-based JSON API.

To obtain your API access key, follow these steps:

1. Navigate to the Mailboxlayer website in your web browser.

2. Click the Sign Up or Get Started button to create a new account, or sign in if you already have an account.

3. Complete the registration process by providing your email address, creating a password, and accepting the terms of service.

4. After signing up, you will be redirected to your Mailboxlayer dashboard.

5. In your dashboard, navigate to the API Access or API Keys section. Your API access key will be displayed on this page.

6. Copy your API access key and store it securely. The API access key is a unique identifier that authenticates your API requests to Mailboxlayer services.

7. Your API access key is used as a URL parameter (access_key) in all API requests to Mailboxlayer. Keep your API access key confidential, as it provides access to your Mailboxlayer account and usage quota.

The API access key is sent as a URL parameter (access_key) in all API requests to Mailboxlayer. The key authenticates your requests and tracks your API usage against your account's quota. For detailed information about API authentication, available endpoints, and API usage limits, refer to the Mailboxlayer API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
API Key Value	Yes	Yes	API Access Key - a unique "password" used to gain access to the API's data and features.

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. Mailboxlayer uses API key authentication for all API requests. Enter your Mailboxlayer API access key in the API Key Value field. This is the API access key you obtained from your Mailboxlayer dashboard in Prerequisites. The API access key is sent as a URL parameter (access_key) in all API requests to Mailboxlayer and is sensitive information that must be kept confidential.

   Your Mailboxlayer API access key can be found in your Mailboxlayer dashboard under the API Access or API Keys section. The API access key is a unique identifier that authenticates your API requests and tracks your usage against your account's quota. If your API access key is compromised, you should immediately regenerate it in your Mailboxlayer dashboard and update your credential. For detailed information about API authentication, available endpoints, and API usage limits, see the Mailboxlayer API documentation.

4. 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.

Use as a data source

Select the Mailboxlayer API connector tile from the list of available connectors, then select the credential that will be used to connect to your Mailboxlayer account, and click Next; or, create a new Mailboxlayer API credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to validate email addresses using common Mailboxlayer 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.

Get email information

This endpoint template validates a single email address and retrieves detailed information about it, including validation status, domain information, and email format details. Use this template when you need to validate individual email addresses and retrieve comprehensive validation information for each email.

• Enter the email address to validate in the Email field. This should be a valid email address format (e.g., example@example.com). The endpoint will validate this email address and return detailed information about its validity, domain, format, and other relevant details.
• Select the response format from the Format field. Choose JSON: Packed (value 0) for standard JSON format, or JSON: Prettified (value 1) for human-readable JSON format. The prettified format is useful for debugging but should not be used in production, as it increases response size. The default value is 0 (packed JSON format).

This endpoint validates a single email address per request. If you need to validate multiple email addresses, use the "Get information about emails (bulk)" endpoint template instead. The endpoint returns comprehensive validation information including email format validity, domain information, SMTP validation, and disposable email detection.

For detailed information about the API response structure, available validation fields, and API usage limits, see the Mailboxlayer API documentation.

Get information about emails (bulk)

This endpoint template validates multiple email addresses in a single request and retrieves detailed information about each email. Use this template when you need to validate multiple email addresses efficiently, as it reduces the number of API calls compared to validating emails individually.

• Enter a comma-separated list of email addresses to validate in the emails field. You can include up to 25 email addresses per request (e.g., example1@example.net,example2@example.net,example3@example.net). The endpoint will validate all email addresses in the list and return validation information for each email address.

This endpoint can validate up to 25 email addresses in a single request, making it more efficient than validating emails individually. The endpoint returns an array of validation results, with one result object for each email address in your input list. Each result contains the same validation information as the single email endpoint, including email format validity, domain information, SMTP validation, and disposable email detection.

For detailed information about the API response structure, available validation fields, and API usage limits, see the Mailboxlayer API documentation.

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

Mailboxlayer API data sources can also be manually configured to validate email addresses using custom API endpoints or configurations not covered by pre-built templates. 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.

Mailboxlayer API uses the GET method for all validation requests. The endpoint URL is typically https://apilayer.net/api/check for single email validation or http://apilayer.net/api/bulk_check for bulk email validation, and requires the access_key parameter along with email (single) or emails (bulk) query parameters. For the Response Data Path, use $ to extract the full response for single email validation, or $[*] to extract all results from the response array for bulk validation.

Once all of the relevant settings have been configured, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the data source configuration for later use.