mailFolder リソースの種類mailFolder resource type

重要

Microsoft Graph の/betaバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでは、これらの API の使用はサポートされていません。Use of these APIs in production applications is not supported.

受信トレイや下書きなどの、ユーザーのメールボックス内のメール フォルダーです。A mail folder in a user's mailbox, such as Inbox and Drafts. メール フォルダーには、メッセージ、他の Outlook アイテム、子メール フォルダーを含めることができます。Mail folders can contain messages, other Outlook items, and child mail folders.

このリソースでは、デルタ関数を用意すれば、増分の追加、削除、更新にデルタ クエリを使用できます。This resource supports using delta query to track incremental additions, deletions, and updates, by providing a delta function.

既知のフォルダー名Well-known folder names

Outlook では、既定でユーザー用の特定のフォルダーを作成します。Outlook creates certain folders for users by default. このようなフォルダーにアクセスする場合は、対応するフォルダー id値を使用する代わりに、以下の表にある、既知のフォルダー名を使用することもできます。Instead of using the corresponding folder id value, for convenience, you can use the well-known folder names from the table below when accessing these folders. たとえば、次のクエリを使用して、既知の名前を使用して [下書き] フォルダーを取得できます。For example, you can get the Drafts folder using its well-known name with the following query.

GET /me/mailFolders/drafts

既知の名前は、ユーザーのメールボックスのロケールに関係なく動作するので、上記のクエリは、名前の指定に関係なく、常にユーザーの [下書き] フォルダーを返します。Well-known names work regardless of the locale of the user's mailbox, so the above query will always return the user's Drafts folder regardless of how it is named.

既知のフォルダー名Well-known folder name 説明Description
archive アーカイブフォルダーのメッセージは、それをサポートする Outlook クライアントで One_Click アーカイブ機能を使用するときに送信されます。The archive folder messages are sent to when using the One_Click Archive feature in Outlook clients that support it. 注: これは、Exchange online のアーカイブメールボックス機能と同じではありません。Note: this is not the same as the Archive Mailbox feature of Exchange online.
整頓clutter 低優先メール機能フォルダー低優先度のメッセージは、低優先メール機能を使用している場合に移動されます。The clutter folder low-priority messages are moved to when using the Clutter feature.
解消conflicts メールボックス内の競合するアイテムを含むフォルダー。The folder that contains conflicting items in the mailbox.
conversationhistoryconversationhistory skype が IM 会話を保存するフォルダー (skype が設定されている場合)。The folder where Skype saves IM conversations (if Skype is configured to do so).
deleteditemsdeleteditems フォルダーアイテムは、削除されたときに移動されます。The folder items are moved to when they are deleted.
未公開drafts 未送信メッセージを含むフォルダー。The folder that contains unsent messages.
ボックスinbox 受信トレイフォルダー。The inbox folder.
junkemailjunkemail 迷惑メールフォルダー。The junk email folder.
localfailureslocalfailures ローカルクライアント上に存在するが、サーバーにアップロードできないアイテムを含むフォルダー。The folder that contains items that exist on the local client but could not be uploaded to the server.
msgfolderrootmsgfolderroot "インフォメーションストアのトップ" フォルダーThe "Top of Information Store" folder. このフォルダーは、受信トレイなど、通常のメールクライアントに表示されるフォルダーの親フォルダーです。This folder is the parent folder for folders that are displayed in normal mail clients, such as the inbox.
送信トレイoutbox 送信トレイフォルダー。The outbox folder.
recoverableitemsdeletionsrecoverableitemsdeletions 削除済みアイテムフォルダーから削除された、または Outlook で shift + del キーを押して削除されたアイテムを含むフォルダー。The folder that contains soft-deleted items: deleted either from the Deleted Items folder, or by pressing shift+delete in Outlook. このフォルダーは、outlook 電子メールクライアントでは表示されませんが、エンドユーザーは、outlook または web 上の outlook の [サーバーからの削除済みアイテムを復元する] 機能を使用して操作できます。This folder is not visible in any Outlook email client, but end users can interact with it through the Recover Deleted Items from Server feature in Outlook or Outlook on the web.
スケジュール済みscheduled iOS 版 Outlook のスケジュール機能を使用して、受信トレイに再表示するようにスケジュールされたメッセージを含むフォルダー。The folder that contains messages that are scheduled to reappear in the inbox using the Schedule feature in Outlook for iOS.
searchfolderssearchfolders ユーザーのメールボックスに定義されているすべての検索フォルダーの親フォルダーです。The parent folder for all search folders defined in the user's mailbox.
sentitemssentitems 送信済みアイテムフォルダー。The sent items folder.
serverfailuresserverfailures サーバー上に存在するが、ローカルクライアントに同期できなかったアイテムを含むフォルダー。The folder that contains items that exist on the server but could not be synchronized to the local client.
syncissues 問題syncissues Outlook によって作成された同期ログが格納されているフォルダー。The folder that contains synchronization logs created by Outlook.

