node-pop3

pop3 command for node. Supports Promise and stream.

CLI

e.g. Test the API about TOP

pop -u example@gmail.com -p pwd -h example.pop.com -m TOP 100 10

or pass in some or all of the config in a designated config file (JSON or JS):

pop -c pop.config.js -m TOP 100 10

For more detail, please input

pop --help

Usage

In CommonJS, you can get the Pop3Command as follows:

const Pop3Command = require('node-pop3');

The examples below, however, use the ESM Modules format instead (i.e., import).

Example

• Fetch mail by msgNum:

import Pop3Command from 'node-pop3';

const pop3 = new Pop3Command({
  user: 'example@example.com',
  password: 'example',
  host: 'pop3.example.com',
});

const msgNum = 1;

(async () => {

  await string = pop3.RETR(msgNum);
  // deal with mail string
  await pop3.QUIT();

})();

• List msgNum to uid in Server

const list = await pop3.UIDL();
console.dir(list);
/**
 * [
 *  ['1', 'ZC0113-H8wi_YChVab4F0QTbwP4B6i'],
 *  ['2', 'ZC0114-3A9gAn8M2Sp1RhVCGTIII6i'],
 *  ...
 * ]
*/

API

• constructor(options)

tlsOptions takes the options documented for your Node version and tls.connect function.

• basic

const pop3 = new Pop3Command({ host: 'pop3.example.com' });

(async () => {

  await pop3.connect();
  await pop3.command('USER', 'example@example.com');
  await pop3.command('PASS', 'example');

  const [info] = await pop3.command('STAT');
  console.log(info); // 100 102400

  const [info, stream] = await pop3.command('RETR', 1);
  console.log(info); // 1024 octets

  const [info] = await pop3.command('QUIT');
  console.log(info); // Bye

})();

• common

ERROR

pop3 will throw new Error's with an error message from Server. Beyond that, Error may have two properties attached by pop3.

To-dos

1. Testing:
   1. Ensure tests seed (and then delete) messages (e.g., using emailjs)
   2. Set up CI with hidden pop.config.json credentials
   3. Avoid skipping some tests
2. Edge cases
   1. After timeout, ensure any stream is ended (so other commands can continue)
   2. Ensure command will reject if socket is ended.
   3. Ensure in fixing the above that can QUIT and reuse same instance