mailboxFolder リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
受信トレイ、下書き、その他のユーザーが作成したフォルダーなど、ユーザーのメールボックス内のフォルダーを表します。 フォルダーには、メッセージ、イベント、連絡先、その他の Outlook アイテム、子フォルダーなど、さまざまなメールボックスアイテムを含めることができます。
このリソースは 、差分 関数を提供することで、増分の追加、削除、更新を追跡するための デルタ クエリをサポートします。 また、Microsoft Graph API メタデータにまだ公開されていないカスタム データを格納およびアクセスするための単一値および複数値の拡張プロパティもサポートしています。
メソッド
| メソッド | 戻り値の種類 | 説明 |
|---|---|---|
| List | mailboxFolder コレクション | 指定したメールボックス内のすべての mailboxFolder オブジェクト (検索フォルダーを含む) を取得します。 |
| Create | mailboxFolder | ユーザーのメールボックスに新しい メールボックスFolder または子 メールボックスFolder を作成します。 |
| Get | mailboxFolder | mailboxFolder オブジェクトのプロパティとリレーションシップを読み取ります。 |
| Update | mailboxFolder | メールボックス内の displayName などの mailboxFolder プロパティを更新します。 |
| Delete | なし | メールボックスFolder またはメールボックス内の子メールボックスFolder を削除します。 |
| Get delta | mailboxFolder コレクション | ユーザーのメールボックスに追加、削除、または削除されたメールボックス フォルダー オブジェクトのセットを取得します。 |
| 子メールボックス フォルダーを一覧表示する | mailboxFolder コレクション | メールボックス内の指定した mailboxFolder の下にある mailboxFolder コレクションを取得します。 |
| フォルダー内のアイテムを一覧表示する | mailboxItem コレクション | メールボックス内の指定した mailboxFolder 内の mailboxItem コレクションを取得します。 |
| 拡張プロパティ | ||
| 単一値のプロパティを作成する | mailboxFolder | 新しいメールボックス フォルダーまたは既存のメールボックス フォルダーに 1 つ以上の単一値拡張プロパティを作成します。 |
| 単一値のプロパティを取得する | mailboxFolder |
$expandまたは$filterを使用して、単一値の拡張プロパティを含むメールボックス フォルダーを取得します。 |
| 複数値のプロパティを作成する | mailboxFolder | 新しいメールボックス フォルダーまたは既存のメールボックス フォルダーに 1 つ以上の複数値拡張プロパティを作成します。 |
| 複数値のプロパティを取得する | mailboxFolder |
$expandを使用して、複数値の拡張プロパティを含むメールボックス フォルダーを取得します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| childFolderCount | Int32 | 現在のフォルダー内の直接の子フォルダーの数。 |
| displayName | String | フォルダーの表示名です。 |
| id | String | フォルダーの一意識別子。 |
| parentFolderId | String | このフォルダーの親フォルダーの一意識別子。 |
| parentMailboxUrl | String | フォルダーが物理的に存在する実際の基になるメールボックスへのルーティング リンク。 フォルダーには、URL 全体を不透明な文字列として扱う GET {parentMailboxUrl}/folders/{id}を使用してアクセスできます。 この方法は、ユーザーのインプレース アーカイブ メールボックスに対して自動拡張アーカイブが有効になっている場合に特に重要です。 このようなシナリオでは、ユーザーのアーカイブ コンテンツが複数のメールボックスにまたがる場合があります。 |
| totalItemCount | Int32 | フォルダーに含まれるアイテムの数。 |
| type | String | フォルダー クラスの種類について説明します。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| childFolders | mailboxFolder コレクション | このフォルダー内の子フォルダーのコレクション。 |
| アイテム | mailboxItem コレクション | このフォルダー内の項目のコレクション。 |
| multiValueExtendedProperties | multiValueLegacyExtendedProperty コレクション | mailboxFolder に対して定義された複数値の拡張プロパティのコレクション。 |
| singleValueExtendedProperties | singleValueLegacyExtendedProperty コレクション | mailboxFolder に対して定義された単一値拡張プロパティのコレクション。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"@odata.type": "#microsoft.graph.mailboxFolder",
"displayName": "String",
"childFolderCount": "Int32",
"id": "String (identifier)",
"parentFolderId": "String",
"parentMailboxUrl": "String",
"totalItemCount": "Int32",
"type": "String"
}