pop3.pop(options) Last updated: 16. Mar 2023

API only function

Retreives a list of mails in inbox ready for download from server.

Parameters

Name Type Description
options object POP3 options object with hostname, port, useSsl, username and password.

Returns

A list of emails.

Example

Code example (JS)

JS is normal JavaScript either running in the browser or on the Docly™ server.
// Configure options
let options = {
    "hostname" : "serverhost",
    "port" : 110,
    "useSsl" : false,
    "username" : "login",
    "password" : "pass"
};

// Retreive list of mail in inbox
let list = pop3.pop(options);

// Return content
return list;

/*
    Each item with the following properties:
    - Number
    - Identifier
    - Size
*/