メソッドMethods

メソッドMethod 戻り値の型Return Type 説明Description
mailFolder の取得Get mailFolder mailFoldermailFolder mailFolder オブジェクトのプロパティとリレーションシップを読み取ります。Read properties and relationships of mailFolder object.
MailFolder の作成Create MailFolder mailFoldermailFolder childFolders コレクションへの投稿により、現在の mailFolder 下に新しい mailFolder を作成します。Create a new mailFolder under the current one by posting to the childFolders collection.
childFolders を一覧表示するList childFolders mailFolder コレクションmailFolder collection 指定したフォルダーの下のフォルダー コレクションを取得します。.../me/MailFolders ショートカットを使用すると、最上位フォルダーのコレクションを取得して、別のフォルダーに移動することができます。Get the folder collection under the specified folder. You can use the .../me/MailFolders shortcut to get the top-level folder collection and navigate to another folder.
メッセージの作成Create Message messagemessage メッセージ コレクションへの投稿により、現在の mailFolder に新しいメッセージを作成します。Create a new message in the current mailFolder by posting to the messages collection.
List messagesList messages message コレクションmessage collection サインインしているユーザーのメールボックス内のすべてのメッセージや、メールボックス内の指定したフォルダー内のメッセージを取得します。Get all the messages in the signed-in user's mailbox, or those messages in a specified folder in the mailbox.
更新するUpdate mailFoldermailFolder 指定した mailFolder オブジェクトを更新します。Update the specified mailFolder object.
削除Delete なしNone 指定した mailFolder オブジェクトを削除します。Delete the specified mailFolder object.
コピーcopy mailFoldermailFolder mailFolder とその内容を別の mailFolder にコピーします。Copy a mailFolder and its contents to another mailFolder.
deltadelta mailFolder コレクションmailFolder collection ユーザーのメールボックスで追加または削除された一連のメール フォルダーを取得します。Get a set of mail folders that have been added, deleted, or removed from the user's mailbox.
movemove mailFoldermailFolder mailFolder とその内容を別の mailFolder に移動します。Move a mailFolder and its contents to another mailFolder.
拡張プロパティExtended properties
単一値の拡張プロパティを作成するCreate single-value extended property mailFoldermailFolder 新規または既存の mailFolder に、1 つ以上の単一値の拡張プロパティを作成します。Create one or more single-value extended properties in a new or existing mailFolder.
単一値の拡張プロパティを持つ mailFolder の取得Get mailFolder with single-value extended property mailFoldermailFolder $expand または $filter を使用して、単一値の拡張プロパティを含む mailFolder を取得します。Get mailFolders that contain a single-value extended property by using $expand or $filter.
複数値の拡張プロパティを作成するCreate multi-value extended property mailFoldermailFolder 新規または既存の mailFolder の 1 つ以上の複数値の拡張プロパティを作成します。Create one or more multi-value extended properties in a new or existing mailFolder.
複数値の拡張プロパティを持つ mailFolder の取得Get mailFolder with multi-value extended property mailFoldermailFolder $expand を使用して、複数値の拡張プロパティを含む mailFolder を取得します。Get a mailFolder that contains a multi-value extended property by using $expand.

