mailboxSettings resource type

Namespace: microsoft.graph


APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Settings for the primary mailbox of a user.

You can get or update a user's mailbox settings by querying the user's mailboxSettings property.


Property Type Description
archiveFolder string Folder ID of an archive folder for the user. Read-only.
automaticRepliesSetting automaticRepliesSetting Configuration settings to automatically notify the sender of an incoming email with a message from the signed-in user.
dateFormat string The date format for the user's mailbox.
delegateMeetingMessageDeliveryOptions delegateMeetingMessageDeliveryOptions If the user has a calendar delegate, this specifies whether the delegate, mailbox owner, or both receive meeting messages and meeting responses. Possible values are: sendToDelegateAndInformationToPrincipal, sendToDelegateAndPrincipal, sendToDelegateOnly. The default is sendToDelegateOnly.
language localeInfo The locale information for the user, including the preferred language and country/region.
timeFormat string The time format for the user's mailbox.
timeZone string The default time zone for the user's mailbox.
userPurpose userPurpose The purpose of the mailbox. Differentiates a mailbox for a single user from a shared mailbox and equipment mailbox in Exchange Online. Possible values are: user, linked, shared, room, equipment, others, unknownFutureValue. Read-only.
workingHours workingHours The days of the week and hours in a specific time zone that the user works.

userPurpose values

Member Description
user A user account with a mailbox in the local forest.
linked A mailbox linked to a user account in another forest.
shared A mailbox shared by two or more user accounts.
room A mailbox that represents a conference room.
equipment A mailbox that represents a piece of equipment.
others A mailbox was found but the user purpose is different from the ones specified in the previous scenarios.
unknownFutureValue Evolvable enumeration sentinel value. Do not use.

JSON representation

The following JSON representation shows the resource type.

  "archiveFolder": "string",
  "automaticRepliesSetting": {"@odata.type": "microsoft.graph.automaticRepliesSetting"},
  "dateFormat": "string",
  "delegateMeetingMessageDeliveryOptions": "String",
  "language": {"@odata.type": "microsoft.graph.localeInfo"},
  "timeFormat": "string",
  "timeZone": "string",
  "userPurpose": "String",
  "workingHours": {"@odata.type": "microsoft.graph.workingHours"}