Calendar

Configures calendar settings including iCalendar limits and default names.

This object can be configured from the WebUI under Settings › Calendar & Contacts › Calendar

Fields

defaultDisplayName

Type: String? · default: "Stalwart Calendar"

Specifies the default display name for a calendar when it is created

defaultHrefName

Type: String? · default: "default"

Specifies the default href name for a calendar when it is created

maxAttendees

Type: UnsignedInt · default: 20 · max: 100000

Specifies the maximum number of attendees that can be included in a single iCalendar instance

maxRecurrenceExpansions

Type: UnsignedInt · default: 3000

Specifies the maximum number of instances that can be generated from a recurring iCalendar event

maxICalendarSize

Type: Size · default: 524288

Specifies the maximum size of an iCalendar file that can be uploaded to the server

maxCalendars

Type: UnsignedInt? · default: 250 · min: 1

The default maximum number of calendars a user can create

maxEvents

Type: UnsignedInt? · min: 1

The default maximum number of calendar events a user can create

maxParticipantIdentities

Type: UnsignedInt? · default: 100 · min: 1

The default maximum number of participant identities a user can create

maxEventNotifications

Type: UnsignedInt? · min: 1

The default maximum number of notifications a user can create for calendar events

maxCalendarsPerEvent

Type: UnsignedInt · default: 10 · min: 1

Maximum number of calendars a single calendar event can belong to

maxExpandedQueryDuration

Type: Duration · default: 31536000000

Maximum time span between the after and before arguments of a calendar event query that expands recurrences

maxAvailabilityDuration

Type: Duration · default: 31536000000

Maximum time span that can be requested when querying the availability (free/busy) of a principal

availabilityRateLimit

Type: Rate? · default: {"count":100,"period":60000}

Maximum rate at which an account can query principal availability

maxAttachmentsSize

Type: Size · default: 5242880

Maximum total size of the attachments embedded in a single calendar event

JMAP API

The Calendar singleton is available via the urn:stalwart:jmap capability.

x:Calendar/get

This is a standard Foo/get method as defined in RFC 8620, Section 5.1.

For singletons, the ids argument should be the literal singleton (or null to return the single instance).

This method requires the sysCalendarGet permission.

curl -X POST https://mail.example.com/jmap/ \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:Calendar/get",
          {
            "ids": [
              "singleton"
            ]
          },
          "c1"
        ]
      ],
      "using": [
        "urn:ietf:params:jmap:core",
        "urn:stalwart:jmap"
      ]
    }'

x:Calendar/set

This is a standard Foo/set method as defined in RFC 8620, Section 5.3.

For singletons, only the update argument with id singleton is accepted; create and destroy arguments are rejected.

This method requires the sysCalendarUpdate permission.

curl -X POST https://mail.example.com/jmap/ \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:Calendar/set",
          {
            "update": {
              "singleton": {
                "defaultDisplayName": "updated value"
              }
            }
          },
          "c1"
        ]
      ],
      "using": [
        "urn:ietf:params:jmap:core",
        "urn:stalwart:jmap"
      ]
    }'

CLI

stalwart-cli wraps the same JMAP calls. See the CLI reference for installation, authentication, and general usage.

Fetch

stalwart-cli get Calendar

Update

stalwart-cli update Calendar --field defaultDisplayName='updated value'

Nested types

Rate

Defines a rate limit as a count over a time period.

count

Type: UnsignedInt · default: 0 · min: 1 · max: 1000000

Count

period

Type: Duration · default: 0 · min: 1

Period