{"_id":"@dchicchon/mail-listener","_rev":"2-06d4cb5d3a7205041aaa64d354ce59ed","name":"@dchicchon/mail-listener","dist-tags":{"latest":"2.0.6"},"versions":{"2.0.4":{"name":"@dchicchon/mail-listener","version":"2.0.4","description":"Mail listener library","dependencies":{"async":"^2.6.2","imap":"^0.8.19","mailparser":"^3.2.0"},"repository":{"type":"git","url":"git+https://github.com/dchicchon/mail-listener.git"},"homepage":"https://github.com/dchicchon/mail-listener","keywords":["mail","imap","email"],"author":{"name":"Vijayakumar"},"contributors":[{"name":"dchicchon"}],"license":"MIT","bugs":{"url":"https://github.com/dchicchon/mail-listener/issues"},"main":"index.js","scripts":{"test":"test.js"},"devDependencies":{},"gitHead":"15c0f5bf109fd9ae7b59a5499d1f07c19fe1f8f3","_id":"@dchicchon/mail-listener@2.0.4","_nodeVersion":"16.13.0","_npmVersion":"8.19.0","dist":{"integrity":"sha512-ciq0po+ipsWWo9CcGyVN8UUp4vsz6R8vekbCLT8Q11/73RH4f5VU7qhGkXcF90d2n8UiQp99ZE/qbVJNxY7Ryg==","shasum":"41ca44c3d4bad94de5a263866632768a9053bad5","tarball":"https://registry.npmjs.org/@dchicchon/mail-listener/-/mail-listener-2.0.4.tgz","fileCount":5,"unpackedSize":14043,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDPNZfvDD1YkfOd8n22oAZJ3a5Hsk73qZ/Pecps+ni/uAiAA+wR52lW1XEREFrT8Zs0mPI79dmADhT75/XshD++5GA=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjEOSfACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmry+Q//XbRBkrwC+oNkDoI3HPYvJttDuq5uBAB2s5LFH/B03KKgELNV\r\nNnYvi7HUGRKj422T+/hUuzcVYJkx2FeKhJhVthFBr4DYnAdG5fBbtM1aKypp\r\nxJywitdozWgX8pCnkqozB6jfVgTQWkYjjhFpoDYE8F2Utg26dhScNo22mbMx\r\nxe/qKcIuIfND+oXt0tyTzRJaSjmROefG5MtbPnL1ClBiDMNIbJrnsIeNWGPZ\r\nn0F1YZfxs7rjw2ikf602Z9BfceqGpidud05KwqMmykyRPd74K3iWQKoFchFY\r\np7q3VA4NaF+e3tXebOI5a8/IbLPSsVBjAVBz2RBmOFEeQNe+1HhbLe1kpLub\r\n0LZZyejQJMJxzq3E/+N+rwpgF+FIH3AsW7PzbrKET+XxBIvKbuBt2dtE9A9B\r\nGNUFH31ZfB3DYs9GjtOIXPijIgMtWNo27JhxHQOpCT96IMZ5OvgJPZh/oh1B\r\nWFLEkXNvx4+fz8qj+/aZn1dKue1LCDUMiijkIViSzsMyRpC0KI++fE4pVeOI\r\nSo9Gd0Og1PrJo5pvCLxBovCY3+00VwdQSakLHRT4P+LtgHS87Klhuy7BjDGA\r\nZFo8cGjAKYcsVfQESyTcvR3Z72GgiwnbPCIeqoH5oIK58wSqmaQRIEIhqx90\r\nq8aVS88/gXOrsVIgptCY64r8rwA1qDtd76Y=\r\n=cwSh\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"dchicchon","email":"danielchicchon@gmail.com"},"directories":{},"maintainers":[{"name":"dchicchon","email":"danielchicchon@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mail-listener_2.0.4_1662051487315_0.3823119888190425"},"_hasShrinkwrap":false},"2.0.5":{"name":"@dchicchon/mail-listener","version":"2.0.5","description":"Mail listener library","dependencies":{"async":"^2.6.2","imap":"^0.8.19","mailparser":"^3.2.0"},"repository":{"type":"git","url":"git+https://github.com/dchicchon/mail-listener.git"},"homepage":"https://github.com/dchicchon/mail-listener","keywords":["mail","imap","email"],"author":{"name":"Vijayakumar"},"contributors":[{"name":"dchicchon"}],"license":"MIT","bugs":{"url":"https://github.com/dchicchon/mail-listener/issues"},"main":"index.js","scripts":{"test":"test.js"},"devDependencies":{},"gitHead":"b98bdf0d19090c27220266508455e8c8d8a1d4d4","_id":"@dchicchon/mail-listener@2.0.5","_nodeVersion":"16.13.0","_npmVersion":"8.19.0","dist":{"integrity":"sha512-5cV+Gpbyg96rsSQ0RVnIpsOQOPa3fzEVXxSeNsI6GjOl8TkLFL/gUPyiCQSqiIlU3q3Eo0DuwKl4QOgR+nRo3w==","shasum":"39d65cf87ba5f5a683459bfc78d568b25579ed93","tarball":"https://registry.npmjs.org/@dchicchon/mail-listener/-/mail-listener-2.0.5.tgz","fileCount":5,"unpackedSize":14039,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCPopCsUEA3/cmiCQeHTj6bjEOjA64P+t87v2XfXxw2agIgJCja9Q7YZ73abvhewyqgcEqVfge98lHEDCtFoJFw3CU="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjF3fCACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqLog//V4ubr6LZkKX7khBzPsumQTIsl85BAdRxUp7Vpvqtk5KS+Bff\r\nRL9fQ6UaN/dmFbDtanL2L2+jfDvRnI/MgavH6Ia1npzDo7P86Xh06LDlTReO\r\nA3b76KY4tujbX06bq35hHGi7CxJCzbBByBIB84vh29IFBq3TOYcrTG3dkv+I\r\n9PnsImfq0JhD9Doc9DhZY8poHyFBgz3HOeGoO+BzTAXRGUGvTXR/zhaLkyvO\r\n5o1tskkdqoIxXiI8yT3GkDo+dJle7ItFZ6mmBB+mdzX8YAKtnjZBV7MUz3vA\r\n2E0qYPb3IZhPjqN12njETv+VM2m+0NeqksumDlDmdi+OwxlWPzJYrAwSzVW9\r\nP0OhjXGKWLuekyRBerp5JZ20gNuFXUfQSQ0w/7wd4aA7xpbMlemE1HHKBaAL\r\nbM5J3TzmiprFNxmYl24M0m+ei5+hQBn1X7sgUU+O5QmZxDrST5a7qTMo0xG4\r\nMIAmh7mOEUYKcbUdGeixrIYiNM9RENdSZELuLXvDnKeeBpQnaDMEVBigefhT\r\nUYbnmbnbI1itIDuZfBb8bEAcUrTRcUCpnAkOQeNt8Ffm3rWWIKXCD5XbWC/p\r\nBBnHp6PxDR+ONsf3Og5+8oPUohctbqCoGi8mFtMpEKFl7QVM0N7AOluGVpcO\r\nTaNSjlo8PbY8C8EoDZNF4C1eR5G6RYokHqU=\r\n=KGzR\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"dchicchon","email":"danielchicchon@gmail.com"},"directories":{},"maintainers":[{"name":"dchicchon","email":"danielchicchon@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mail-listener_2.0.5_1662482370302_0.9951311835547187"},"_hasShrinkwrap":false},"2.0.6":{"name":"@dchicchon/mail-listener","version":"2.0.6","description":"Mail listener library","dependencies":{"async":"^2.6.2","imap":"^0.8.19","mailparser":"^3.2.0"},"repository":{"type":"git","url":"git+https://github.com/dchicchon/mail-listener.git"},"homepage":"https://github.com/dchicchon/mail-listener","keywords":["mail","imap","email"],"author":{"name":"Vijayakumar"},"contributors":[{"name":"dchicchon"}],"license":"MIT","bugs":{"url":"https://github.com/dchicchon/mail-listener/issues"},"main":"index.js","scripts":{"test":"test.js"},"devDependencies":{},"gitHead":"05341e0e051040fee51d67fdef278ea41bf351c5","_id":"@dchicchon/mail-listener@2.0.6","_nodeVersion":"16.13.0","_npmVersion":"8.19.0","dist":{"integrity":"sha512-k8/vXEyQdo1xuDDNlX5kYjKsFH8euCs/au8lVC4xYFaVb5K+XYmoApRHF777AsNhQl8mSLVQLEG9zMl4pr7lCw==","shasum":"9d6116e196f3f4b0ca5d55e35b5a336a2295aff2","tarball":"https://registry.npmjs.org/@dchicchon/mail-listener/-/mail-listener-2.0.6.tgz","fileCount":5,"unpackedSize":10845,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDXAKgEgq57Yk5BROzwQHJfhijgUihhrkGpLct18gIZpAIgRCaGwbbUdByBzaeG8hVMM5gaU0DbUMZGU/vG1gVWzgw="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjGky7ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmq5QBAAiRRXQPc13B3f/ci/cQ1w0ssAHnUYUAueMAHqMha2feg7qiDE\r\nyuUFIswEH0lnt8lWJlWxqyuWspTkdX36G8qpodlLQrGwhSGiY+xTvByCuzgq\r\nq5obi2Ccrd4BrfkAdGf4zmRluXjsT/Joa1fID2zjvwOZb3i5hPiPLR2VCQs0\r\nwCyR5/DEi3c7/tfg+4bTZFZJMqB9AR2MohRLDQy7v0r4cNhimKNg0a07vnrT\r\nWj/B28Vxx1M8BePgWzn4q1X2amcSfceuXXR6/NzKYmCB762xdMfjJpPuFJmk\r\nBR5RObtF6vHJRWtbctTIW/1t+noQTJWiRiO3SPSBjwv0/nQ4hunzABoUELon\r\nj3TE7vhmMJl0UnGSg/GDkgULVPK0jAQ3fnbmPc5tvFOy9qQwGJ0U4/wiivJg\r\n+0Vho1h+12dxbu83Zz+hvLEMvaS3mqI1pJRLZ7IjGk/qADu2rMt4X1zbI7WW\r\ncEFNYhbVFoL1ubtLrnZrL2LPNH2YU+Sek/wzYSNf2dcpWsjvnb6pwreSYElN\r\nfAHbSSQh3O8d1Fdz0g7Vfuw+f+150JsE4tqkYSWV2nBrNvbMcAhUc5EyxfEh\r\npxfhx6Gnm7Pgvmi7WFnSRAS6ZmTxE7UFkwXPPKDqK+w0BEkB+ISVmyD/tQvH\r\n+cWEETWO8dUzXDJJ6uRuAHOWhpVe+En4zsM=\r\n=i8TQ\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"dchicchon","email":"danielchicchon@gmail.com"},"directories":{},"maintainers":[{"name":"dchicchon","email":"danielchicchon@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mail-listener_2.0.6_1662667963133_0.6415104421794073"},"_hasShrinkwrap":false}},"time":{"created":"2022-09-01T16:58:07.207Z","2.0.4":"2022-09-01T16:58:07.471Z","modified":"2022-09-08T20:12:43.385Z","2.0.5":"2022-09-06T16:39:30.478Z","2.0.6":"2022-09-08T20:12:43.291Z"},"maintainers":[{"name":"dchicchon","email":"danielchicchon@gmail.com"}],"description":"Mail listener library","homepage":"https://github.com/dchicchon/mail-listener","keywords":["mail","imap","email"],"repository":{"type":"git","url":"git+https://github.com/dchicchon/mail-listener.git"},"contributors":[{"name":"dchicchon"}],"author":{"name":"Vijayakumar"},"bugs":{"url":"https://github.com/dchicchon/mail-listener/issues"},"license":"MIT","readme":"# Overview\r\n\r\nMail-listener library for node.js. Get notifications when new email arrived to inbox or when message metadata (e.g. flags) changes externally. Uses IMAP protocol.\r\n\r\nThis dependency is forked from https://www.npmjs.com/package/mail-listener6 in order to add improvements. Please refer to the original npm package for details.\r\n\r\n## Use\r\n\r\nInstall\r\n\r\n`npm install @dchicchon/mail-listener`\r\n\r\n\r\nJavaScript Code:\r\n\r\n\r\n```javascript\r\n\r\nvar { MailListener } = require(\"mail-listener\");   // NOTE: A FUTURE VERSION (release date TBA) will not require ES6 destructuring or referring to the class after the require statement (i.e. require('mail-listener6').MailListener). At this stage, this is necessary because index.js exports the MailListener class as a property of module.exports.\r\n\r\nvar mailListener = new MailListener({\r\n  username: \"imap-username\",\r\n  password: \"imap-password\",\r\n  host: \"imap-host\",\r\n  port: 993, // imap port\r\n  tls: true,\r\n  connTimeout: 10000, // Default by node-imap\r\n  authTimeout: 5000, // Default by node-imap,\r\n  debug: console.log, // Or your custom function with only one incoming argument. Default: null\r\n  tlsOptions: { rejectUnauthorized: false },\r\n  mailbox: \"INBOX\", // mailbox to monitor\r\n  searchFilter: [\"ALL\"], // the search filter being used after an IDLE notification has been retrieved\r\n  markSeen: true, // all fetched email willbe marked as seen and not fetched next time\r\n  fetchUnreadOnStart: true, // use it only if you want to get all unread email on lib start. Default is `false`,\r\n  attachments: true, // download attachments as they are encountered to the project directory\r\n  attachmentOptions: { directory: \"attachments/\" } // specify a download directory for attachments\r\n});\r\n\r\nmailListener.start(); // start listening\r\n\r\n// stop listening\r\n//mailListener.stop();\r\n\r\nmailListener.on(\"server:connected\", function(){\r\n  console.log(\"imapConnected\");\r\n});\r\n\r\nmailListener.on(\"mailbox\", function(mailbox){\r\n  console.log(\"Total number of mails: \", mailbox.messages.total); // this field in mailbox gives the total number of emails\r\n});\r\n\r\nmailListener.on(\"server:disconnected\", function(){\r\n  console.log(\"imapDisconnected\");\r\n});\r\n\r\nmailListener.on(\"error\", function(err){\r\n  console.log(err);\r\n});\r\n\r\nmailListener.on(\"headers\", function(headers, seqno){\r\n  // do something with mail headers\r\n});\r\n\r\nmailListener.on(\"body\", function(body, seqno){\r\n  // do something with mail body\r\n})\r\n\r\nmailListener.on(\"attachment\", function(attachment, path, seqno){\r\n  // do something with attachment\r\n});\r\n\r\nmailListener.on(\"mail\", function(mail, seqno) {\r\n  // do something with the whole email as a single object\r\n})\r\n\r\n// it's possible to access imap object from node-imap library for performing additional actions. E.x.\r\nmailListener.imap.move(:msguids, :mailboxes, function(){})\r\n\r\n```\r\n\r\n## Attachments\r\nAttachments in this version are buffered. This feature is based on how [mailparser](https://github.com/andris9/mailparser#attachments)'s simpleParser function handles attachments.\r\nSetting `attachments: true` will download attachments as buffer objects by default to the project directory.\r\nA specific download directory may be specified by setting `attachmentOptions: { directory: \"attachments/\"}`.\r\nThe `\"attachment\"` event will be fired every time an attachment is encountered.\r\n\r\n## License\r\n\r\nMIT\r\n","readmeFilename":"readme.md"}