rbv_api.openIMAP()

Purpose

Opens connection to an external email server (such as Gmail) using IMAP protocol. It must be called once before reading data from IMAP server.

Syntax

rbv_api.openIMAP(hostName, port, userName, password, mailProps)

Parameters

hostName

The name of the external mail server.

port

The port number for an SSL connection on the external mail server (typically 993).

userName

The user's name (typically user's email address) on the external mail server.

password

The user's password on the external mail server.

mailProps

The optional array of properties to be set on the external mail server. This may be null.

Return value

None

Example

rbv_api.openIMAP("imap.gmail.com", 993, "address@gmail.com", password, null);