laikee99 / mail

send and receive mail

node-mail-client

Intro

a email client to receive and send mail
base IMAP and SMTP

Installation

npm install node-mail-client

Usage

// these methods all returned promise
// checkAuth will auto invoke and it will check smtp auth
const mailClient=require('node-mail-client')
let mail=new mailClient({
  user:`*@gmail.com`, // your address
  pass:`***`, // your password
  imap:['imap.*.com',993], // [host,port,tls]
  smtp:['smtp.*.com',587], // [host,port,secure]
  name:'Jack' // your name when send
})
// receive
mail.receive(null).then(result=>{
  // do something
}).catch(err=>{
  console.log(err)  
})
// send 
mail.send({ to, subject, text, html }).then(info=>{})
.catch(console.error)

// pass checkAuth check
mail.check=1  // 0: init  1:pass  2:fail
// send or receive

API

receive:
//@param: {string | (total:number)=>string | null} setNum
//string alike '1:10' or '1:*' 
//total is box messages total  
receive('1:*').then()
receive(total=>`1:${total-10}`).then()
receive(null).then()

send:
/*
* @param:Object
*  {
*     to: "[email protected]", // list of receivers
*     subject: "Hello", // Subject line
*     text: "Hello world? text", // plain text body
*     html: "<b>Hello world?</b>", // html body
*  }
*/

Here is an example

Documention

you could find specify about API
send
receive

Credits

node-imap
Nodemailer