プロパティProperties

プロパティProperty Type 説明Description
childFolderCountchildFolderCount Int32Int32 現在の mailFolder の直下の子 mailFolder の数。The number of immediate child mailFolders in the current mailFolder.
displayNamedisplayName 文字列String mailFolder の表示名。The mailFolder's display name.
idid StringString mailfolder の一意の識別子。The mailFolder's unique identifier.
parentFolderIdparentFolderId StringString mailFolder の親 mailFolder の一意識別子。The unique identifier for the mailFolder's parent mailFolder.
totalItemCounttotalItemCount Int32Int32 mailFolder に含まれるアイテムの数The number of items in the mailFolder.
unreadItemCountunreadItemCount Int32Int32 mailFolder 内で未読としてマークされているアイテムの数。The number of items in the mailFolder marked as unread.
wellKnownNamewellKnownName StringString フォルダーの既知のフォルダー名。The well-known folder name for the folder. 指定できる値は、上記のとおりです。The possible values are listed above. このプロパティは、Outlook によって作成された既定のフォルダーに対してのみ設定されます。This property is only set for default folders created by Outlook. その他のフォルダーの場合、このプロパティはnullになります。For other folders, this property is null.

アイテム数の効率的な取得Access item counts efficiently

フォルダー TotalItemCountUnreadItemCountプロパティとプロパティを使用すると、フォルダー内の閲覧アイテムの数を簡単に計算できます。The TotalItemCount and UnreadItemCount properties of a folder allow you to conveniently compute the number of read items in the folder. これにより、大幅な遅延が発生する可能性がある次のようなクエリを回避できます。They let you avoid queries like the following that can incur significant latency:

https://outlook.office.com/api/beta/me/folders/inbox/messages?$count=true&$filter=isread%20eq%20false

Outlook のメールフォルダーには、複数の種類のアイテムを含めることができます。たとえば、受信トレイには、メールアイテムとは異なる会議出席依頼アイテムを含めることができます。Mail folders in Outlook can contain more than one type of items, for example, the Inbox can contain meeting request items which are distinct from mail items. TotalItemCountアイテムUnreadItemCountの種類に関係なく、メールフォルダーにアイテムを追加します。TotalItemCount and UnreadItemCount include items in a mail folder irrespective of their item types.

リレーションシップRelationships

リレーションシップRelationship Type 説明Description
childFolderschildFolders MailFolder コレクションMailFolder collection mailFolder 内の子フォルダーのコレクション。The collection of child folders in the mailFolder.
messageRulesmessageRules messageRule コレクションmessageRule collection ユーザーの受信トレイ フォルダーに適用されるルールのコレクション。The collection of rules that apply to the user's Inbox folder.
messagesmessages Message collectionMessage collection mailFolder 内のメッセージのコレクション。The collection of messages in the mailFolder.
multiValueExtendedPropertiesmultiValueExtendedProperties multiValueLegacyExtendedProperty コレクションmultiValueLegacyExtendedProperty collection mailFolder に対して定義された、複数値の拡張プロパティのコレクション。読み取り専用。Null 許容型。The collection of multi-value extended properties defined for the mailFolder. Read-only. Nullable.
singleValueExtendedPropertiessingleValueExtendedProperties singleValueLegacyExtendedProperty コレクションsingleValueLegacyExtendedProperty collection mailFolder に対して定義された、単一値の拡張プロパティのコレクションです。読み取り専用。Null 許容型。The collection of single-value extended properties defined for the mailFolder. Read-only. Nullable.

JSON 表記JSON representation

リソースの JSON 表記を次に示します。The following is a JSON representation of the resource.

{
  "childFolderCount": 1024,
  "displayName": "string",
  "id": "string (identifier)",
  "parentFolderId": "string",
  "totalItemCount": 1024,
  "unreadItemCount": 1024,
  "wellKnownName": "string",
  "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" }]
}

関連項目See also