mail-io-sdk
v0.0.1
Published
An SDK for integrating with MailSentry's email verification services, designed to facilitate the management of email validation, risk assessment, and real-time data processing through the MailSentry API.
Downloads
59
Maintainers
Readme
MailSentry - Powerful Email Verification Library
MailSentry is a powerful and easy-to-use email verification library that helps developers ensure their email lists are clean and valid, improving deliverability and engagement in email campaigns.
Features
- 🚀 Real-Time Email Verification
- 📧 Bulk Email Verification for marketing campaigns.
- 🌐 Domain and SMTP Checks to ensure reliability.
- 🔒 SPF/DKIM Validation for improved deliverability.
- 📡 API Integration for seamless automation.
Installation
Install MailSentry via npm:
npm install mail-io-sdk-sdk
Usage
Initialization
To use MailSentry, you need to initialize the MailSentry
class with your API token and then use the Email
class to interact with the email verification API.
import Mailsentry from 'mail-io-sdk';
const mailsentry = new MailSentry('your-api-token-here');
Single Email Verification
const email = '[email protected]';
const layers = 4 | 8 | 11;
mailsentry.email
.instant({ email, layers })
.then((result) => {
console.log('Verification result:', result);
})
.catch((error) => {
console.error('Error:', error);
});
Bulk Email Verification
const emails = ['[email protected]', '[email protected]'];
const layers = 4 | 8 | 11;
mailsentry.email
.bulk({ emails, layers })
.then((result) => {
console.log('Bulk verification report ID:', result);
})
.catch((error) => {
console.error('Error:', error);
});
Get Verification Results
To get the results of a bulk verification:
const reportId = 'your-report-id';
mailsentry.email
.result({ id: reportId, limit: 10, page: 1 })
.then((result) => {
console.log('Bulk verification results:', result);
})
.catch((error) => {
console.error('Error:', error);
});
CDN Usage
You can also use MailSentry via popular CDNs like jsDelivr and UNPKG for easy integration without installing via npm:
jsDelivr
<script src="https://cdn.jsdelivr.net/npm/mail-io-sdk/dist/index.js"></script>
UNPKG
<script src="https://unpkg.com/mail-io-sdk/dist/index.js"></script>
This makes it easy to include MailSentry in your web applications by simply referencing the library using a <script>
tag.
License
Licensed under the MIT License.
Contributing
Want to contribute? Please check out our contributing guidelines.
Contact
For support, please create an issue.