ユーザーのメールボックスの設定を取得するGet user mailbox settings

名前空間: microsoft.graphNamespace: microsoft.graph

ユーザーの mailboxSettings を取得します。Get the user's mailboxSettings. すべてのメールボックス設定を表示することも、特定の設定を取得することもできます。You can view all mailbox settings, or get specific settings.

ユーザーは、Outlook クライアントを介してメールボックスに以下の設定を行うことができます。Users can set the following settings for their mailboxes through an Outlook client:

  • 自動応答 (メールの受信時にユーザーに自動的に通知)automatic replies (notify people automatically upon receipt of their email)
  • 日付の形式date format
  • delegateMeetingMessageDeliveryOptionsdelegateMeetingMessageDeliveryOptions
  • ロケール (言語および国/地域)locale (language and country/region)
  • 時刻の形式time format
  • タイム ゾーンtime zone
  • 稼働時間working hours

ユーザーは Outlook on the web を使用して、好みの日付と時刻の形式を設定できます。Users can set their preferred date and time formats using Outlook on the web. ユーザーは、サポートされている日付 (S) または時刻 (S) 形式のいずれかを選択できます。Users can choose one of the supported short date or short time formats. このGET操作は、ユーザーが選択した形式を返します。This GET operation returns the format the user has chosen.

ユーザーは、管理者がメールボックス サーバー用に設定したサポートされているタイム ゾーンから選択することにより、Outlook クライアントで好みのタイム ゾーンを設定できます。Users can set the time zone they prefer on any Outlook client, by choosing from the supported time zones that their administrator has set up for their mailbox server. 管理者は、Windows タイム ゾーン形式または Internet Assigned Numbers Authority (IANA) のタイム ゾーン (別称: Olson タイム ゾーン) 形式でタイムゾーンを設定できます。The administrator can set up time zones in the Windows time zone format or Internet Assigned Numbers Authority (IANA) time zone (also known as Olson time zone) format. 既定値は Windows 形式です。The Windows format is the default.

このGET操作は、管理者が設定した形式でユーザーの優先タイムゾーンを返します。This GET operation returns the user's preferred time zone in the format that the administrator has set up. タイム ゾーンを特定の形式 (Windows または IANA) にする場合は、最初にメールボックス設定としてその形式の優先タイム ゾーンを更新します。If you want that time zone to be in a specific format (Windows or IANA), you can first update the preferred time zone in that format as a mailbox setting. その後は、その形式でタイム ゾーンを取得できるようになります。Subsequently you will be able to get the time zone in that format. または、アプリ内で形式変換を個別に管理することもできます。Alternatively, you can manage the format conversion separately in your app.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) MailboxSettings.Read、MailboxSettings.ReadWriteMailboxSettings.Read, MailboxSettings.ReadWrite
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) MailboxSettings.Read、MailboxSettings.ReadWriteMailboxSettings.Read, MailboxSettings.ReadWrite
アプリケーションApplication MailboxSettings.Read、MailboxSettings.ReadWriteMailboxSettings.Read, MailboxSettings.ReadWrite

HTTP 要求HTTP request

ユーザーのすべてのメールボックス設定を取得する場合:To get all the mailbox settings for a user:

GET /me/mailboxSettings
GET /users/{id|userPrincipalName}/mailboxSettings

特定の設定 (自動応答の設定、ロケール、タイム ゾーン、または就業時間のみ) を取得する場合:To get specific settings - only the automatic replies settings, date format, locale, time format, time zone, or working hours:

GET /me/mailboxSettings/automaticRepliesSetting
GET /users/{id|userPrincipalName}/mailboxSettings/automaticRepliesSetting

GET /me/mailboxSettings/dateFormat
GET /users/{id|userPrincipalName}/mailboxSettings/dateFormat

GET /me/mailboxSettings/delegateMeetingMessageDeliveryOptions
GET /users/{id|userPrincipalName}/mailboxSettings/delegateMeetingMessageDeliveryOptions

GET /me/mailboxSettings/language
GET /users/{id|userPrincipalName}/mailboxSettings/language

GET /me/mailboxSettings/timeFormat
GET /users/{id|userPrincipalName}/mailboxSettings/timeFormat

GET /me/mailboxSettings/timeZone
GET /users/{id|userPrincipalName}/mailboxSettings/timeZone

GET /me/mailboxSettings/workingHours
GET /users/{id|userPrincipalName}/mailboxSettings/workingHours

オプションのクエリ パラメーターOptional query parameters

また、このメソッドは応答をカスタマイズするための一部の OData クエリ パラメーターをサポートします。This method supports some of the OData Query Parameters to help customize the response.

要求ヘッダーRequest headers

名前Name Type 説明Description
AuthorizationAuthorization stringstring ベアラー {トークン}。必須。Bearer {token}. Required.

要求本文Request body

このメソッドには、要求本文を指定しません。Do not supply a request body for this method.

応答Response

成功した場合、このメソッドは 200 OK 応答コードと、次に示す要求されたオブジェクトのいずれかを応答本文で返します。If successful, this method returns a 200 OK response code and one of the following requested objects in the response body:

Examples

例 1Example 1

要求Request

