pop3.get(options, identifier) Last updated: 16. Mar 2023

API only function

Gets / downloads a single email message from POP3 server into a variable.

Parameters

Name Type Description
options object POP3 options object with hostname, port, useSsl, username and password.
identifier string Mail identifier for message to retreive.

Returns

Message object with properties for sender, receiver, subject, body, attachments etc.

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 email with all fields
let result = pop3.get(options, identifier);

// Return message object
return result;