Skip to main content

Sessions

A session represents the stateful interaction between the client and the server. It maintains the state of a user's actions and can be used to handle user requests more efficiently. When a client connects to the JMAP server, a new session is initiated. This session contains necessary details like account details, permissions, disk quotas, etc.

Session cache​

The session cache is a memory data structure that stores active session data for efficient access and usage. The following attributes can be configured for the session cache under the jmap.session.cache section:

  • ttl: The "Time To Live" setting for the session cache. This determines how long a session will stay alive in the cache without being accessed before it is considered expired and thus subject to removal.
  • size: This setting defines the maximum number of sessions that can be stored in the cache at any given time. If the maximum size is reached, older, less-recently-used sessions may be evicted to make room for new ones.

For example:

[jmap.session.cache]
ttl = "1h"
size = 100

Session purging​

Stalwart Mail Server runs periodically an automated task for purging expired sessions. A session is considered expired when it has not been accessed for a certain period of time, known as its Time-To-Live (TTL). When a session exceeds its TTL without being accessed, Stalwart identifies it as "expired". The cleanup task runs at a configurable interval, and during each run, it identifies and deletes these expired sessions, freeing up memory and reducing clutter in the system.

The schedule for this task can be configured in the jmap.purge.schedule.sessions section using a simplified cron-like syntax:

<minute> <hour> <week-day>

Where:

  • <minute>: minute to run the job, an integer ranging from 0 to 59.
  • <hour>: hour to run the job, an integer ranging from 0 to 23.
  • <week-day>: day of the week to run the job, ranging from 1 (Monday) to 7 (Sunday) or * to run the job every day.

All values have to be specified using the server's local time. For example, to run the job every hour at 15 minutes past the hour:

[jmap.purge.schedule]
sessions = "15 * *"