MailFolder を作成する

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

この API を使用して、ユーザーのメールボックスのルート フォルダーに新しいメール フォルダーを作成します。

新しいフォルダを非表示にする場合は、 作成時に isHidden プロパティを [ true ] に設定する必要があります。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ✅ ✅ ✅

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。 アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類 アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント) Mail.ReadWrite
委任 (個人用 Microsoft アカウント) Mail.ReadWrite
アプリケーション Mail.ReadWrite

HTTP 要求

POST /me/mailFolders
POST /users/{id | userPrincipalName}/mailFolders

要求ヘッダー

ヘッダー 値
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json

要求本文

要求本文で、次のパラメーターを含む JSON オブジェクトを指定します。 displayName と isHidden は、 mailFolder オブジェクトの唯一の書き込み可能なプロパティです。

パラメーター 型 説明
displayName String 新しいフォルダーの表示名です。
IsHidden ブール値 新しいフォルダーが非表示になっているかどうかを示します。 既定値は false です。 このプロパティの設定は省略可能です。 一度設定すると、このプロパティを更新することはできません。 詳細については、「非表示のメール フォルダー」を参照してください

応答

成功した場合、このメソッド 201 Created 応答コードと応答本文の mailFolder オブジェクトを返します。

例

要求

次の例は要求を示しています。

POST https://graph.microsoft.com/beta/me/mailFolders
Content-type: application/json

{
  "displayName": "Clutter",
  "isHidden": true
}

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 201 Created
Content-type: application/json

{
  "id": "hN2Y5OGRhNGYwODEALgAAA0DAKbvJvFhJgcT3lZpkhNQBAA1",
  "displayName": "Clutter",
  "parentFolderId": "AQMkADlmOGQwZmU3LWVjOWMtNDhiYgAtODcxNy1",
  "childFolderCount": 99,
  "unreadItemCount": 99,
  "totalItemCount": 99,
  "wellKnownName": null,
  "isHidden": true
}