CalendarScheduling

CalendarScheduling

Configures calendar scheduling, iTIP messaging, and HTTP RSVP settings.

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

Fields

enable

Type: Boolean · default: true

Enables the scheduling features for calendar events, allowing users to send and receive invitations

httpRsvpEnable

Type: Boolean · default: true

Enables the HTTP RSVP feature for calendar invitations, allowing users to respond via a web interface.

httpRsvpLinkExpiry

Type: Duration · default: "90d"

Sets the expiration duration for HTTP RSVP links, after which they will no longer be valid.

httpRsvpUrl

Type: Uri?

Specifies a custom URL for the HTTP RSVP endpoint, where users can respond to calendar invitations.

autoAddInvitations

Type: Boolean · default: false

Automatically adds incoming invitations to the user’s calendar.

itipMaxSize

Type: Size · default: "512kb" · min: 100

Sets the maximum iCalendar object size for incoming iTIP messages.

maxRecipients

Type: UnsignedInt · default: 100 · min: 1

Sets the maximum number of recipients for outbound iTIP messages.

emailTemplate

Type: Html? · enterprise

Specifies the HTML template used for rendering iMIP invitations.

httpRsvpTemplate

Type: Html? · enterprise

Specifies the HTML template used for rendering HTTP RSVP confirmations.

JMAP API

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

x:CalendarScheduling/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 sysCalendarSchedulingGet permission.

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

x:CalendarScheduling/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 sysCalendarSchedulingUpdate permission.

curl -X POST https://mail.example.com/api \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:CalendarScheduling/set",
          {
            "update": {
              "singleton": {
                "enable": true
              }
            }
          },
          "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 CalendarScheduling

Update

stalwart-cli update CalendarScheduling --field enable=true