メッセージ リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。
メールボックス フォルダー内のメッセージです。
Exchange Online メールボックスから送信される 1 つの電子メール メッセージのための toRecipients、ccRecipients、および bccRecipients プロパティに含まれる受信者の最大合計数は 500 です。詳細については、送信制限を参照してください。
このリソースは以下をサポートしています。
- カスタム インターネット メッセージ ヘッダーとして独自のデータを追加します。 メッセージの作成時にのみカスタム ヘッダーを追加し、ヘッダーに "x-" で始まる名前を付けます。 メッセージが送信された後ではヘッダーを変更することはできません。 メッセージのヘッダーを取得するには、get message パラメーターで
$selectクエリ パラメーターを適用します。 - 拡張機能として、カスタム プロパティに独自のデータを追加します。
- 変更通知を受信します。
- デルタ関数を提供することにより、デルタ クエリを使用して、増分の追加、削除、更新を追跡します。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| List messages | message コレクション | サインイン中のユーザーのメールボックス内のすべてのメッセージを取得します (削除済みアイテムと低優先メール フォルダーを含む)。 |
| メッセージの作成 | message | 新しいメッセージの下書きを作成します。 |
| メッセージの取得 | message | message オブジェクトのプロパティとリレーションシップを読み取ります。 |
| 更新する | message | メッセージ オブジェクトを更新します。 |
| 削除 | なし | メッセージ オブジェクトを削除します。 |
| コピー | Message | メッセージをフォルダーにコピーします。 |
| createForward | Message | 1 回の createForward 呼び出しで下書きの転送メッセージを作成して、コメントを含めるかメッセージのプロパティを更新します。その後、下書きを 更新 または 送信 できます。 |
| createReply | Message | 1 回の createReply 呼び出しで下書きの返信メッセージを作成して、コメントを含めるかメッセージのプロパティを更新します。その後、下書きを 更新 または 送信 できます。 |
| createReplyAll | Message | 1 回の createReplyAll 呼び出しで下書きの全員に返信メッセージを作成して、コメントを含めるかメッセージのプロパティを更新します。その後、下書きを 更新 または 送信 できます。 |
| delta | message コレクション | 指定したフォルダーで追加、削除、更新されたメッセージのセットを取得します。 |
| forward | なし | 1 回の forward 呼び出しでメッセージを転送、コメントを追加、または更新可能なプロパティを変更します。その後、メッセージは [送信済みアイテム] フォルダーに保存されます。 |
| move | Message | メッセージをフォルダーに移動します。これにより、宛先フォルダーにメッセージの新しいコピーが作成されます。 |
| 返信 | なし | 1 回の reply 呼び出しでメッセージ送信者に返信、コメントを追加、または更新可能なプロパティを変更します。その後、メッセージは [送信済みアイテム] フォルダーに保存されます。 |
| replyAll | なし | コメントを指定して、返信の更新可能なプロパティを変更することによってメッセージ受信者全員に返信し、全員に replyAll メソッドを使用します。その後、メッセージは [送信済みアイテム] フォルダーに保存されます。 |
| send | なし | 以前に作成したメッセージの下書きを送信します。その後、メッセージは送信済みアイテム フォルダーに保存されます。 |
| unsubscribe | なし | List-Unsubscribe ヘッダー内の最初の mailto コマンドで指定されたデータとアドレスを使用して、メッセージを送信します。 |
| Attachments | ||
| 添付ファイルを一覧表示する | Attachment コレクション | メッセージのすべての添付ファイルを取得します。 |
| 添付ファイルを追加する | Attachment | 添付ファイル コレクションへの投稿により、メッセージに新しい添付ファイルを追加します。 |
| オープン拡張機能 | ||
| オープン拡張機能を作成する | openTypeExtension | オープン拡張機能を作成し、新規または既存のリソースにカスタム プロパティを追加します。 |
| オープン拡張機能を取得する | openTypeExtension コレクション | 拡張機能の名前で識別されるオープン拡張機能を取得します。 |
| スキーマ拡張機能 | ||
| スキーマ拡張機能の値を追加する | スキーマ拡張機能の定義を作成し、それを使用してカスタマイズされた種類のデータをリソースに追加します。 | |
| 拡張プロパティ | ||
| 単一値の拡張プロパティを作成する | message | 新規または既存のメッセージに、1 つ以上の単一値の拡張プロパティを作成します。 |
| 単一値の拡張プロパティを持つメッセージの取得 | message | $expand または $filter を使用して、単一値の拡張プロパティを含むメッセージを取得します。 |
| 複数値の拡張プロパティを作成する | message | 新規または既存のメッセージに、1 つ以上の複数値の拡張プロパティを作成します。 |
| 複数値の拡張プロパティを持つメッセージの取得 | message | $expand を使用して、複数値の拡張プロパティを含むメッセージを取得します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| bccRecipients | recipient collection | メッセージの BCC 受信者。 |
| body | itemBody | メッセージの本文。 HTML 形式またはテキスト形式にできます。 メッセージ本文での安全な HTML に関する情報を参照してください。 |
| bodyPreview | String | メッセージ本文の最初の 255 文字。 テキスト形式です。 メッセージに mention のインスタンスが含まれている場合、このプロパティには連結されたこれらの mention も含まれています。 |
| categories | String collection | メッセージに関連付けられているカテゴリ。各カテゴリは、ユーザーに対して定義されている outlookCategory の displayName プロパティに対応します。 |
| ccRecipients | recipient collection | メッセージの CC 受信者。 |
| changeKey | String | メッセージのバージョン。 |
| conversationId | String | 電子メールが属している会話の ID。 |
| conversationIndex | Edm.Binary | 会話内のメッセージの位置を示します。 |
| createdDateTime | DateTimeOffset | メッセージが作成された日時。 日付と時刻の情報は ISO 8601 形式を使って表され、常にUTC時間です。たとえば、2014 年 1 月 1 日の午前 0 時の UTC は 2014-01-01T00:00:00Z です。 |
| flag | followUpFlag | メッセージのステータス、開始日、期限、または完了日を示すフラグ値。 |
| from | recipient | メッセージの送信元のメールボックスの所有者。 ほとんどの場合、この値は sender プロパティと同じです。ただし、共有または委任のシナリオは除きます。 この値は、実際に使用されているメールボックスに対応している必要があります。 メッセージのfrom プロパティと sender プロパティの設定に関する詳細情報を参照してください。 |
| hasAttachments | ブール値 | メッセージに添付ファイルがあるかどうかを示します。このプロパティにはインライン添付ファイルが含まれていません。このためメッセージにインライン添付ファイルのみが含まれている場合、このプロパティは false です。インライン添付ファイルが存在するかどうかを確認するには、body プロパティを解析して <IMG src="cid:image001.jpg@01D26CD8.6C05F070"> などの src 属性を探します。 |
| id | String | メッセージの一意識別子。 既定では、この値は、アイテムをあるコンテナー (フォルダーや予定表など) から別のコンテナーに移動したときに変更されます。 この動作を変更するには、Prefer: IdType="ImmutableId" ヘッダーを使用します。 詳細については「Outlook リソースの不変識別子を取得する」を参照してください。 読み取り専用です。 |
| importance | importance | メッセージの重要度です。 使用可能な値は low、normal、および high です。 |
| inferenceClassification | inferenceClassificationType | 推定される関連性や重要性、または明示的なオーバーライドに基づく、ユーザーのメッセージの分類。使用可能な値は、focused または other です。 |
| internetMessageHeaders | internetMessageHeader コレクション | RFC5322 で定義されている一連のメッセージ ヘッダーです。 これには、メッセージが辿った送信者から受信者へのネットワーク パスを示すメッセージ ヘッダーが含まれています。 また、メッセージのアプリ データを保持するカスタム メッセージ ヘッダーも含めることができます。 $select クエリ オプションを適用した場合にのみ返されます。読み取り専用です。 |
| internetMessageId | String | RFC5322 によって指定された形式のメッセージ ID。isDraft が true の場合にのみ更新可能です。 |
| isDeliveryReceiptRequested | Boolean | メッセージの開封確認メッセージが要求されているかどうかを示します。 |
| isDraft | Boolean | メッセージが下書きかどうかを示します。メッセージがまだ送信されていなければ下書きです。 |
| isRead | Boolean | メッセージが開封されたかどうかを示します。 |
| isReadReceiptRequested | Boolean | メッセージの開封確認メッセージが要求されているかどうかを示します。 |
| lastModifiedDateTime | DateTimeOffset | メッセージが最後に変更された日時。 日付と時刻の情報は ISO 8601 形式を使って表され、常にUTC時間です。たとえば、2014 年 1 月 1 日の午前 0 時の UTC は 2014-01-01T00:00:00Z です。 |
| mentionsPreview | mentionsPreview | メッセージのメンションに関する情報。GET /メッセージ要求を処理するときに、サーバーはこのプロパティを設定して、既定で応答に含めます。メッセージにメンションがない場合、サーバーは null を返します。省略可能。 |
| parentFolderId | String | メッセージの親 mailFolder の一意識別子。 |
| receivedDateTime | DateTimeOffset | メッセージが受信された日時です。 日付と時刻の情報は ISO 8601 形式を使って表され、常にUTC時間です。たとえば、2014 年 1 月 1 日の午前 0 時の UTC は 2014-01-01T00:00:00Z です。 |
| replyTo | recipient collection | 返信時に使用される電子メール アドレス。 |
| sender | recipient | メッセージを生成するために実際に使用されるアカウント。 ほとんどの場合、この値は from プロパティと同じです。 共有メールボックスからメッセージを送信するとき、共有予定表用に、または代理人としてこのプロパティを別の値に設定できます。 いずれの場合でも、この値は、実際に使用されているメールボックスに対応している必要があります。 メッセージのfrom プロパティと sender プロパティの設定に関する詳細情報を参照してください。 |
| sentDateTime | DateTimeOffset | メッセージが送信された日時。 日付と時刻の情報は ISO 8601 形式を使って表され、常にUTC時間です。たとえば、2014 年 1 月 1 日の午前 0 時の UTC は 2014-01-01T00:00:00Z です。 |
| subject | String | メッセージの件名。 |
| toRecipients | recipient collection | メッセージの宛先。 |
| uniqueBody | itemBody | 現在のメッセージに一意であるメッセージの本文の一部。uniqueBody は、既定で返されませんが、特定のメッセージのために ?$select=uniqueBody クエリを使用して取得することができます。HTML 形式またはテキスト形式にできます。 |
| unsubscribeData | String | List-Unsubscribe ヘッダーに基づいて解析された有効なエントリ。UnsubscribeEnabled プロパティが true の場合、これは List-Unsubscribe ヘッダー内の mail コマンドのデータです。 |
| unsubscribeEnabled | Boolean | メッセージが登録解除に対して有効になっているかどうかを示します。list-Unsubscribe ヘッダーが rfc-2369 に準拠している場合、その値は True です。 |
| webLink | String | Outlook on the web でメッセージを開く URL。 URL の末尾に ispopout 引数を付加して、メッセージの表示方法を変更できます。ispopout が存在しない、または 1 に設定されている場合は、メッセージがポップアウト ウィンドウに表示されます。ispopout が 0 に設定されている場合、ブラウザーの Outlook on the web レビュー ウィンドウにメッセージが表示されます。 Outlook on the web のメールボックスにログインしている場合、ブラウザーでメッセージが開きます。まだブラウザーでログインしていない場合、ログインするように求められます。 この URL には、iFrame 内からアクセスできません。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| attachments | Attachment コレクション | メッセージの fileAttachment 添付ファイルと itemAttachment 添付ファイル。 |
| extensions | Extension コレクション | メッセージに対して定義されているオープン拡張機能のコレクションです。Null 許容型。 |
| mentions | mention コレクション | メッセージのメンションのコレクション。createdDateTime で最新の日付順になっています。既定では、プロパティで を適用しない限り、 /メッセージはこのプロパティを返しません。 |
| multiValueExtendedProperties | multiValueLegacyExtendedProperty コレクション | メッセージに対して定義された、複数値の拡張プロパティのコレクション。Null 許容型。 |
| singleValueExtendedProperties | singleValueLegacyExtendedProperty コレクション | メッセージに対して定義された、単一値の拡張プロパティのコレクションです。Null 許容型。 |
JSON 表記
リソースの JSON 表記を次に示します
{
"bccRecipients": [{"@odata.type": "microsoft.graph.recipient"}],
"body": {"@odata.type": "microsoft.graph.itemBody"},
"bodyPreview": "string",
"categories": ["string"],
"ccRecipients": [{"@odata.type": "microsoft.graph.recipient"}],
"changeKey": "string",
"conversationId": "string",
"conversationIndex": "String (binary)",
"createdDateTime": "String (timestamp)",
"flag": {"@odata.type": "microsoft.graph.followupFlag"},
"from": {"@odata.type": "microsoft.graph.recipient"},
"hasAttachments": true,
"id": "string (identifier)",
"importance": "String",
"inferenceClassification": "String",
"internetMessageHeaders": [{"@odata.type": "microsoft.graph.internetMessageHeader"}],
"internetMessageId": "String",
"isDeliveryReceiptRequested": true,
"isDraft": true,
"isRead": true,
"isReadReceiptRequested": true,
"lastModifiedDateTime": "String (timestamp)",
"mentionsPreview": {"@odata.type": "microsoft.graph.mentionsPreview"},
"parentFolderId": "string",
"receivedDateTime": "String (timestamp)",
"replyTo": [{"@odata.type": "microsoft.graph.recipient"}],
"sender": {"@odata.type": "microsoft.graph.recipient"},
"sentDateTime": "String (timestamp)",
"subject": "string",
"toRecipients": [{"@odata.type": "microsoft.graph.recipient"}],
"uniqueBody": {"@odata.type": "microsoft.graph.itemBody"},
"unsubscribeData": "string",
"unsubscribeEnabled": true,
"webLink": "string",
"attachments": [{"@odata.type": "microsoft.graph.attachment"}],
"extensions": [{"@odata.type": "microsoft.graph.extension"}],
"mentions": [{"@odata.type": "microsoft.graph.mention"}],
"multiValueExtendedProperties": [{"@odata.type": "microsoft.graph.multiValueLegacyExtendedProperty"}],
"singleValueExtendedProperties": [{"@odata.type": "microsoft.graph.singleValueLegacyExtendedProperty"}]
}
関連項目
- メールボックス設定を取得する
- メールボックス設定を更新する
- デルタ クエリを使用して、Microsoft Graph データの変更を追跡する
- フォルダー内のメッセージへの増分変更を取得する
- 拡張機能を使用してカスタム データをリソースに追加する
- オープン拡張機能を使用してカスタム データをユーザーに追加する
- スキーマ拡張機能を使用したグループへのカスタム データの追加
フィードバック
フィードバックの送信と表示