open connection

This block is part of the imap group and was last modified in core v15.0.1.

open connection condition v15.0.1

Opens an IMAP connection to a mailbox server. Nothing is read until another imap block runs; with verify on, the block signs in once and reports the result on success so a flow can branch before it polls.

In pins 7 + flow

flow
flow
host required
value
Hostname or IP of the IMAP server, e.g. imap.example.com.
port
number
TCP port. 993 for implicit TLS, 143 for STARTTLS.
Default 993
username required
value
Sign-in name : usually the full address.
password required
value
Password or app password. Stored on the connection and never logged.
security
value
tls (default, port 993), starttls (port 143), or none for an unencrypted connection (loopback / private addresses only). • Suggestions: tls starttls none
Default tls
timeout seconds
number
Dial and per-command timeout, in seconds.
Default 30
verify
condition
When on, sign in once and report the result on success. Off by default : opening a connection otherwise makes no network call.
Default false

Out pins 3 + flow

flow
flow
success
condition
error
value
connection
imapconnection

Builds an IMAP connection object from host/port/credentials and outputs it on the connection pin; every other imapconnection_* block takes it and opens its own short session (dial, sign in, work, logout). security: 'tls' (default, implicit TLS on port 993), 'starttls' (plain port 143 upgraded with STARTTLS, and the upgrade is REQUIRED), or 'none' (unencrypted; a password is refused for any host that is not loopback or a private address). verify=false (the default) makes NO network call : it only assembles the object, so success is true whenever host is set. verify=true signs in and logs out once and reports reachability plus authentication on success/error. The connection carries the password and must never be logged or written to a document. In a simulation the verify probe is skipped and no packet leaves the node.

imap

mailbox

inbox

mail server

A typical wiring for open connection: a function trigger starts the flow; value feeds the host pin; value feeds the username pin; value feeds the password pin; the flow out pin feeds debug.

Version history

Introduced in v15.0.1.

Back to imap Return to the main group to view all sub-groups Back to imap Return to the group to view all blocks within this group