rkpareek / mail7-node-sdk

About Mail7

​Mail7.io is a service that allows receiving emails at a temporary address that self-destructed after 24 hours. It is the most advanced throwaway email service that helps you avoid spam and stay safe in such cases.

Installation

npm i --save mail7

Configuration

Replace the placeholders in the config object with your mail7 credentials apikey and apisceret. These can be obtained from here

var  config = {
     apiKey:  '<mail7 apikey>',
     apiSecret:  '<mail7 apisecret>'
}

Don't have Mail7 Account ? Create you own account here and get your apikey and apisecret

Require the mail7 package and pass the config object

var mail7 = require('mail7')(config);

Usage

mail7.getInboxByEmail("<[email protected]>").then((response) => {
   console.log(response);
}).catch((error) => {
   console.log(error);
});

The detailed document for apis parameters, body and output format, you can go through the mail7 documents

Inbox APIs:

• getInboxByEmail(to,
• getEmailById(to, mesid)
• deleteEmailById(mesid, domain)

Params

• @param {string} to - full email address or username for example testme or [email protected]
• @param {string} mesgid - the id of particular email object
• @param {string} domain - the domain name email is created by

As mail7 support custom domain, so you can use any email like [email protected]. But you no need to pass this domain explicitly in function param as domain will be fetched from email. But make sure that your mail7 plan included the custom domain email addresses

Routing Rules APIs:

• getRoutingRules()
• createRoutingRules(data)
• deleteRoutingRules(ruleName)

Params

• @param {object} data - json object for rules need to be create
• @param {string} ruleName - rule to be delete

If only username testme is passed then it will be treated as default mail7.io domain email like [email protected]

It is suggested that pass full email address for any other domain like [email protected]

JSONP Requests ('callback'):

If you need to receive your API response wrapped inside a JSONP callback function, you can use the callback query parameter with any valid API route. The data will be returned wrapped in the callback function you specify.

The callback value can be any valid JavaScript method name.

The entire JSON API response will be delivered wrapped in the requested callback function.

Example JSONP Query

mail7.getInboxByEmail("<[email protected]>", "myCallbackFunction" ).then((response) => {
   console.log(response);
}).catch((error) => {
   console.log(error);
});

JSONP Response

myCallbackFunction({ status: 'success',
  data:
   [{ _id: '5f8ffebc0552080017029286',
       to_username: 'testmail7',
       to_domain: 'mail7.io',
       mail_source: [Object],
       is_deleted: false,
       is_read: false,
       sender_time: '2020-10-21T09:26:20.533Z' }] 
   })