email

Provides methods for working with email via IMAP.

init

Set email connection details.

Parameters:

Name

Type

Description

user

String

Username (e.g. 'your@email.address').

password

String

Password.

host

String

Host name (e.g. 'imap.gmail.com').

port

Number

Port number (e.g. 993).

tls

Boolean

true to use TLS, false otherwise.

authTimeout

Number

Authentication timeout in milliseconds.

getLastEmail

Retrieves last unseen email.

Usage example:

email.init('[YOUR_EMAIL]@gmail.com', 'password', 'imap.gmail.com', 993, true, 3000);
var mail = email.getLastEmail(60, 'email subject', 5000);
log.info(JSON.stringify(mail, null, 2));

Parameters:

Name

Type

Description

sinceMinutes

Number

Search for emails received since the specified amount of minutes into past.

subject

String|Regex

Return email matching the specified subject.

timeout

String

Timeout (in milliseconds) for waiting for the message to arrive.

Returns:

Object - Email body and TO, FROM, SUBJECT, DATE headers.