✨ Track IMAP connection state #416
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Because a `#connection_state` attribute will be added, I'd like to consistently name the connection states everywhere they are used.
Tracking connection state can have many uses. But in this version,
we're only tracking the session state and exposing a `#connection_state`
attribute reader.
For forward-compatibility, the only documented methods on the connection
state objects are (currently) `#name` and `#to_sym`, which will return
one of `not_authenticated`, `authenticated`, `selected`, or `logout`.
From RFC9051:
```
+----------------------+
|connection established|
+----------------------+
||
\/
+--------------------------------------+
| server greeting |
+--------------------------------------+
|| (1) || (2) || (3)
\/ || ||
+-----------------+ || ||
|Not Authenticated| || ||
+-----------------+ || ||
|| (7) || (4) || ||
|| \/ \/ ||
|| +----------------+ ||
|| | Authenticated |<=++ ||
|| +----------------+ || ||
|| || (7) || (5) || (6) ||
|| || \/ || ||
|| || +--------+ || ||
|| || |Selected|==++ ||
|| || +--------+ ||
|| || || (7) ||
\/ \/ \/ \/
+--------------------------------------+
| Logout |
+--------------------------------------+
||
\/
+-------------------------------+
|both sides close the connection|
+-------------------------------+
```
> Legend for the above diagram:
>
> (1) connection without pre-authentication (OK greeting)
> (2) pre-authenticated connection (PREAUTH greeting)
> (3) rejected connection (BYE greeting)
> (4) successful LOGIN or AUTHENTICATE command
> (5) successful SELECT or EXAMINE command
> (6) CLOSE or UNSELECT command, unsolicited CLOSED response code, or
> failed SELECT or EXAMINE command
> (7) LOGOUT command, server shutdown, or connection closed
Before the server greeting, the state is `not_authenticated`.
After the connection closes, the state remains `logout`.
This was referenced Apr 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Tracking IMAP connection state has many uses. But in this PR, we're only tracking the session state and exposing a
#connection_stateattribute reader.For forward-compatibility, the only documented methods on the connection state objects are (currently)
#nameand#to_sym, which will return one ofnot_authenticated,authenticated,selected, orlogout.From RFC9051:
Before the server greeting, the state is
not_authenticated.After the connection closes, the state remains
logout.