Skip to content

MailboxValidator

Getting started with MailboxValidator

The MailboxValidator modules allow you to validate the email address in your MailboxValidator account.

Prerequisites

  • A MailboxValidator account

In order to use MailboxValidator with Ibexa Connect, it is necessary to have a MailboxValidator account. If you do not have one, you can create a MailboxValidator account at www.mailboxvalidator.com/login.

Note

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

Connecting the MailboxValidator to Ibexa Connect

To connect your MailboxValidator account to Ibexa Connect you need to obtain the API Key from your MailboxValidator account and insert it in the Create a connection dialog in the Ibexa Connect module.

  1. Login to your MailboxValidator account.

  2. From the Dashboard, copy the API Key available in the API Plan section.

    61f272e096b03.png

    Note

    It is important that you subscribe to the API plan to connect your MailboxValidator account to Ibexa Connect.

  3. Go to Ibexa Connect and open the MailboxValidator module's Create a connection dialog.

    61f272e219fa9.gif

  4. In the Connection name field, enter a name for the connection.

  5. In the API Key field, enter the API key copied in step 2.

  6. Click Continue.

    61f272e42beb4.png

The connection has been established.

Actions

Free Email

Checks if a single email address is from a free email provider.

Email Enter the email address you want to verify.

Disposable Email

Checks if an email address is from a disposable email provider.

Email Enter the email address you want to verify if it is a temporary email address.

Single Email Validator

Validates a single email address.

Email Enter the email address you want to verify if it is a temporary email address.

Make an API Call

Performs an arbitrary authorized API call.

URL

Enter a path relative to https://api.mailboxvalidator.com/v1.

For the list of available endpoints, refer to the MailboxValidator API Documentation.

Method

Select the HTTP method you want to use:

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use - Validating Single Email Address

The following API call validates the email address from your MailboxValidator account:

URL:

validation/single

Method:

GET

Query String:

Key: email

Value: {{the email address you want to validate}}

61f272e55d515.png

Matches of the search can be found in the module's Output under Bundle > Body.

In our example, the email address added in the query has been validated and the results were returned:

61f272e682062.png