mailFolder リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。
受信トレイや下書きなどの、ユーザーのメールボックス内のメール フォルダーです。 メール フォルダーには、メッセージ、他の Outlook アイテム、子メール フォルダーを含めることができます。
このリソースは、デルタ関数を提供することによって、増分の追加、削除、および更新を追跡するためのデルタ クエリの使用をサポートしています。
既知のフォルダー名
Outlookは、デフォルトでユーザー用の特定のフォルダーを作成します。 対応するフォルダ id 値を使用する代わりに、便宜上、これらのフォルダにアクセスするときに、下の表にある既知のフォルダ名を使用できます。 たとえば、次のクエリで、よく知られている名前を使用して[下書き]フォルダを取得できます。
GET /me/mailFolders/drafts
既知の名前はユーザーのメールボックスのロケールに関係なく機能するため、上記のクエリでは名前の付け方にかかわらず常にユーザーの[下書き]フォルダーが返されます。
| 既知のフォルダー名 | 説明 |
|---|---|
| アーカイブ | アーカイブ フォルダーのメッセージは、対応する Outlook クライアントで One_Click アーカイブ機能を使用するときに送信されます。 注意: これはExchange Onlineのアーカイブメールボックス機能と同じではありません。 |
| 低優先メール | [Clutter]機能を使用すると、clutterフォルダに優先順位の低いメッセージがに移動されます。 |
| 競合 | メールボックス内で競合するアイテムが含まれているフォルダ。 |
| conversationhistory | SkypeがIM会話を保存するフォルダ（Skypeがそうするように設定されている場合）。 |
| deleteditems | フォルダ項目は、削除されたときに移動されます。 |
| 下書き | 未送信メッセージが含まれているフォルダ。 |
| inbox | 受信トレイ フォルダー。 |
| junkemail | [迷惑メール] フォルダー。 |
| localfailures | ローカルクライアントに存在するがサーバーにアップロードできなかったアイテムを含むフォルダ。 |
| msgfolderroot | "Top of Information Store" フォルダ。 このフォルダは、受信トレイなど、通常のメールクライアントに表示されるフォルダの親フォルダです。 |
| 送信トレイ | 送信トレイ フォルダー。 |
| recoverableitemsdeletions | ソフト削除されたアイテムを含むフォルダ：[削除済みアイテム]フォルダから削除するか、OutlookでShift + Deleteキーを押して削除したアイテム。 このフォルダはどのOutlook電子メールクライアントにも表示されませんが、エンドユーザーはOutlookまたはWeb上のOutlookの サーバーから削除済みアイテムを回復 機能を使用して操作できます。 |
| スケジュール済み | iOS用Outlookのスケジュール機能を使用して受信トレイに再表示されるようにスケジュールされているメッセージを含むフォルダ。 |
| searchfolders | ユーザーのメールボックスに定義されているすべての検索フォルダーの親フォルダー。 |
| sentitems | 送信済みアイテム フォルダー。 |
| serverfailures | サーバー上に存在するがローカルクライアントと同期できなかったアイテムを含むフォルダー。 |
| syncissues | Outlookによって作成された同期ログを含むフォルダー。 |
メソッド
| メソッド | 戻り値の型 | Description |
|---|---|---|
| mailFolders を一覧表示する | mailFolder コレクション | 指定したユーザーのメールボックス内のすべてのメール フォルダー (メール検索フォルダーを含む) を取得します。 |
| mailFolder の取得 | mailFolder | mailFolder オブジェクトのプロパティとリレーションシップを読み取ります。 |
| Create mailFolder | mailFolder | ユーザーのメールボックスのルート フォルダーに新しいメール フォルダーを作成します。 |
| childFolders を一覧表示する | mailFolder コレクション | 指定したフォルダーの下のフォルダーのコレクションを取得します。.../me/MailFolders ショートカットを使用して、最上位フォルダーのコレクションを取得して、別のフォルダーに移動することができます。 |
| create childFolder | mailFolder | childFolders コレクションへの投稿により、現在の mailFolder 下に新しい mailFolder を作成します。 |
| メッセージの作成 | メッセージ | メッセージ コレクションへの投稿により、現在の mailFolder に新しいメッセージを作成します。 |
| List messages | message コレクション | サインインしているユーザーのメールボックス内のすべてのメッセージや、メールボックス内の指定したフォルダー内のメッセージを取得します。 |
| 更新する | mailFolder | 指定した mailFolder オブジェクトを更新します。 |
| 削除 | なし | 指定した mailFolder オブジェクトを削除します。 |
| コピー | mailFolder | mailFolder とその内容を別の mailFolder にコピーします。 |
| delta | mailFolder コレクション | ユーザーのメールボックスで追加または削除された一連のメール フォルダーを取得します。 |
| move | mailFolder | mailFolder とその内容を別の mailFolder に移動します。 |
| 拡張プロパティ | ||
| 単一値の拡張プロパティを作成する | mailFolder | 新規または既存の mailFolder に、1 つ以上の単一値の拡張プロパティを作成します。 |
| 単一値の拡張プロパティを持つ mailFolder の取得 | mailFolder | $expand または $filter を使用して、単一値の拡張プロパティを含む mailFolder を取得します。 |
| 複数値の拡張プロパティを作成する | mailFolder | 新規または既存の mailFolder の 1 つ以上の複数値の拡張プロパティを作成します。 |
| 複数値の拡張プロパティを持つ mailFolder の取得 | mailFolder | $expand を使用して、複数値の拡張プロパティを含む mailFolder を取得します。 |
プロパティ
| プロパティ | 種類 | 説明 |
|---|---|---|
| childFolderCount | Int32 | 現在の mailFolder の直下の子 mailFolder の数。 |
| displayName | String | mailFolder の表示名。 |
| id | 文字列 | mailFolder の一意識別子。 |
| isHidden | ブール型 | mailFolder が非表示かどうかを示します。 このプロパティは、フォルダーを作成するときにのみ設定できます。 詳細については、「非表示のメール フォルダー」を参照してください。 |
| parentFolderId | String | mailFolder の親 mailFolder の一意識別子。 |
| totalItemCount | Int32 | mailFolder に含まれるアイテムの数 |
| unreadItemCount | Int32 | mailFolder 内で未読としてマークされているアイテムの数。 |
| wellKnownName | String | フォルダーの既知のフォルダー名。 指定できる値は上記の一覧です。 このプロパティは、ユーザーが作成した既定のフォルダー Outlook。 他のフォルダーの場合、このプロパティは null です。 |
アイテム数を効率的に取得する
フォルダーの TotalItemCountプロパティと UnreadItemCount プロパティを使用すると、ファイル内の既読アイテム数を簡単に算出できます。
大幅な待ち時間を招く可能性がある次のようなクエリを避けることができます。
https://outlook.office.com/api/beta/me/folders/inbox/messages?$count=true&$filter=isread%20eq%20false
Outlookのメールフォルダには複数の種類のアイテムを含めることができます。たとえば、受信トレイにはメールアイテムとは異なる会議出席依頼アイテムを含めることができます。 TotalItemCount と UnreadItemCount には、アイテムの種類に関係なく、フォルダー内のアイテム全てが含まれます。
非表示のメール フォルダー
プロパティの既定値は isHidden です false 。 mailFolder を作成する場合は、isHidden を 1 回だけ設定できます。 PATCH 操作を使用してプロパティを更新することはできません。 フォルダーの isHidden プロパティを変更するには、既存のフォルダーを削除し、目的の値を持つ新しいフォルダーを作成します。
非表示のメール フォルダーは、通常のメール フォルダーでサポートされているすべての操作をサポートします。
既定では 、mailFolders の一覧は 非表示ではないメール フォルダーのみを返します。 応答に非表示のメール フォルダーを含めるには、query パラメーターを使用します includeHiddenFolders=true 。 次に 、isHidden プロパティを使用して、メール フォルダーが非表示かどうかを識別します。
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| childFolders | MailFolder コレクション | mailFolder 内の子フォルダーのコレクション。 |
| messageRules | messageRule コレクション | ユーザーの受信トレイ フォルダーに適用されるルールのコレクション。 |
| messages | Message コレクション | mailFolder 内のメッセージのコレクション。 |
| multiValueExtendedProperties | multiValueLegacyExtendedProperty collection | mailFolder に対して定義された、複数値の拡張プロパティのコレクション。読み取り専用。Null 許容型。 |
| singleValueExtendedProperties | singleValueLegacyExtendedProperty collection | mailFolder に対して定義された、単一値の拡張プロパティのコレクションです。読み取り専用。Null 許容型。 |
JSON 表記
リソースの JSON 表記を次に示します。
{
"childFolderCount": 1024,
"displayName": "string",
"id": "string (identifier)",
"parentFolderId": "string",
"totalItemCount": 1024,
"unreadItemCount": 1024,
"wellKnownName": "string",
"isHidden": false,
"childFolders": [ { "@odata.type": "microsoft.graph.mailFolder" } ],
"messageRules": [ { "@odata.type": "microsoft.graph.messageRule" } ],
"messages": [ { "@odata.type": "microsoft.graph.message" } ],
"multiValueExtendedProperties": [ { "@odata.type": "microsoft.graph.multiValueLegacyExtendedProperty" }],
"singleValueExtendedProperties": [ { "@odata.type": "microsoft.graph.singleValueLegacyExtendedProperty" }]
}
関連項目
フィードバック
フィードバックの送信と表示