最初の例では、サインインしているユーザーのメールボックスのすべてのメールボックス設定を取得します。取得される設定には、自動応答、日付の形式、ロケール (言語と国/地域)、時刻の形式、タイム ゾーン、就業時間の設定が含まれます。The first example gets all the mailbox settings of the signed-in user's mailbox, which include settings for automatic replies, date format, locale (language and country/region), time format, time zone, and working hours.

GET https://graph.microsoft.com/v1.0/me/mailboxSettings

応答Response

応答には、サインインしたユーザーのメールボックス設定のすべてが含まれます。The response includes all the mailbox settings of the signed-in user. 注: 簡潔にするために、ここに示す応答オブジェクトは切り詰められている場合があります。Note: The response object shown here may be truncated for brevity. 実際の呼び出しではすべてのプロパティが返されます。All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Me/mailboxSettings",
    "automaticRepliesSetting": {
        "status": "Scheduled",
        "externalAudience": "All",
        "scheduledStartDateTime": {
            "dateTime": "2016-03-14T07:00:00.0000000",
            "timeZone": "UTC"
        },
        "scheduledEndDateTime": {
            "dateTime": "2016-03-28T07:00:00.0000000",
            "timeZone": "UTC"
        },
        "internalReplyMessage": "<html>\n<body>\n<p>I'm at our company's worldwide reunion and will respond to your message as soon as I return.<br>\n</p></body>\n</html>\n",
        "externalReplyMessage": "<html>\n<body>\n<p>I'm at the Contoso worldwide reunion and will respond to your message as soon as I return.<br>\n</p></body>\n</html>\n"
    },
    "timeZone":"UTC",
    "language":{
      "locale":"en-US",
      "displayName":"English (United States)"
    },
    "workingHours":{
        "daysOfWeek":[
            "monday",
            "tuesday",
            "wednesday",
            "thursday",
            "friday"
        ],
        "startTime": "08:00:00.0000000",
        "endTime": "17:00:00.0000000",
        "timeZone":{
            "name":"Pacific Standard Time"
        }
    },
    "dateFormat": "MM/dd/yyyy",
    "timeFormat": "hh:mm tt",
    "delegateMeetingMessageDeliveryOptions": "sendToDelegateOnly"
}

例 2Example 2

要求Request

2 番目の例では、サインインしているユーザーのメールボックスの自動応答設定を具体的に取得します。The second example gets specifically the automatic replies settings of the signed-in user's mailbox.

GET https://graph.microsoft.com/v1.0/me/mailboxSettings/automaticRepliesSetting

応答Response

この応答には自動とうとう設定のみが含まれます。注:簡潔にするために、ここに示す応答オブジェクトは切り詰められている場合があります。すべてのプロパティは実際の呼び出しから返されます。The response includes only the automatic replies settings. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Me/mailboxSettings/automaticRepliesSetting",
    "status": "alwaysEnabled",
    "externalAudience": "None",
    "scheduledStartDateTime": {
        "dateTime": "2016-03-19T02:00:00.0000000",
        "timeZone": "UTC"
    },
    "scheduledEndDateTime": {
        "dateTime": "2016-03-20T02:00:00.0000000",
        "timeZone": "UTC"
    },
    "internalReplyMessage": "<html>\n<body>\n<p>I'm at our company's worldwide reunion and will respond to your message as soon as I return.<br>\n</p></body>\n</html>\n",
    "externalReplyMessage": "<html>\n<body>\n<p>I'm at the Contoso worldwide reunion and will respond to your message as soon as I return.<br>\n</p></body>\n</html>\n"
}

例 3Example 3

リクエストRequest

3 番目の例では、サインインしているユーザーのメールボックスの自動応答設定を具体的に取得します。The third example gets specifically the working hour settings of the signed-in user's mailbox.

GET https://graph.microsoft.com/v1.0/me/mailboxSettings/workingHours

応答Response

この応答には、自動応答の設定のみが含まれます。The response includes only the working hours settings. ユーザーの就業時間には、カスタム タイム ゾーンが適用されていることに注意してください。Notice that the user's work hours are in a custom time zone. 注: 簡潔にするために、ここに示す応答オブジェクトは切り詰められている場合があります。Note: The response object shown here may be truncated for brevity. 実際の呼び出しではすべてのプロパティが返されます。All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#users('94447c6e-ea4c-494c-a9ed-d905e366c5cb')/mailboxSettings/workingHours",
    "daysOfWeek":[
        "monday",
        "tuesday",
        "wednesday",
        "thursday",
        "friday",
        "saturday"
    ],
    "startTime":"09:00:00.0000000",
    "endTime":"18:30:00.0000000",
    "timeZone":{
        "@odata.type":"#microsoft.graph.customTimeZone",
        "bias":-200,
        "name":"Customized Time Zone",
        "standardOffset":{
            "time":"02:00:00.0000000",
            "dayOccurrence":4,
            "dayOfWeek":"sunday",
            "month":5,
            "year":0
        },
        "daylightOffset":{
            "daylightBias":-100,
            "time":"02:00:00.0000000",
            "dayOccurrence":2,
            "dayOfWeek":"sunday",
            "month":10,
            "year":0
        }
    }
}