host | string | | | Hostname of the IMAP server |
port | number | | | Port number of the IMAP server |
secure | boolean | <optional> | false | Should the connection be established over TLS. If false then connection is upgraded to TLS using STARTTLS extension before authentication |
auth | ImapFlowAuth | | | Authentication options. Authentication is requested automatically during start() |
servername | string | <optional> | | Servername for SNI (or when host is set to an IP address) |
disableCompression | boolean | <optional> | false | If true then client does not try to use COMPRESS=DEFLATE extension |
clientInfo | IdInfoObject | <optional> | | Client identification infos |
disableAutoIdle | boolean | <optional> | false | If true then IDLE is not started automatically. Useful if you only need to perform specific tasks over the connection |
tls | ImapFlowTls | <optional> | | Additional TLS options (see Node.js TLS connect for all available options) |
logger | ImapFlowLogger false | <optional> | | Custom logger instance or false |
logRaw | boolean | <optional> | false | If true then log data read from and written to socket encoded in base64 |
emitLogs | boolean | <optional> | false | If true then in addition of sending data to logger, ImapFlow emits 'log' events with the same data |
verifyOnly | boolean | <optional> | false | If true then logs out automatically after successful authentication |
proxy | string | <optional> | | Optional proxy URL. Supports HTTP CONNECT (http:// , https:// ) and SOCKS (socks:// , socks4:// , socks5:// ) proxies |
qresync | boolean | <optional> | false | If true , then enables QRESYNC support. EXPUNGE notifications will include uid property instead of seq |
maxIdleTime | number | <optional> | | If set, then breaks and restarts IDLE every maxIdleTime ms |
disableBinary | boolean | <optional> | false | If true , then ignores the BINARY extension when making FETCH and APPEND calls |
disableAutoEnable | boolean | <optional> | | Do not enable supported extensions by default |