# mail.tm-api [](https://github.com/XielQs/mail.tm-api "Go to GitHub repo") [](https://github.com/XielQs/mail.tm-api) [](https://github.com/XielQs/mail.tm-api) [](https://github.com/XielQs/mail.tm-api/releases/) [](#license) [](https://github.com/XielQs/mail.tm-api/issues) ⚡ A powerful library to use the Mail.TM and Mail.GW api to receive email ## Installation ```bash $ npm install mail.tm-api # Or $ yarn add mail.tm-api # Or $ pnpm add mail.tm-api # Or $ bun add mail.tm-api ``` ## Getting Started - Note: All functions are async/await ### Account #### Create Account There is a bunch of way to create an account ```javascript const MailTM = require('mail.tm-api'); const account = await MailTM.createAccount(); // Or you can specify the mail address & password const account = await MailTM.createAccount('ADDRESS', 'PASSWORD'); // Example: MailTM.createAccount('George', 'mySuperDuperPass') ``` You can create account with only domain ```js const domain = await MailTM.fetchDomains({ getRandomDomain: true }); const account = await MailTM.createAccount(domain, 'PASSWORD'); // Without password const account = await MailTM.createAccount(domain); ``` #### Login Account ```js const MailTM = require('mail.tm-api'); const account = await MailTM.loginAccount('ADDRESS@DOMAIN', 'PASSWORD'); // Login using JWT const account = await MailTM.loginAccount('TOKEN'); ``` Note: If you have a token, you can use it instead of the address & password #### Fetch Account Info ```js console.log(await account.fetch()); // { id: 'ID', address: 'ADDRESS@DOMAIN', ... } ``` #### Delete Account ```js console.log(await account.delete()); // true ``` ### Domains #### Fetch domains ```js const MailTM = require('mail.tm-api'); console.log(await MailTM.fetchDomains()); // [{ id: 'DOMAIN_ID', domain: 'DOMAIN' }] // Fetch a specific page console.log(await MailTM.fetchDomains({ page: 2 })); // [{ id: 'DOMAIN_ID', domain: 'DOMAIN' }] // Get random domain console.log(await MailTM.fetchDomains({ getRandomDomain: true })); ``` ### Configure Class ```js const MailTM = require('mail.tm-api'); MailTM.setConfig({ // Props Here }); ``` #### Available props - **mailService** _[Optional & 'mail.tm' | 'mail.gw']_ **=** 'mail.tm': Change mail service - **axiosOptions** _[Optional & Object]_ **=** {}: Axios request options ### Emails #### Get a cached email ```js console.log(account.emails.cache.get('MAIL_ID')); // { id: 'MAIL_ID', accountId: 'ACCOUNT_ID', ... } ``` Note: account.emails.cache is a Map object, you can use all Map methods #### Fetch a email ```js console.log(await account.emails.fetch('MAIL_ID')); // { id: 'MAIL_ID', accountId: 'ACCOUNT_ID', ... } // Or console.log(await account.emails.cache.get('MAIL_ID').fetch()); // { id: 'MAIL_ID', accountId: 'ACCOUNT_ID', ... } ``` #### Fetch all emails ```js console.log(await account.emails.fetchAll()); // [{ id: 'MAIL_ID', accountId: 'ACCOUNT_ID', ... }, ...] // Fetch a specific page console.log(await account.emails.fetchAll(2)); // [{ id: 'MAIL_ID', accountId: 'ACCOUNT_ID', ... }, ...] ``` #### Listen for new emails ```js account.on('newMail', email => { console.log(email); // { id: 'MAIL_ID', accountId: 'ACCOUNT_ID', ... } }); ``` #### Delete a email ```js console.log(await account.emails.cache.get('MAIL_ID').delete()); // { id: 'MAIL_ID', accountId: 'ACCOUNT_ID', ..., isDeleted: true } // Or console.log(await (await account.emails.fetch('MAIL_ID')).delete()); // { id: 'MAIL_ID', accountId: 'ACCOUNT_ID', ..., isDeleted: true } ``` #### Download a email ```js console.log(await account.emails.cache.get('MAIL_ID').download('PATH.eml')); // PATH.eml // Or console.log(await (await account.emails.fetch('MAIL_ID')).download('PATH.eml')); // PATH.eml ``` ### License Released under [MIT](/LICENSE) by [@XielQs](https://github.com/XielQs).