eventMessage リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
会議出席依頼、キャンセル、または応答を表すメッセージ。 受け入れ、仮承諾、または辞退のいずれかの値を指定できます。
eventMessage エンティティは message から派生したものです。 eventMessage は、 eventMessageRequest と eventMessageResponse の基本型です。 meetingMessageType プロパティはイベント メッセージの種類を特定します。
開催者またはアプリが会議出席依頼を送信すると、会議出席依頼は、meetingRequest の meetingMessageType を持つ eventMessage インスタンスとして招待者のメールボックスに到着します。 さらに、Outlook は招待者の予定表に イベント インスタンスを自動的に作成し、 showAs プロパティを 仮のものとして作成します。
招待者のメールボックス内の関連付けられているイベントのプロパティを取得するには、このイベント メッセージの取得の例に示すように、アプリで eventMessage のイベント ナビゲーション プロパティを使用できます。 また、アプリは、イベントを承諾、仮承諾、または拒否することで、招待者の代わりにプログラムでイベントに応答することもできます。
会議出席依頼とは別に、イベント開催者が会議をキャンセルした結果として、または会議出席依頼に応答した招待者の結果として、 eventMessage インスタンスが招待者のメールボックスに見つかります。 アプリはメッセージ上と同様にイベント メッセージ上でも動作しますが、わずかな違いがあります。
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": "DateTimeOffset",
"endDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"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",
"isAllDay": "Boolean",
"isDelegated": true,
"isDeliveryReceiptRequested": true,
"isDraft": true,
"isOutOfDate": "Boolean",
"isRead": true,
"isReadReceiptRequested": true,
"lastModifiedDateTime": "DateTimeOffset",
"location": {"@odata.type": "microsoft.graph.location"},
"meetingMessageType": {"@odata.type": "microsoft.graph.meetingMessageType"},
"mentionsPreview": {"@odata.type": "microsoft.graph.mentionsPreview"},
"parentFolderId": "string",
"receivedDateTime": "DateTimeOffset",
"recurrence": {"@odata.type": "microsoft.graph.patternedRecurrence"},
"replyTo": [{"@odata.type": "microsoft.graph.recipient"}],
"sender": {"@odata.type": "microsoft.graph.recipient"},
"sentDateTime": "DateTimeOffset",
"startDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"subject": "string",
"toRecipients": [{"@odata.type": "microsoft.graph.recipient"}],
"type": "string",
"uniqueBody": {"@odata.type": "microsoft.graph.itemBody"},
"UnsubscribeData": "string",
"UnsubscribeEnabled": true,
"webLink": "string"
}
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| bccRecipients | recipient collection | メッセージの BCC 受信者。 |
| body | itemBody | メッセージの本文。 HTML 形式またはテキスト形式にできます。 |
| bodyPreview | String | メッセージ本文の最初の 255 文字。 テキスト形式です。 |
| categories | String collection | メッセージに関連付けられたカテゴリ。 |
| ccRecipients | recipient collection | メッセージの CC 受信者。 |
| changeKey | String | メッセージのバージョン。 |
| conversationId | String | 電子メールが属している会話の ID。 |
| conversationIndex | Edm.Binary | 会話内のメッセージの位置を示します。 |
| createdDateTime | DateTimeOffset | メッセージが作成された日時。 |
| endDateTime | dateTimeTimeZone | 要求された会議の終了時刻。 |
| flag | followUpFlag | メッセージのステータス、開始日、期限、または完了日を示すフラグ値。 |
| from | recipient | メッセージの送信元のメールボックスの所有者。 ほとんどの場合、この値は sender プロパティと同じです。ただし、共有または委任のシナリオは除きます。 この値は、実際に使用されているメールボックスに対応している必要があります。 メッセージのfrom プロパティと sender プロパティの設定に関する詳細情報を参照してください。 |
| hasAttachments | ブール値 | メッセージに添付ファイルがあるかどうかを示します。 |
| id | String | メッセージの一意識別子。
既定では、この値は、アイテムをあるコンテナー (フォルダーや予定表など) から別のコンテナーに移動したときに変更されます。 この動作を変更するには、Prefer: IdType="ImmutableId" ヘッダーを使用します。 詳細については「Outlook リソースの不変識別子を取得する」を参照してください。 読み取り専用です。 |
| importance | String | メッセージの重要度: low、normal、high。 |
| inferenceClassification | String | 使用可能な値は、focused、other です。 |
| internetMessageHeaders | internetMessageHeader コレクション | RFC5322 によって定義された、メッセージ ヘッダーのコレクション。メッセージが送信者から受信者に到達するまでに辿ったネットワーク パスの詳細を説明します。 読み取り専用。 |
| internetMessageId | String | RFC5322 で指定されている形式のメッセージ ID。 |
| isAllDay | Boolean | イベントが 1 日中続くかどうかを示します。 このプロパティを調整するには、イベントの startDateTime プロパティと endDateTime プロパティも調整する必要があります。 |
| isDelegated | ブール型 | この会議出席依頼に代理人がアクセスできる場合は True、それ以外の場合は false。 既定値は false です。 |
| isDeliveryReceiptRequested | Boolean | メッセージの開封確認メッセージが要求されているかどうかを示します。 |
| isDraft | ブール値 | メッセージが下書きかどうかを示します。 メッセージがまだ送信されていなければ下書きです。 |
| isOutOfDate | ブール型 | この会議出席要求がより新しい要求によって古くなっているかどうかを示します。 |
| isRead | Boolean | メッセージが開封されたかどうかを示します。 |
| isReadReceiptRequested | Boolean | メッセージの開封確認メッセージが要求されているかどうかを示します。 |
| lastModifiedDateTime | DateTimeOffset | メッセージが最後に変更された日時。 |
| location | location | 要求された会議の場所。 |
| meetingMessageType | String | イベント メッセージの種類: none、meetingRequest、meetingCancelledmeetingAcceptedmeetingTentativelyAcceptedmeetingDeclined。 |
| mentionsPreview | mentionsPreview | メッセージのメンションに関する情報。 /メッセージ要求を処理するときに、サーバーはこのプロパティを設定して、既定で応答に含めます。 メッセージにメンションがない場合、サーバーは null を返します。 省略可能。 |
| parentFolderId | String | メッセージの親 mailFolder の一意識別子。 |
| receivedDateTime | DateTimeOffset | メッセージが受信された日時です。 |
| recurrence | patternedRecurrence | 要求された会議の定期的なパターン。 |
| replyTo | recipient collection | 返信時に使用される電子メール アドレス。 |
| sender | recipient | メッセージの生成に使用されるアカウント。 ほとんどの場合、この値は from プロパティと同じです。 共有メールボックスからメッセージを送信するとき、共有予定表用に、または代理人としてこのプロパティを別の値に設定できます。 いずれの場合でも、この値は、実際に使用されているメールボックスに対応している必要があります。 詳細については、「 from プロパティと sender プロパティの設定」を参照してください。 |
| sentDateTime | DateTimeOffset | メッセージが送信された日時。 |
| startDateTime | dateTimeTimeZone | 要求された会議の開始時刻。 |
| subject | String | メッセージの件名。 |
| toRecipients | recipient collection | メッセージの宛先。 |
| type | String | 要求された会議の種類: singleInstance、 occurence、 exception、 seriesMaster。 |
| uniqueBody | itemBody | 現在のメッセージに特有のメッセージの本文の一部。 |
| UnsubscribeData | String | List-Unsubscribe ヘッダーに基づいて解析された有効なエントリ。 UnsubscribeEnabled プロパティが true の場合、これは List-Unsubscribe ヘッダー内の mail コマンドのデータです。 |
| UnsubscribeEnabled | ブール型 | メッセージが登録解除に対して有効になっているかどうかを示します。 list-Unsubscribe ヘッダーが rfc-2369 に準拠している場合、その値は True です。 |
| webLink | String | Outlook on the web でメッセージを開く URL。 URL の末尾に ispopout 引数を付加して、メッセージの表示方法を変更できます。 ispopout が存在しない場合、または 1 に設定されている場合は、メッセージがポップアウト ウィンドウに表示されます。 ispopout が 0 に設定されている場合、ブラウザーは Web レビュー ウィンドウの Outlook にメッセージを表示します。 Outlook on the web 経由でメールボックスにログインしている場合は、ブラウザーでメッセージが開きます。 ブラウザーでまだログインしていない場合は、ログインするように求められます。 iFrame 内からこの URL にアクセスすることはできません。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| attachments | attachment コレクション | メッセージの fileAttachment、 itemAttachment、 および referenceAttachment 添付ファイルのコレクション。 読み取り専用です。 Null 許容型。 |
| event | event | イベント メッセージに関連付けられたイベント。 参加者または部屋リソースの前提は、会議出席依頼イベント メッセージが届いたときにイベントを含む予定表を自動的に更新するようにカレンダー アテンダントが設定されていることです。 ナビゲーション プロパティ。 読み取り専用。 |
| extensions | extension コレクション | eventMessage に対して定義されているオープン拡張機能のコレクション。 読み取り専用。 Null 許容型。 |
| mentions | mention コレクション | メッセージのメンションのコレクション。createdDateTime で最新の日付順になっています。 既定では、プロパティに$expandを適用しない限り、GET /messages はこのプロパティを返しません。 |
| multiValueExtendedProperties | multiValueLegacyExtendedProperty collection | eventMessage に対して定義された、複数値の拡張プロパティのコレクション。 読み取り専用。 Null 許容型。 |
| singleValueExtendedProperties | singleValueLegacyExtendedProperty collection | eventMessage に対して定義された、単一値の拡張プロパティのコレクション。 読み取り専用。 Null 許容型。 |
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| Get | eventMessage | eventMessage オブジェクトのプロパティとリレーションシップを読み取ります。 |
| 更新する | eventMessage | eventMessage オブジェクトを更新します。 |
| 削除 | なし | eventMessage オブジェクトを削除します。 |
| メッセージをコピーする | message | メッセージをフォルダーにコピーします。 |
| メッセージを転送する下書きを作成する | message | 転送メッセージの下書きを作成します。 その後、下書きを更新または送信できます。 |
| 返信する下書きを作成する | message | 返信メッセージの下書きを作成します。 その後、下書きを更新または送信できます。 |
| 全員に返信する下書きを作成する | message | 全員に返信メッセージの下書きを作成します。 その後、下書きを更新または送信できます。 |
| メッセージを転送する | なし | メッセージを転送します。 その後、メッセージは送信済みアイテム フォルダーに保存されます。 |
| メッセージを移動する | message | メッセージをフォルダーに移動します。 これにより、宛先フォルダーにメッセージの新しいコピーが作成されます。 |
| メッセージに返信する | なし | メッセージの送信者に返信します。 その後、メッセージは [送信済みアイテム] フォルダーに保存されます。 |
| メッセージへの応答すべて | なし | メッセージの受信者すべてに返信します。 その後、メッセージは [送信済みアイテム] フォルダーに保存されます。 |
| 下書きメッセージを送信する | なし | 以前に作成したメッセージの下書きを送信します。 その後、メッセージは [送信済みアイテム] フォルダーに保存されます。 |
| メッセージの呼び出し | message | 指定したユーザーのメールボックスの [送信済みアイテム] フォルダー内のメッセージを呼び出します。 |
| 登録を解除する | なし | List-Unsubscribe ヘッダー内の最初の mailto コマンドで指定されたデータとアドレスを使用して、メッセージを送信します。 |
| 完全に削除 | なし | イベント メッセージを完全に削除し、ユーザーのメールボックスの [回復可能なアイテム] フォルダーの [消去] フォルダーに配置します。 |
| 添付ファイル | ||
| 添付ファイルを一覧表示する | attachment コレクション | eventMessage のすべての添付ファイルを取得します。 |
| 添付ファイルを追加する | attachment | 添付ファイル コレクションへの投稿により、eventMessage に新しい添付ファイルを追加します。 |
| オープン拡張機能 | ||
| Create open extension | openTypeExtension | オープン拡張機能を作成し、リソースの新規または既存のインスタンスのカスタム プロパティを追加します。 |
| オープン拡張機能を取得する | openTypeExtension コレクション | 名前で識別される開いている拡張機能を取得します。 |
| 拡張プロパティ | ||
| 単一値のプロパティを作成する | eventMessage | 新規または既存の eventMessage に、1 つ以上の単一値の拡張プロパティを作成します。 |
| 単一値のプロパティを取得する | eventMessage |
$expand または $filter を使用して、単一値の拡張プロパティを含む eventMessage を取得します。 |
| 複数値のプロパティを作成する | eventMessage | 新規または既存の eventMessage に、1 つ以上の複数値の拡張プロパティを作成します。 |
| 複数値のプロパティを取得する | eventMessage |
$expand を使用して、複数値の拡張プロパティを含む eventMessage を取得します。 |