メッセージ: createReply
名前空間: microsoft.graph
重要
Microsoft Graph の /beta
バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
JSON 形式または MIME 形式で メッセージ の送信者に返信する下書きを作成します。
JSON 形式を使用する場合:
-
message
パラメーターのコメントまたは body プロパティを指定します。 両方を指定すると、「HTTP 400 要求が正しくありません」というエラーが返されます。 - 元のメッセージで replyTo が指定されている場合は、インターネット メッセージ形式 (RFC 2822) に従って、 受信者ではなく replyToの受信者に返信を送信する必要があります。
- 下書きを後で 更新 して、 本文 に返信コンテンツを追加したり、他のメッセージ プロパティを変更したりできます。
MIME 形式を使用すると、以下のことが可能になります。
- 適用する インターネット メッセージ ヘッダー と MIME コンテンツを指定してから、要求本文に base64 形式でエンコードします。
- 任意の添付ファイルと S/MIME プロパティを MIME コンテンツに追加します。
下書きメッセージを以降の操作で送信します。
または、1 回の操作で メッセージに返信 します。
この API は、次の国内クラウド展開で使用できます。
グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
---|---|---|
委任 (職場または学校のアカウント) | Mail.ReadWrite | 注意事項なし。 |
委任 (個人用 Microsoft アカウント) | Mail.ReadWrite | 注意事項なし。 |
アプリケーション | Mail.ReadWrite | 注意事項なし。 |
HTTP 要求
POST /me/messages/{id}/createReply
POST /users/{id | userPrincipalName}/messages/{id}/createReply
POST /me/mailFolders/{id}/messages/{id}/createReply
POST /users/{id | userPrincipalName}/mailFolders/{id}/messages/{id}/createReply
要求ヘッダー
名前 | 種類 | 説明 |
---|---|---|
Authorization | string | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
Content-Type | string | エンティティ本文内のデータの性質です。 必須です。 JSON オブジェクトには application/json を、MIME コンテンツには text/plain を使用します。 |
優先: outlook.timezone | string | この API が要求本文に基づいて作成する HTML の返信ドラフト メッセージの Sent フィールドのタイム ゾーンを設定します。 値には、ユーザー用に構成 された supportedTimeZones のいずれかを指定できます。 指定しない場合、その Sent フィールドは UTC です。このヘッダーは、 Content-Type: application/json ヘッダーを指定して HTML で返信ドラフト メッセージを作成する場合にのみ使用します。
Content-Type: text/plain ヘッダーを使用する場合、このPrefer ヘッダーには影響しません。 省略可能。 |
要求本文
JSON オブジェクトを使用する場合、次のパラメーターを含む JSON オブジェクトを指定します。
パラメーター | 種類 | 説明 |
---|---|---|
comment | String | 含めるコメントです。 空の文字列にすることができます。 |
message | message | 返信メッセージで更新する書き込み可能なプロパティです。 |
本文を MIME 形式で指定する場合は、該当するインターネット メッセージ ヘッダーを MIME コンテンツに指定します。すべて要求本文で base64 形式でエンコードされます。
応答
成功した場合、このメソッドは 201 Created
応答コードと、応答本文で message オブジェクトを返します。
要求本文に不正な MIME コンテンツが含まれていた場合、このメソッドは 400 Bad request
と次のエラー メッセージを返します。"MIME コンテンツの無効な base64 文字列"。
例
例 1: 既存のメッセージに返信する下書きを JSON 形式で作成する
次の例では、下書きの返信を作成し、要求の本文にコメントと受信者を追加します。
要求
次の例は要求を示しています。
POST https://graph.microsoft.com/beta/me/messages/AAMkADA1MTAAAAqldOAAA=/createReply
Content-Type: application/json
{
"message":{
"toRecipients":[
{
"emailAddress": {
"address":"samanthab@contoso.com",
"name":"Samantha Booth"
}
},
{
"emailAddress":{
"address":"randiw@contoso.com",
"name":"Randi Welch"
}
}
]
},
"comment": "Samantha, Randi, would you name the group if the project is approved, please?"
}
応答
次の例は応答を示しています。 注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 201 Created
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Me/messages/$entity",
"@odata.id": "https://graph.microsoft.com/beta/users('86b6ceaf-57f7-4278-97c4-4da0a97f6cdb@70559e59-b378-49ea-8e53-07a3a3d27f5b')/messages('AAMkADA1MTAAAH5JKoAAA=')",
"@odata.etag": "W/\"CQAAABYAAADX8oL1Wa7jQbcPAHouCzswAAAH5/DO\"",
"id": "AAMkADA1MTAAAH5JKoAAA=",
"subject": "RE: Let's start a group",
"Body": {
"contentType": "HTML",
"content": "<html>\r\n<body>Samantha, Randi, would you name the group if the project is approved, please?\r\n<b>From:</b> Samantha Booth<br>\r\n<b>Sent:</b> Friday, March 4, 2016 12:23:35 AM<br>\r\n<b>To:</b> Admin<br>\r\n<b>Subject:</b> Re: Let's start a group</font>\r\n<p>That's a great idea!<br>\r\n</body>\r\n</html>"
},
"sender": {
"emailAddress": {
"name": "Admin",
"address": "admin@contoso.com"
}
},
"from": null,
"toRecipients": [
{
"emailAddress": {
"name": "Samantha Booth",
"address": "samanthab@contoso.com"
}
},
{
"emailAddress": {
"name": "Randi Welch",
"address": "randiw@contoso.com"
}
}
]
}
例 2: 既存のメッセージに返信する MIME 形式の下書きメッセージを作成する
要求
POST https://graph.microsoft.com/v1.0/me/messages/AAMkADA1MTAAAAqldOAAA=/createReply
Content-type: text/plain
RnJvbTogQWxleCBXaWxiZXIgPEFsZXhXQGNvbnRvc28uY29tPgpUbzogTWVnYW4gQm93ZW4gPE1l
Z2FuQkBjb250b3NvLmNvbT4KU3ViamVjdDogSW50ZXJuYWwgUmVzdW1lIFN1Ym1pc3Npb246IFNh
bGVzIEFzc29jaWF0ZQpUaHJlYWQtVG9waWM6IEludGVybmFsIFJlc3VtZSBTdWJtaXNzaW9uOiBT
YWxlcyBBc3NvY2lhdGUKVGhyZWFkLUluZGV4OiBjb2RlY29kZWNvZGVoZXJlaGVyZWhlcmUKRGF0
ZTogU3VuLCAyOCBGZWIgMjAyMSAwNzoxNTowMCA
応答
次の例は応答を示しています。
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('0aaa0aa0-0000-0a00-a00a-0000009000a0')/messages/$entity",
"@odata.etag": "W/\"AAAAAAAAAAAa00AAAa0aAaAa0a0AAAaAAAAaAa0a\"",
"id": "AAMkADA1MTAAAAqldOAAA=",
"createdDateTime": "2021-04-23T18:13:44Z",
"lastModifiedDateTime": "2021-04-23T18:13:44Z",
"changeKey": "AAAAAAAAAAAA00aaaa000aaA",
"categories": [],
"receivedDateTime": "2021-04-23T18:13:44Z",
"sentDateTime": "2021-02-28T07:15:00Z",
"hasAttachments": false,
"internetMessageId": "<AAAAAAAAAA@AAAAAAA0001AA0000.codcod00.prod.outlook.com>",
"subject": "Internal Resume Submission: Sales Associate",
"bodyPreview": "Hi, Megan.I have an interest in the Sales Associate position. Please consider my resume, which you can access here...",
"importance": "normal",
"parentFolderId": "LKJDSKJHkjhfakKJHFKWKKJHKJdhkjHDK==",
"conversationId": "SDSFSmFSDGI5LWZhYjc4fsdfsd=",
"conversationIndex": "Adfsdfsdfsdfw==",
"isDeliveryReceiptRequested": null,
"isReadReceiptRequested": false,
"isRead": true,
"isDraft": true,
"webLink": "https://outlook.office365.com/owa/?ItemID=AAMkAGNhOWAvsurl=1&viewmodel=ReadMessageItem",
"inferenceClassification": "focused",
"body": {
"contentType": "text",
"content": "Hi, Megan.I have an interest in the Sales Associate position. Please consider my resume, which you can access here... Regards,Alex"
},
"sender": {
"emailAddress": {
"name": "Alex Wilber",
"address": "AlexW@contoso.com"
}
},
"from": {
"emailAddress": {
"name": "Alex Wilber",
"address": "AlexW@contoso.com"
}
},
"toRecipients": [
{
"emailAddress": {
"name": "Megan Bowen",
"address": "MeganB@contoso.com"
}
}
],
"ccRecipients": [],
"bccRecipients": [],
"replyTo": [],
"flag": {
"flagStatus": "notFlagged"
}
}
要求本文に不正な MIME コンテンツが含まれていた場合、このメソッドは次のエラー メッセージを返します。
HTTP/1.1 400 Bad Request
Content-type: application/json
{
"error": {
"code": "ErrorMimeContentInvalidBase64String",
"message": "Invalid base64 string for MIME content."
}
}