Skip to main content

ImapFlowOptions

Properties

NameTypeAttributesDefaultDescription
hoststringHostname of the IMAP server
portnumberPort number of the IMAP server
secureboolean<optional>falseShould the connection be established over TLS. If false then connection is upgraded to TLS using STARTTLS extension before authentication
authImapFlowAuthAuthentication options. Authentication is requested automatically during start()
servernamestring<optional>Servername for SNI (or when host is set to an IP address)
disableCompressionboolean<optional>falseIf true then client does not try to use COMPRESS=DEFLATE extension
clientInfoIdInfoObject<optional>Client identification infos
disableAutoIdleboolean<optional>falseIf true then IDLE is not started automatically. Useful if you only need to perform specific tasks over the connection
tlsImapFlowTls<optional>Additional TLS options (see Node.js TLS connect for all available options)
loggerImapFlowLogger false<optional>Custom logger instance or false
logRawboolean<optional>falseIf true then log data read from and written to socket encoded in base64
emitLogsboolean<optional>falseIf true then in addition of sending data to logger, ImapFlow emits 'log' events with the same data
verifyOnlyboolean<optional>falseIf true then logs out automatically after successful authentication
proxystring<optional>Optional proxy URL. Supports HTTP CONNECT (http://, https://) and SOCKS (socks://, socks4://, socks5://) proxies
qresyncboolean<optional>falseIf true, then enables QRESYNC support. EXPUNGE notifications will include uid property instead of seq
maxIdleTimenumber<optional>If set, then breaks and restarts IDLE every maxIdleTime ms
disableBinaryboolean<optional>falseIf true, then ignores the BINARY extension when making FETCH and APPEND calls
disableAutoEnableboolean<optional>Do not enable supported extensions by default