名前空間: microsoft.graph
受信トレイ、下書き、その他のユーザーが作成したフォルダーなど、ユーザーのメールボックス内のフォルダーを表します。 フォルダーには、メッセージ、イベント、連絡先、その他の Outlook アイテム、子フォルダーなど、さまざまなメールボックス アイテムを含めることができます。
このリソースは、デルタ関数を提供することで、増分の追加、削除、更新を追跡するためのデルタ クエリをサポートしています。 また、Microsoft Graph API メタデータでまだ公開されていないカスタム データを格納してアクセスするための単一値および複数値の拡張プロパティもサポートされています。
メソッド
| メソッド | 戻り値の種類 | 説明 |
|---|---|---|
| List | mailboxFolder コレクション | 指定したメールボックス内のすべての mailboxFolder オブジェクト (検索フォルダーを含む) を取得します。 |
| Create | mailboxFolder | ユーザーのメールボックスに新しい mailboxFolder または子 mailboxFolder を作成します。 |
| Get | mailboxFolder | mailboxFolder オブジェクトのプロパティとリレーションシップを読み取ります。 |
| Update | mailboxFolder | メールボックス内の displayName などの mailboxFolder プロパティを更新します。 |
| Delete | なし | メール ボックス内の mailboxFolder または子 mailboxFolder を削除します。 |
| Get delta | mailboxFolder コレクション | ユーザーのメールボックスに追加、削除、または削除された mailboxFolder オブジェクトのセットを取得します。 |
| 子メールボックス フォルダーを一覧表示する | mailboxFolder コレクション | メールボックス内の指定された mailboxFolder の下にある mailboxFolder コレクションを取得します。 |
| フォルダー内のアイテムを一覧表示する | mailboxItem コレクション | メールボックス内の指定された mailboxFolder 内の mailboxItem コレクションを取得します。 |
| フォルダー内のアイテムを削除する | なし | メールボックスの mailboxFolder から mailboxItem を削除します。 |
| 拡張プロパティ | ||
| 単一値のプロパティを作成する | mailboxFolder | 新規または既存のメールボックス フォルダーに 1 つ以上の単一値の拡張プロパティを作成します。 |
| 単一値のプロパティを取得する | mailboxFolder |
$expand または $filter を使用して、単一値の拡張プロパティを含むメールボックス フォルダーを取得します。 |
| 複数値のプロパティを作成する | mailboxFolder | 新規または既存のメールボックス フォルダーに 1 つ以上の複数値の拡張プロパティを作成します。 |
| 複数値のプロパティを取得する | mailboxFolder |
$expand を使用して、複数値の拡張プロパティを含むメールボックス フォルダーを取得します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| childFolderCount | Int32 | 現在のフォルダー内の直接の子フォルダーの数。 |
| displayName | 文字列 | フォルダーの表示名です。 |
| id | 文字列 | フォルダーの一意の識別子。 |
| parentFolderId | String | このフォルダーの親フォルダーを示す一意の識別子。 |
| totalItemCount | Int32 | フォルダーに含まれるアイテムの数。 |
| type | String | フォルダー クラスの種類を記述します。 |
| wellKnownName | 文字列 | Outlook によって作成されたフォルダーのロケールに依存しない既知の名前 ( inbox、 sentitems、 drafts、 deleteditems、 archive など)。 ユーザーが作成したフォルダーの場合、値は null です。 読み取り専用です。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| 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",
"totalItemCount": "Int32",
"wellKnownName": "String",
"type": "String"
}