Skip to main content

Getting Started

Welcome to the Mails API! This guide will help you get up and running with our email validation service quickly and easily.

Overview​

The Mails API provides powerful email validation capabilities to help you maintain a clean and effective email list. With our API, you can:

  • Validate single email addresses
  • Perform bulk email validation
  • Check the status of bulk validation jobs
  • Retrieve validation results

Prerequisites​

Before you begin, make sure you have:

  1. A Mails API account
  2. Your API key (you'll get this upon registration)
  3. A tool to make HTTP requests (like curl, Postman, or your preferred programming language's HTTP client)

Quick Start​

Here's a quick overview of how to use the Mails API:

1. Authentication​

All API requests require authentication. Include your API key in the x-mails-api-key header:

curl -H "x-mails-api-key: YOUR_API_KEY_HERE" ...

2. Single Email Validation​

To validate a single email address:

curl \
  -H "x-mails-api-key: YOUR_API_KEY_HERE" \
  "https://api.mails.so/v1/[email protected]"

3. Bulk Email Validation​

To validate multiple email addresses at once:

curl \
  -H "x-mails-api-key: YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{"emails": ["[email protected]", "[email protected]", "[email protected]"]}' \
  "https://api.mails.so/v1/batch"

Next Steps​

  1. Authentication - Learn more about securing your API requests
  2. Single Validation - Detailed guide on validating individual email addresses
  3. Bulk Validation - How to validate multiple email addresses in one request

Best Practices​

  1. Rate Limiting: Be mindful of our rate limits to ensure uninterrupted service.
  2. Error Handling: Implement robust error handling in your applications.
  3. Webhook Integration: For bulk validations, consider using webhooks to receive results asynchronously.

Support​

If you encounter any issues or have questions, please don't hesitate to contact our support team at [email protected].

Happy validating!