Outlook メール REST API 参照 (バージョン 1.0)

[アーティクル]
06/30/2018

注意

Outlook REST API のバージョン 1.0 は廃止されます。 2018 年 11 月 1 日 以降、アプリは v1.0 REST エンドポイントで基本認証を使用することができなくなります。 2019 年 11 月 1 日までに、v1.0 REST エンドポイントは完全に使用停止になり、v1.0 のドキュメントはその後間もなく削除されます。 Microsoft Graph の v1.0 での Outlook REST API を使用するように、アプリの移行を始めてください。詳細については、この [お知らせ]をご覧ください。

Outlook メール API では、メッセージと添付ファイルの読み取り、作成、送信、イベントメッセージの表示と応答、および Office 365 での Azure Active Directory で保護されているフォルダーの管理が可能です。また、次のドメインでは、Microsoft アカウントと同じ機能も提供されます: Hotmail.com、Live.com、MSN.com、Outlook.com、および Passport.com。

注意

リファレンスをわかりやすくするため、この記事の残りの部分では、これらの Microsoft アカウントドメインを含めて Outlook.com を使用します。

API v1.0 が不要な場合 左側の目次で、[Office 365 REST API reference] セクションに移動し、使用したいバージョンを選択します。

すべてのメール API の操作

メッセージの操作

メッセージはメールボックスフォルダーに格納されるため、多くの場合、メッセージエンドポイントには、メッセージの入ったフォルダーが含まれています。フォルダーは ID、もしくは次の既知のフォルダー名のうち、いずれかで指定されます： Inbox、Drafts、SentItems、または DeletedItems

メッセージを取得する
メッセージを同期する
メッセージを作成して送信する
メッセージに返信、または全部のメッセージに返信
新規または下書きメッセージを転送する
メッセージを更新する
メッセージを削除する
メッセージを移動またはコピーする
優先受信トレイを管理する
@-メンションを管理する (プレビュー)
ルールを管理する (プレビュー)
登録を解除する (プレビュー)
言語の選択肢を取得する (プレビュー)
タイムゾーンの選択肢を取得する (プレビュー)
メールボックス設定を取得する
自動返信の設定を取得する
自動返信の設定を更新する
メールヒントを取得する (プレビュー)
添付ファイルの取得
添付ファイルを作成する
添付ファイルを削除する

フォルダー操作

メールボックスフォルダーにはメッセージとその他のフォルダーを格納することができます。フォルダーを取得、作成、変更、削除、管理することができます。 ID の代わりに、次の既知のフォルダー名を使用して、対応するフォルダーを指定することができます：Inbox、SentItems、Drafts、または DeletedItems

フォルダーを取得する
フォルダーを同期させる
フォルダーを作成する
フォルダーを更新する
フォルダーを削除する
フォルダーを移動またはコピーする

メール REST API を使用する

認証

他の Outlook REST API と同様に、メール API へのすべての要求に対して、有効なアクセストークンを含める必要があります。アクセストークンを取得するには、アプリを登録して識別し、適切な承認を取得する必要があります。

効率化された登録と承認のオプションに関する詳細情報を参照してください。メール API で特定の操作を続行する際には、この点に留意してください。

API のバージョン

メール REST API は、すべてのバージョンの Outlook REST API でサポートされています。機能は、特定のバージョンによって異なる場合があります。

対象ユーザー

すべてのメール API 要求は、指定しない限り常にサインインユーザーのために実行されます。優先受信トレイ API など、一部の API サブセットは、サインインユーザーまたはユーザー ID で指定したユーザーで、適切な権限を付与して実行できます。

Outlook REST API のすべてのサブセットに共通な情報の詳細については、「Outlook REST API の使用」を参照してください。

メッセージを取得する

メールボックスフォルダーからメッセージコレクションまたは個々のメッセージを取得できます。

応答内の各メッセージには、本文プロパティをはじめとする複数のプロパティが含まれます。メッセージの本文は、テキストまたは HTML 形式のいずれかにできます。本文が HTML の場合、既定では、Body プロパティに組み込まれている安全ではない可能性がある HTML (たとえば、JavaScript など) が、本文の内容が REST 応答で返される前に削除されます。

元の HTML コンテンツ全体を取得するには、次の HTTP 要求ヘッダーを含めます。

Prefer: outlook.allow-unsafe-html

現在、GET 操作によって返されるメッセージ本文は HTML 形式のみです。

メッセージコレクションを取得する
メッセージを取得する

メッセージコレクションを取得する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.read
wl.imap

注意

このセクションの操作のビヘイビアーは、バージョンによって異なります。左側の目次で [ Office 365 REST API のリファレンス] の下のバージョンを選択して詳細を確認します。

受信トレイからメッセージコレクションを取得します。

GET https://outlook.office.com/api/v1.0/me/messages

また、ユーザーのメールボックスのフォルダーを指定して、そのフォルダーからメッセージコレクションを取得することもできます。

GET https://outlook.office.com/api/v1.0/me/MailFolders/{folder_id}/messages

必須のパラメーター	種類	説明
URL パラメーター
folder_id	文字列	フォルダーの ID、または既知のフォルダー名 `Inbox`、`Drafts`、`SentItems`、または `DeletedItems` (特定のフォルダーからメッセージを取得する場合) です。

注意

既定では、応答内の各メッセージには、そのプロパティがすべて含まれます。 $select を使用して、最適なパフォーマンスのために必要なプロパティのみを指定します。 Id プロパティは常に返されます。パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリパラメーター」を参照してください。

次の例は、$select を使用して、応答内の各メッセージの 送信者 と件名プロパティのみを返すように指定する方法を示しています。 $select を使用しない場合にメッセージに返されるプロパティの完全なリストについては、「連絡先を取得する」の応答サンプルを参照してください。

要求のサンプル

GET https://outlook.office.com/api/v1.0/me/folders/sentitems/messages/?$select=Sender,Subject

応答のサンプル

状態コード:200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Folders('sentitems')/Messages(Sender,Subject)",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGI2TIy-AAA=')",
            "@odata.etag": "W/\"CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqS\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEJAACd9nJ-tVysQos2hTfspaWRAAADTIzAAAA=",
            "Subject": "Meeting Notes",
            "Sender": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "/O=EXCHANGELABS/OU=EXCHANGE ADMINISTRATIVE GROUP (FYDIBOHF23SPDLT)/CN=RECIPIENTS/CN=1A5F1737122542AEA595DF9590A1C6FD-ALEXD"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGI2TIy-AAA=')",
            "@odata.etag": "W/\"CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqP\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEJAACd9nJ-tVysQos2hTfspaWRAAADTIy-AAA=",
            "Subject": "Contract Signing",
            "Sender": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "/O=EXCHANGELABS/OU=EXCHANGE ADMINISTRATIVE GROUP (FYDIBOHF23SPDLT)/CN=RECIPIENTS/CN=1A5F1737122542AEA595DF9590A1C6FD-ALEXD"
                }
            }
        },
        {
            "@odata.type": "#Microsoft.OutlookServices.EventMessage",
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGI2TIy-AAA=')",
            "@odata.etag": "W/\"CwAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqJ\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEJAACd9nJ-tVysQos2hTfspaWRAAADTIy9AAA=",
            "Subject": "Rob:Alex 1:1",
            "Sender": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "/O=EXCHANGELABS/OU=EXCHANGE ADMINISTRATIVE GROUP (FYDIBOHF23SPDLT)/CN=RECIPIENTS/CN=1A5F1737122542AEA595DF9590A1C6FD-ALEXD"
                }
            }
        }
    ]
}

応答の種類

要求されたメッセージコレクションです。

メッセージを取得する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.read
wl.imap

ID でメッセージを取得します。

GET https://outlook.office.com/api/v1.0/me/messages/{message_id}

必須のパラメーター	種類	説明
URL パラメーター
message_id	文字列	メッセージ ID。

要求のサンプル

GET https://outlook.office.com/api/v1.0/me/messages/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEMAACd9nJ-tVysQos2hTfspaWRAAADTHVSAAA=

応答のサンプル

状態コード:200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIKz\"",
  "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEMAACd9nJ-tVysQos2hTfspaWRAAADTHVSAAA=",
  "ChangeKey": "CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIKz",
  "Categories": [],
  "DateTimeCreated": "2014-10-20T00:41:57Z",
  "DateTimeLastModified": "2014-10-20T00:41:57Z",
  "Subject": "Re: Meeting Notes",
  "BodyPreview": "________________________________________\nFrom: Alex D\nSent: Sunday, October 19, 2014 5:28 PM\nTo: Katie Jordan\nSubject: Meeting Notes\n\nPlease send me the meeting notes ASAP",
  "Body": {
    "ContentType": "Text",
    "Content": "\n________________________________________\nFrom: Alex D\nSent: Sunday, October 19, 2014 5:28 PM\nTo: Katie Jordan\nSubject: Meeting Notes\n\nPlease send me the meeting notes ASAP\n"
  },
  "Importance": "Normal",
  "HasAttachments": true,
  "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEMAAA=",
  "From": {
    "EmailAddress": {
      "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Katie Jordan"
    }
  },
  "Sender": {
    "EmailAddress": {
      "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Katie Jordan"
    }
  },
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Alex D"
      }
    }
  ],
  "CcRecipients": [],
  "BccRecipients": [],
  "ReplyTo": [],
  "ConversationId": "AAQkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAQAEmjRj3pwjRLrbymGMYyEto=",
  "DateTimeReceived": "2014-10-20T00:41:57Z",
  "DateTimeSent": "2014-10-20T00:41:53Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": false,
  "IsRead": false
}

応答の種類

要求されたメッセージです。

注意

既定では、指定されたメッセージのプロパティすべてが応答に含まれます。 $select を使用して、最適なパフォーマンスのために必要なプロパティのみを指定します。 Id プロパティは常に返されます。パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリパラメーター」を参照してください。

次の例は、$select を使用して、応答内のメッセージの Sender と Subject プロパティのみを返すように指定する方法を示しています。

GET https://outlook.office.com/api/v1.0/me/messages/AAMkAGEI5MTAAA=?$select=Sender,Subject

メッセージを同期する

この機能は、バージョン 2.0 とベータ版で現在利用可能です。左側の目次で、[Office 365 REST API リファレンス] セクションに移動し、使用したいバージョンを選択します。

メッセージを作成して送信する

オンザフライで新しいメッセージを送信するか、下書きメッセージを作成してからそれを送信することができます。任意のフォルダーに下書きを作成できます。

オンザフライで新しいメッセージを送信する
下書きメッセージを作成する
下書きメッセージを送信する

オンザフライで新しいメッセージを送信する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.send
wl.imap

SendMail メソッドを使用して、要求本文で指定されたメッセージを送信します。Attachments コレクションプロパティでこれを指定して、同じアクションの呼び出しに添付ファイルを含めることができます。また、[送信済みアイテム] フォルダーにメッセージを保存できます。

POST https://outlook.office.com/api/v1.0/me/sendmail

必須のパラメーター	種類	説明
本文パラメーター
メッセージ	メッセージ	送信するメッセージです。
SavetoSentItems	ブール値	[送信済みアイテム] 内のメッセージを保存するかどうかを示します。既定値は true です。

要求本文に必要な ToRecipients プロパティと任意の書き込み可能な message プロパティを設定して、Message パラメーターを指定します。SaveToSentItems パラメーターは、false の場合にのみ必要です。

要求のサンプル

POST https://outlook.office.com/api/v1.0/me/sendmail

{
  "Message": {
    "Subject": "Meet for lunch?",
    "Body": {
      "ContentType": "Text",
      "Content": "The new cafeteria is open."
    },
    "ToRecipients": [
      {
        "EmailAddress": {
          "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com"
        }
      }
    ],
    "Attachments": [
      {
        "@odata.type": "#Microsoft.OutlookServices.FileAttachment",
        "Name": "menu.txt",
        "ContentBytes": "bWFjIGFuZCBjaGVlc2UgdG9kYXk="
      }
    ]
  },
  "SaveToSentItems": "false"
}

応答のサンプル

Status code: 202

下書きメッセージを作成する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.readwrite
wl.imap

新しいメッセージの下書きを作成します。下書きを任意のフォルダーに作成し、必要に応じて送信前に更新できます。[下書き] フォルダーに保存するには、/me/messages ショートカットを使用します。

POST https://outlook.office.com/api/v1.0/me/messages
POST https://outlook.office.com/api/v1.0/me/folders/{folder_id}/messages

必須のパラメーター	種類	説明
URL パラメーター
folder_id	文字列	宛先フォルダーの ID または既知のフォルダー名 (`Inbox` または `Drafts`)。

要求本文に任意の書き込み可能な message プロパティを指定します。

要求のサンプル

POST https://outlook.office.com/api/v1.0/me/folders/inbox/messages

Content-Type: application/json

{
  "Subject": "Did you see last night's game?",
  "Importance": "Low",
  "Body": {
    "ContentType": "HTML",
    "Content": "They were <b>awesome</b>!"
  },
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com"
      }
    }
  ]
}

応答のサンプル

状態コード :201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0Ag5\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEPAAAmP1Ln1wcHRariNdTMGAO9AAASz7k0AAA=",
  "ChangeKey": "CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0Ag5",
  "Categories": [],
  "DateTimeCreated": "2014-10-18T20:06:51Z",
  "DateTimeLastModified": "2014-10-18T20:06:51Z",
  "Subject": "Did you see last night's game?",
  "BodyPreview": "They were awesome!",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body>\r\nThey were <b>awesome</b>!\r\n</body>\r\n</html>\r\n"
  },
  "Importance": "Low",
  "HasAttachments": false,
  "ParentFolderId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAAAAEPAAA=",
  "From": null,
  "Sender": null,
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Katie Jordan"
      }
    }
  ],
  "CcRecipients": [],
  "BccRecipients": [],
  "ReplyTo": [],
  "ConversationId": "AAQkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAQADXiGXoAtX9IubRTpv2hisc=",
  "DateTimeReceived": "2014-10-18T20:06:51Z",
  "DateTimeSent": "2014-10-18T20:06:51Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": true,
  "IsRead": true
}

応答の種類

下書きメッセージです。

下書きメッセージを送信する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.send
wl.imap

Send メソッドを使用して、新しいメッセージの下書き、返信の下書き、全員に返信の下書き、または転送の下書きを送信します。その後、メッセージは [送信済みアイテム] フォルダーに保存されます。

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/send

必須のパラメーター	種類	説明
URL パラメーター
message_id	文字列	送信する下書きメッセージの ID です。

要求のサンプル

POST https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0Mz7k0AAA=/send

応答のサンプル

Status code: 202

メッセージに返信、または全部のメッセージに返信

注意

その場で、コメントに返信することができます。または、最初に返信の下書きを作成、更新し、その下書きを送信できます。

メッセージの送信者にのみ返信することも、一度にすべての受信者に返信することもできます。

オンザフライで送信者に返信する
オンザフライで全員に返信する
下書きの返信メッセージを作成する
下書きの全員に返信メッセージを作成する

オンザフライで送信者に返信する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.send
wl.imap

メッセージの送信者に返信する場合は、Reply メソッドを使用します。その後、メッセージは [送信済みアイテム] フォルダーに保存されます。

または、返信のために更新可能なプロパティを変更する必要がある場合、最初に下書き返信メッセージを作成し、メッセージのプロパティを更新してから、返信を送信します。

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/reply

必須のパラメーター	種類	説明
URL パラメーター
message_id	文字列	返信するメッセージの ID です。
本文パラメーター
コメント	文字列	含めるコメントです。空の文字列にすることができます。

要求のサンプル

POST https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0Mz8DmAAA=/reply
Content-Type: application/json

{
  "Comment": "Sounds great! See you tomorrow."
}

応答のサンプル

Status code: 202

オンザフライで全員に返信する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.send
wl.imap

メッセージの送信者全員に返信する場合は、コメントを指定して、ReplyAll メソッドを使用します。その後、メッセージは [送信済みアイテム] フォルダーに保存されます。

または、返信のために更新可能なプロパティを変更する必要がある場合、最初に下書きの全員に返信メッセージを作成し、メッセージのプロパティを更新してから、返信を送信します。

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/replyall

必須のパラメーター	種類	説明
URL パラメーター
message_id	文字列	返信するメッセージの ID です。
本文パラメーター
コメント	文字列	含めるコメントです。空の文字列にすることができます。

要求のサンプル

POST https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0MSz8DmAAA=/replyall
Content-Type: application/json

{
  "Comment": "Thanks for the heads up."
}

応答のサンプル

Status code: 202

下書きの返信メッセージを作成する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.readwrite
wl.imap

指定したメッセージに返信するための下書きを作成します。下書きを更新して本文プロパティに返信のコンテンツを追加したり、その他のメッセージのプロパティを変更することも、下書きをそのまま送信することもできます。

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/createreply

必須のパラメーター	種類	説明
URL パラメーター
message_id	文字列	返信するメッセージの ID です。

要求のサンプル

POST https://outlook.office.com/api/v1.0/me/messages/AAMkADA1MTAAAAqldOAAA=/createreply

応答のサンプル

Status code: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('86b6ceaf-57f7-4278-97c4-4da0a97f6cdb@70559e59-b378-49ea-8e53-07a3a3d27f5b')/Messages('AAMkADA1MTAAAH5JKoAAA=')",
  "@odata.etag": "W/\"CQAAABYAAADX8oL1Wa7jQbcPAHouCzswAAAH5/DO\"",
  "Id": "AAMkADA1MTAAAH5JKoAAA=",
  "CreatedDateTime": "2016-03-15T08:33:43Z",
  "LastModifiedDateTime": "2016-03-15T08:33:43Z",
  "ChangeKey": "CQAAABYAAADX8oL1Wa7jQbcPAHouCzswAAAH5/DO",
  "Categories": [ ],
  "ReceivedDateTime": "2016-03-15T08:33:43Z",
  "SentDateTime": "2016-03-15T08:33:43Z",
  "HasAttachments": false,
  "InternetMessageId": "<DM2PR00MB00571796B16132601E1F286CF7890@DM2PR00MB0057.namprd00.prod.outlook.com>",
  "Subject": "RE: Let's start a group",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n<body>Fanny, would you name the group if the project is approved, please?\r\n<b>From:</b> Fanny Downs<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>"
  },
  "BodyPreview": "Fanny, would you name the group if the project is approved, please?\r\n________________________________\r\nFrom: Fanny Downs\r\nSent: Friday, March 4, 2016 12:23:35 AM\r\nTo: Admin\r\nSubject: Re: Let's start a group\r\n\r\n\r\nThat's a gre",
  "Importance": "Normal",
  "ParentFolderId": "AQMkADA1MTAAAAIBDwAAAA==",
  "Sender": {
    "EmailAddress": {
      "Name": "Admin",
      "Address": "admin@contoso.onmicrosoft.com"
    }
  },
  "From": null,
  "ToRecipients": [
    {
      "EmailAddress": {
        "Name": "Fanny Downs",
        "Address": "fannyd@contoso.onmicrosoft.com"
      }
    }
  ],
  "CcRecipients": [ ],
  "BccRecipients": [ ],
  "ReplyTo": [ ],
  "ConversationId": "AAQkADA1MTVGjIwpLvWmGtIo-aFE=",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsRead": true,
  "IsDraft": true,
  "WebLink": "https://outlook.office.com/owa/?ItemID=AAMkADA1MTAAAH5JKoAAA%3D&exvsurl=1&viewmodel=ReadMessageItem",
  "MentionedMe": null,
  "AppliedHashtagsPreview": null,
  "LikesPreview": null,
  "MentionsPreview": null,
  "Mentioned": [ ],
  "InferenceClassification": "Focused",
  "UnsubscribeData": [ ],
  "UnsubscribeEnabled": false,
  "Flag": { "FlagStatus": "NotFlagged" }
}

応答の種類

ToRecipient、IsDraft、およびその他の適切なプロパティが事前に設定された下書きの返信メッセージです。

下書きの全員に返信メッセージを作成する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.readwrite
wl.imap

指定したメッセージの送信者とすべての受信者に対して返信するための下書きを作成します。下書きを更新して本文に返信のコンテンツを追加したり、その他のメッセージのプロパティを変更することもできますし、下書きをそのまま送信することもできます。

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/createreplyall

必須のパラメーター	種類	説明
URL パラメーター
message_id	文字列	返信するメッセージの ID です。

要求のサンプル

POST https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0Mz8DmAAA=/createreplyall

応答のサンプル

Status code: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGE0Mz7k5AAA=')",
  "@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AhF\"",
  "Id": "AAMkAGE0Mz7k5AAA=",
  "ChangeKey": "CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AhF",
  "Categories": [],
  "CreatedDateTime": "2014-10-18T21:21:06Z",
  "LastModifiedDateTime": "2014-10-18T21:21:06Z",
  "Subject": "RE: Check out the new Office 365 APIs",
  "BodyPreview": "If the project gets approved, please decide on the name.\r\n_________________________________\r\nFrom: Alex D\r\nSent: Saturday, October 18, 2014 9:18:18 PM\r\nTo: Katie Jordan; Garth Fort\r\nSubj",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n...</html>\r\n"
  },
  "Importance": "Normal",
  "HasAttachments": false,
  "ParentFolderId": "AAMkAGE0MAAEPAAA=",
  "From": null,
  "Sender": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Alex D"
    }
  },
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Katie Jordan"
      }
    },
    {
      "EmailAddress": {
        "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Garth Fort"
      }
    }
  ],
  "CcRecipients": [],
  "BccRecipients": [],
  "ReplyTo": [],
  "ConversationId": "AAQkAGE0M3HbTkEU=",
  "ReceivedDateTime": "2014-10-18T21:21:06Z",
  "SentDateTime": "2014-10-18T21:21:06Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": true,
  "IsRead": true
}

応答の種類

ToRecipient、IsDraft、およびその他の適切なプロパティが事前に設定された下書きの全員に返信メッセージです。

新規または下書きメッセージを転送する

注意

メッセージを直接転送するか、下書きの転送メッセージを作成し、それを更新してから送信することができます。

メッセージを直接転送する
転送メッセージを作成する

メッセージを直接転送する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.send
wl.imap

Forward メソッドを使用してメッセージを転送し、オプションでコメントを指定します。その後、メッセージは [送信済みアイテム] フォルダーに保存されます。

または、メッセージを転送するために更新可能なプロパティを変更する必要がある場合、最初に下書きの転送メッセージを作成し、メッセージのプロパティを更新してから、返信を送信します。

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/forward

必須のパラメーター	種類	説明
URL パラメーター
message_id	文字列	転送するメッセージの ID です。
本文パラメーター
コメント	文字列	含めるコメントです。空の文字列にすることができます。
ToRecipients	コレクション(受信者)	受信者の一覧です。

要求本文に Comment と ToRecipients パラメーターを指定します。

要求のサンプル

POST https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0Mz8DmAAA=/forward
Content-Type: application/json

{
  "Comment": "FYI",
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com"
      }
    },
    {
      "EmailAddress": {
        "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com"
      }
    }
  ]
}

応答のサンプル

Status code: 202

転送メッセージの下書きを作成する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.readwrite
wl.imap

指定したメッセージを転送するための下書きを作成します。下書きを更新して本文にコンテンツを追加したり、その他のメッセージのプロパティを変更することも、下書きをそのまま送信することもできます。

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/createforward

必須のパラメーター	種類	説明
URL パラメーター
message_id	文字列	転送するメッセージの ID です。

要求のサンプル

POST https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0Mz8DmAAA=/createforward

応答のサンプル

Status code: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGE0Mz7k6AAA=')",
  "@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AhG\"",
  "Id": "AAMkAGE0Mz7k6AAA=",
  "ChangeKey": "CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AhG",
  "Categories": [],
  "CreatedDateTime": "2016-03-15T08:42:10Z",
  "LastModifiedDateTime": "2016-03-15T08:42:10Z",
  "Subject": "FW: Let's start a group",
  "BodyPreview": "Dana, just want to make sure you get this.\r\n________________________________\r\nFrom: Admin\r\nSent: Tuesday, March 15, 2016 6:47:54 AM\r\nTo: Fanny Downs; Randi Welch\r\nSubject: RE: Let's st",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n...</html>\r\n"
  },
  "Importance": "Normal",
  "HasAttachments": false,
  "ParentFolderId": "AAMkAGE0MAAEPAAA=",
  "From": null,
  "Sender": {
    "EmailAddress": {
      "Address": "'alexd@contoso.onmicrosoft.com'",
      "Name": "Alex D"
    }
  },
  "ToRecipients": [],
  "CcRecipients": [],
  "BccRecipients": [],
  "ReplyTo": [],
  "ConversationId": "AAQkAGE0M3HbTkEU=",
  "ReceivedDateTime": "2016-03-15T08:42:10Z",
  "SentDateTime": "2016-03-15T08:42:10Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": true,
  "IsRead": true
}

応答の種類

IsDraft と適切なプロパティが事前に設定されている下書きの転送メッセージです。

メッセージを更新する

メッセージの書き込み可能なプロパティを変更して、変更を保存します。

メッセージを更新する

メッセージを更新する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.readwrite
wl.imap

下書きまたは既存のメッセージの書き込み可能なプロパティを変更します。指定したプロパティのみが変更されます。

PATCH https://outlook.office.com/api/v1.0/me/messages/{message_id}

必須のパラメーター	種類	説明
URL パラメーター
message_id	文字列	更新するメッセージの ID です。

要求本文に 1 つ以上の書き込み可能なメッセージのプロパティを指定します。

要求のサンプル

PATCH https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEMAAAmP1Ln1wcHRariNdTMGAO9AAASz8S-AAA=

Content-Type: application/json

{
  "Categories": [
    "Orange category",
    "Green category"
  ],
  "IsRead": true
}

応答のサンプル

状態コード:200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AIP\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEMAAAmP1Ln1wcHRariNdTMGAO9AAASz8S-AAA=",
  "ChangeKey": "CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AIP",
  "Categories": [
    "Orange category",
    "Green category"
  ],
  "DateTimeCreated": "2014-10-17T17:12:15Z",
  "DateTimeLastModified": "2014-10-19T03:24:35Z",
  "Subject": "Meeting notes from today",
  "BodyPreview": "See attached",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n<style type=\"text/css\" style=\"display:none\"><!-- p { margin-top: 0px; margin-bottom: 0px; }--></style>\r\n</head>\r\n<body dir=\"ltr\">\r\n<div id=\"divtagdefaultwrapper\" style=\"color: rgb(0, 0, 0); font-family: Calibri,Arial,Helvetica,sans-serif; font-size: 12pt; background-color: rgb(255, 255, 255);\">\r\n<p>See attached</p>\r\n</div>\r\n</body>\r\n</html>\r\n"
  },
  "Importance": "Normal",
  "HasAttachments": true,
  "ParentFolderId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAAAAEMAAA=",
  "From": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Alex D"
    }
  },
  "Sender": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Alex D"
    }
  },
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Katie Jordan"
      }
    }
  ],
  "CcRecipients": [],
  "BccRecipients": [],
  "ReplyTo": [],
  "ConversationId": "AAQkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAQANKneItHNYxNlwnKip-qvhs=",
  "DateTimeReceived": "2014-10-17T17:12:15Z",
  "DateTimeSent": "2014-10-17T17:12:12Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": false,
  "IsRead": true
}

応答の種類

更新されたメッセージです。

メッセージを削除する

メッセージを削除する

注意

メッセージを削除するときには注意してください。削除した内容を回復できない可能性があります。詳細については、「アイテムの削除」を参照してください。

メッセージを削除する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.readwrite
wl.imap

DELETE https://outlook.office.com/api/v1.0/me/messages/{message_id}

必須のパラメーター	種類	説明
URL パラメーター
message_id	文字列	削除するメッセージの ID です。

要求のサンプル

DELETE https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0Mz8TBAAA=

応答のサンプル

Status code: 204

メッセージを移動またはコピーする

メッセージをフォルダーに移動またはコピーできます。

メッセージを移動する
メッセージをコピーする

メッセージを移動する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.readwrite
wl.imap

メッセージをフォルダーに移動します。これにより、宛先フォルダーにメッセージの新しいコピーが作成されます。

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/move

必須のパラメーター	種類	説明
URL パラメーター
message_id	文字列	移動するメッセージの ID です。
本文パラメーター
DestinationId	文字列	宛先フォルダーの ID、あるいは `Inbox`、`Drafts`、`SentItems` または `DeletedItems` の既知のフォルダー名です。

要求のサンプル

POST https://outlook.office.com/api/v1.0/me/messages/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEJAACd9nJ-tVysQos2hTfspaWRAAADTIy-AAA=/move

Content-Type: application/json

{
  "DestinationId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEJAAA="
}

応答のサンプル

状態コード :201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqP\"",
  "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEJAACd9nJ-tVysQos2hTfspaWRAAADTshBhAAA=",
  "ChangeKey": "CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqP",
  "Categories": [],
  "DateTimeCreated": "2014-10-20T00:13:21Z",
  "DateTimeLastModified": "2014-10-20T00:13:23Z",
  "Subject": "Contract Signing",
  "BodyPreview": "There will be a detailed legal review of Project Falcon once the contract is ready.",
  "Body": {
    "ContentType": "Text",
    "Content": "There will be a detailed legal review of Project Falcon once the contract is ready."
  },
  "Importance": "Normal",
  "HasAttachments": false,
  "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEJAAA=",
  "From": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Alex D"
    }
  },
  "Sender": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Alex D"
    }
  },
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Katie Jordan"
      }
    },
    {
      "EmailAddress": {
        "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Garth Fort"
      }
    }
  ],
  "CcRecipients": [],
  "BccRecipients": [],
  "ReplyTo": [],
  "ConversationId": "AAQkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAQAKjRc0YJSUBJpofjWgitxag=",
  "DateTimeReceived": "2014-10-20T00:13:21Z",
  "DateTimeSent": "2014-10-20T00:13:21Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": false,
  "IsRead": true
}

応答の種類

移動されたメッセージです。

メッセージをコピーする

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.readwrite
wl.imap

メッセージをフォルダーにコピーします。

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/copy

必須のパラメーター	種類	説明
URL パラメーター
message_id	文字列	コピーするメッセージの ID です。
本文パラメーター
DestinationId	文字列	宛先フォルダーの ID、あるいは `Inbox`、`Drafts`、`SentItems` または `DeletedItems` の既知のフォルダー名です。

要求のサンプル

POST https://outlook.office.com/api/v1.0/me/messages/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEJAACd9nJ-tVysQos2hTfspaWRAAADTIy-AAA=/copy

Content-Type: application/json

{
  "DestinationId": "inbox"
}

応答のサンプル

状態コード :201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AIS\"",
  "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEJAACd9nJ-tVysQos2hTfspaWRAAADT8DtAAA=",
  "ChangeKey": "CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqP",
  "Categories": [],
  "DateTimeCreated": "2014-10-20T00:13:21Z",
  "DateTimeLastModified": "2014-10-20T00:13:23Z",
  "Subject": "Contract Signing",
  "BodyPreview": "There will be a detailed legal review of Project Falcon once the contract is ready.",
  "Body": {
    "ContentType": "Text",
    "Content": "There will be a detailed legal review of Project Falcon once the contract is ready."
  },
  "Importance": "Normal",
  "HasAttachments": false,
  "ParentFolderId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAAAAEMAAA=",
  "From": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Alex D"
    }
  },
  "Sender": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Alex D"
    }
  },
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Katie Jordan"
      }
    },
    {
      "EmailAddress": {
        "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Garth Fort"
      }
    }
  ],
  "CcRecipients": [],
  "BccRecipients": [],
  "ReplyTo": [],
  "ConversationId": "AAQkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAQAKjRc0YJSUBJpofjWgitxag=",
  "DateTimeReceived": "2014-10-20T00:13:21Z",
  "DateTimeSent": "2014-10-20T00:13:21Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": false,
  "IsRead": true
}

応答の種類

メッセージの新しいコピーです。

優先受信トレイを管理する

この機能は v2.0 とベータ版で利用できます。詳細を確認するには、左側の目次で、[Office 365 REST API リファレンス] のセクションに移動し、これらのバージョンのいずれかを選択します。

@- メンションの管理 (プレビュー)

この機能は現在ベータ版で利用できます。詳細を確認するには、左側の目次で、[Office 365 REST API リファレンス] セクションに移動し、[ベータ版] を選択します。

ルールを管理する (プレビュー)

登録を解除する (プレビュー)

言語の選択肢を取得する (プレビュー)

この機能は現在ベータ版でのみ利用できます。詳細を確認するには、左側の目次で、[Office 365 REST API リファレンス] セクションに移動し、[ベータ版] を選択します。

タイムゾーンの選択肢を取得する (プレビュー)

メールボックス設定を取得する

自動返信の設定を取得する

この機能は v2.0 とベータ版で利用できます。詳細を確認するには、左側の目次で、Office 365 REST API リファレンス のセクションに移動し、これらのバージョンのいずれかを選択します。

自動返信の設定を更新する

メールヒントを取得する (プレビュー)

添付ファイルを取得する

添付ファイルのコレクションまたは添付ファイルを取得できます。添付ファイルはファイルになります (例:

添付ファイルのコレクションを取得する
添付ファイルを取得する

添付ファイルのコレクションを取得する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.read
wl.imap

特定のメッセージから添付ファイルを取得します。

GET https://outlook.office.com/api/v1.0/me/messages/{message_id}/attachments

必須のパラメーター	種類	説明
URL パラメーター
message_id	文字列	メッセージ ID。

注意

既定では、応答内の各添付ファイルに、その添付ファイルの種類に対応するすべてのプロパティが含まれます。 $select を使用して、最適なパフォーマンスのために必要なプロパティのみを指定します。 Id プロパティは常に返されます。パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリパラメーター」を参照してください。

応答の種類

FileAttachment または ItemAttachment の種類を使用できる添付ファイルコレクション。

要求と応答のサンプル

以下の例は、$select を使用して応答内の各添付ファイルの名前プロパティのみを返すことを指定する方法を示しています。 $select を使用しない場合、添付ファイルに返されるプロパティの完全なリストについては、「添付ファイルを取得する」にある応答のサンプルを参照してください。

要求のサンプル

GET https://outlook.office.com/api/v1.0/me/messages/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEMAACd9nJ-tVysQos2hTfspaWRAAADTHVSAAA=/attachments?$select=Name

応答のサンプル

状態コード:200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages('AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEMAACd9nJ-tVysQos2hTfspaWRAAADTHVSAAA%3D')/Attachments",
  "value": [
    {
      "@odata.type": "#Microsoft.OutlookServices.FileAttachment",
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEMAACd9nJ-tVysQos2hTfspaWRAAADTHVSAAABEgAQANQEWV4bM8FIlPwxj4kShdM=",
      "Name": "minutes.docx",
      "ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
      "Size": 11585,
      "IsInline": false,
      "DateTimeLastModified": "2014-10-20T00:41:52Z",
      "ContentId": null,
      "ContentLocation": null,
      "IsContactPhoto": false,
      "ContentBytes": "UEsDBBQABgAIAAAAIQDCAAA4KQAAAAA="
    }
  ]
}

次の例では、Outlook のメールアイテムである添付ファイルのみの取得を示します。応答には、添付メッセージの ID でもある添付ファイル ID が含まれています。

GET https://outlook.office.com/api/v1.0/me/messages('AAMkADFiNTPAAA=')/attachments

Content-Type: application/json

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages('AAMkADFiNTPAAA%3D')/Attachments",
  "value": [
    {
      "@odata.type": "#Microsoft.OutlookServices.ItemAttachment",
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-20075df800e5@1717622f-1d94-4d0c-9d74-f907ad6677b4')/Messages('AAMkADFiNTPAAA=')/Attachments('AAMkADFiNTAUhhYuYi0=')",
      "Id": "AAMkADFiNTAUhhYuYi0=",
      "Name": "How to retrieve item attachment using Outlook REST API",
      "ContentType": message/rfc822,
      "Size": 71094,
      "IsInline": false,
      "DateTimeLastModified": "2015-09-24T05:57:59Z",
    }
  ]
}

添付ファイルを取得する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.read
wl.imap

特定のメッセージから添付ファイルを取得します。

GET https://outlook.office.com/api/v1.0/me/messages/{message_id}/attachments/{attachment_id}

注意

パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリパラメーター」を参照してください。

必須のパラメーター	種類	説明
URL パラメーター
message_id	文字列	メッセージ ID。
attachment_id	文字列	添付ファイル ID。

注意

添付ファイル ID $select を使用して、最適なパフォーマンスのために必要なプロパティのみを指定します。例については、「添付ファイルのコレクションを取得する」を参照してください。 Id プロパティは常に返されます。パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリパラメーター」を参照してください。

応答の種類

要求された添付ファイルまたはアイテムの添付ファイル。

要求のサンプル

GET https://outlook.office.com/api/v1.0/me/messages/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEMAACd9nJ-tVysQos2hTfspaWRAAADTHVSAAA=/attachments/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEMAACd9nJ-tVysQos2hTfspaWRAAADTHVSAAABEgAQANQEWV4bM8FIlPwxj4kShdM=

応答のサンプル

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages('AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEMAACd9nJ-tVysQos2hTfspaWRAAADTHVSAAA%3D')/Attachments/$entity",
  "@odata.type": "#Microsoft.OutlookServices.FileAttachment",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "Id": "AAMkAGI2j4kShdM=",
  "Name": "minutes.docx",
  "ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
  "Size": 11585,
  "IsInline": false,
  "DateTimeLastModified": "2014-10-20T00:41:52Z",
  "ContentId": null,
  "ContentLocation": null,
  "IsContactPhoto": false,
  "ContentBytes": "UEsDBBQABgAIAAAAIQDCAAA4KQAAAAA=",
}

添付ファイルを作成する

メッセージの添付ファイルまたはアイテムの添付ファイルを作成できます。

添付ファイルを作成する
アイテムの添付ファイルを作成する
参照添付ファイルを作成する

添付ファイルを作成する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.readwrite
wl.imap

メッセージに添付ファイルを追加します。

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/attachments

必須のパラメーター	種類	説明
URL パラメーター
message_id	文字列	メッセージ ID。
本文パラメーター
@odata.type	文字列	`#Microsoft.OutlookServices.FileAttachment`
名前	文字列	添付ファイルの名前。
ContentBytes	バイナリ	添付するファイル。

要求本文に、名前と ContentBytes パラメーターおよび書き込み可能な添付ファイルプロパティを指定します。

応答の種類

新しい添付ファイル。

アイテムの添付ファイルを作成する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.readwrite
wl.imap

メッセージにアイテムの添付ファイルを追加します。

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/attachments

必須のパラメーター	種類	説明
URL パラメーター
message_id	文字列	メッセージ ID。
本文パラメーター
@odata.type	文字列	`#Microsoft.OutlookServices.ItemAttachment`
名前	文字列	添付ファイルの名前。
アイテム	Message または Event エンティティです。	添付するアイテム。

要求本文に、Name と Item パラメーターおよび書き込み可能なアイテムの添付ファイルプロパティを指定します。

応答の種類

新しいアイテムの添付ファイル。

参照添付ファイルを作成する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.readwrite
wl.imap

メッセージに参照添付ファイルを追加します。

この機能は、現在ベータ版でのみ利用可能です。詳細を確認するには、左側の目次で、[Office 365 REST API リファレンス] セクションに移動し、[ベータ版] を選択します。

添付ファイルを削除する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.readwrite
wl.imap

メッセージの指定した添付ファイルを削除します。添付ファイルは、添付ファイルまたはアイテムの添付ファイルにすることができます。

DELETE https://outlook.office.com/api/v1.0/me/messages/{message_id}/attachments/{attachment_id}

必須のパラメーター	種類	説明
URL パラメーター
message_id	文字列	メッセージ ID。
attachment_id	文字列	添付ファイル ID。

要求のサンプル

DELETE https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0Mz8S-AAA=/attachments/AAMkAGE0Mg67gL7o=

応答のサンプル

Status code: 204

フォルダーを取得する

ユーザーのメールボックス内のフォルダーのコレクションまたはフォルダーを取得できます。

フォルダーのコレクションを取得する
フォルダーを取得する

フォルダーのコレクションを取得する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.read
wl.imap

サインイン中のユーザーのルートフォルダーからフォルダーコレクションを取得する (.../me/folders) か、指定したフォルダーから取得します。.../me/folders ショートカットを使用すると、最上位フォルダーのコレクションを取得して、別のフォルダーに移動することができます。

GET https://outlook.office.com/api/v1.0/me/folders
GET https://outlook.office.com/api/v1.0/me/folders/{folder_id}/childfolders

注意

パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリパラメーター」を参照してください。

必須のパラメーター	種類	説明
URL パラメーター
folder_id	文字列	フォルダーの ID、または既知のフォルダー名 `Inbox`、`Drafts`、`SentItems`、または `DeletedItems` (特定のフォルダーからフォルダーを取得する場合) です。

要求のサンプル

GET https://outlook.office.com/api/v1.0/me/folders

応答のサンプル

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Folders",
  "value": [
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEfAAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
      "DisplayName": "Conversation Action Settings",
      "ChildFolderCount": 0
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEKAAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
      "DisplayName": "Deleted Items",
      "ChildFolderCount": 0
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEPAAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
      "DisplayName": "Drafts",
      "ChildFolderCount": 0
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEMAAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
      "DisplayName": "Inbox",
      "ChildFolderCount": 0
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEQAAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
      "DisplayName": "Journal",
      "ChildFolderCount": 0
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEeAAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
      "DisplayName": "Junk Email",
      "ChildFolderCount": 0
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAERAAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
      "DisplayName": "Notes",
      "ChildFolderCount": 0
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAELAAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
      "DisplayName": "Outbox",
      "ChildFolderCount": 0
    }
  ]
}

応答の種類

要求されたフォルダーのコレクションです。

フォルダーを取得する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.read
wl.imap

ID でフォルダーを取得します。

GET https://outlook.office.com/api/v1.0/me/folders/{folder_id}

注意

パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリパラメーター」を参照してください。

必須のパラメーター	種類	説明
URL パラメーター
folder_id	文字列	フォルダーの ID、あるいは `Inbox`、`Drafts`、`SentItems` または `DeletedItems` の既知のフォルダー名です。

要求のサンプル

GET https://outlook.office.com/api/v1.0/me/folders/inbox

応答のサンプル

状態コード:200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Folders/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEJAAA=",
  "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
  "DisplayName": "Inbox",
  "ChildFolderCount": 0,
  "UnreadItemCount": 2,
  "TotalItemCount": 2
}

応答の種類

要求されたフォルダーです。

フォルダー階層を同期する

フォルダーを作成する

新しいフォルダーをフォルダーのコレクションに追加します。

フォルダーを作成する

フォルダーを作成する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.readwrite
wl.imap

DisplayName に指定した名前で子フォルダーを作成します。DisplayName は、フォルダーの唯一の書き込み可能なプロパティです。

POST https://outlook.office.com/api/v1.0/me/folders/{folder_id}/childfolders

必須のパラメーター	種類	説明
URL パラメーター
folder_id	文字列	フォルダーの ID、あるいは `Inbox`、`Drafts`、`SentItems` または `DeletedItems` の既知のフォルダー名です。
本文パラメーター
DisplayName	文字列	フォルダーの表示名です。

要求のサンプル

POST https://outlook.office.com/api/v1.0/me/folders/inbox/childfolders

Content-Type: application/json

{
  "DisplayName": "Company"
}

応答のサンプル

状態コード :201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Folders('inbox')/ChildFolders/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAASz-l_AAA=",
  "ParentFolderId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAAAAEMAAA=",
  "DisplayName": "Company",
  "ChildFolderCount": 0,
  "UnreadItemCount": 2,
  "TotalItemCount": 27
}

応答の種類

新しいフォルダーです。

注釈

最上位フォルダーを作成することはできません。フォルダーを追加できるのは、childfolders エンドポイントのみです。

フォルダーを更新する

フォルダー名を変更します。

フォルダーを更新する

フォルダーを更新する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.readwrite
wl.imap

フォルダー名を DisplayName で指定したものに変更します。この名前は、フォルダーの唯一の書き込み可能なプロパティです。

PATCH https://outlook.office.com/api/v1.0/me/folders/{folder_id}

必須のパラメーター	種類	説明
URL パラメーター
folder_id	文字列	フォルダーの ID、あるいは `Inbox`、`Drafts`、`SentItems` または `DeletedItems` の既知のフォルダー名です。
本文パラメーター
DisplayName	文字列	フォルダーの新しい表示名です。

要求のサンプル

PATCH https://outlook.office.com/api/v1.0/me/folders/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAASz-l_AAA=

Content-Type: application/json

{
  "DisplayName": "Business"
}

応答のサンプル

状態コード:200

}
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Folders/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAASz-l_AAA=",
  "ParentFolderId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAAAAEMAAA=",
  "DisplayName": "Business",
  "ChildFolderCount": 0,
  "UnreadItemCount": 4,
  "TotalItemCount": 38
}

応答の種類

更新されたフォルダーです。

フォルダーを削除する

フォルダーとそのすべての内容を削除します。

注意

フォルダーを削除するときには注意してください。削除した内容を回復できない可能性があります。詳細については、「アイテムの削除」を参照してください。

フォルダーを削除する

フォルダーを削除する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.readwrite
wl.imap

folder_id で指定したフォルダーを削除します。

DELETE https://outlook.office.com/api/v1.0/me/folders/{folder_id}

必須のパラメーター	種類	説明
URL パラメーター
folder_id	文字列	フォルダーの ID、あるいは `Inbox`、`Drafts`、`SentItems` または `DeletedItems` の既知のフォルダー名です。

要求のサンプル

DELETE https://outlook.office.com/api/v1.0/me/MailFolders/AAMkAGE0Mz-l_AAA=

応答のサンプル

Status code: 204

フォルダーを移動またはコピーする

フォルダーを別のフォルダーに移動またはコピーできます。

フォルダーを移動する
フォルダーをコピーする

フォルダーを移動する

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.readwrite
wl.imap

フォルダーとその内容を別のフォルダーに移動するには、Move メソッドを使用します。

POST https://outlook.office.com/api/v1.0/me/folders/{folder_id}/move

必須のパラメーター	種類	説明
URL パラメーター
folder_id	文字列	フォルダーの ID、あるいは `Inbox`、`Drafts`、`SentItems` または `DeletedItems` の既知のフォルダー名です。
本文パラメーター
DestinationId	文字列	宛先フォルダーの ID、あるいは `Inbox`、`Drafts`、`SentItems` または `DeletedItems` の既知のフォルダー名です。

要求のサンプル

POST https://outlook.office.com/api/v1.0/me/folders/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAASz-l_AAA=/move

Content-Type: application/json

{
  "DestinationId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAOyxQ9AAA="
}

応答のサンプル

状態コード :201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Folders/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAASz-l_AAA=",
  "ParentFolderId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAOyxQ9AAA=",
  "DisplayName": "Business",
  "ChildFolderCount": 0,
  "UnreadItemCount": 4,
  "TotalItemCount": 38
}

応答の種類

移動されたフォルダーです。

フォルダーをコピーする

最低限必要なスコープ

以下のいずれか一つ：

https://outlook.office.com/mail.readwrite
wl.imap

フォルダーとその内容を別のフォルダーにコピーするには、Copy メソッドを使用します。

POST https://outlook.office.com/api/v1.0/me/folders/{folder_id}/copy

必須のパラメーター	種類	説明
URL パラメーター
folder_id	文字列	フォルダーの ID、あるいは `Inbox`、`Drafts`、`SentItems` または `DeletedItems` の既知のフォルダー名です。
本文パラメーター
DestinationId	文字列	宛先フォルダーの ID、あるいは `Inbox`、`Drafts`、`SentItems` または `DeletedItems` の既知のフォルダー名です。

要求のサンプル

POST https://outlook.office.com/api/v1.0/me/folders/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAASz-l_AAA=/copy

Content-Type: application/json

{
  "DestinationId": "inbox"
}

応答のサンプル

状態コード :201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Folders/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAASz-mAAAA=",
  "ParentFolderId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAAAAEMAAA=",
  "DisplayName": "Business",
  "ChildFolderCount": 0,
  "UnreadItemCount": 4,
  "TotalItemCount": 38
}

応答の種類

フォルダーの新しいコピーです。

次の手順

アプリケーション開発を開始する準備ができている方にも、単に詳しい情報を必要としている方にも、最適なコンテンツをご用意しています。

メール、予定表、および連絡先 REST API の使用を開始します。
サンプルについては、こちらをご覧ください。

Office 365 プラットフォームの使い方の詳細については、次のリンク先をご覧ください。

Share via

Outlook メール REST API 参照 (バージョン 1.0)

すべてのメール API の操作

メッセージの操作

フォルダー操作

関連項目

メール REST API を使用する

認証

API のバージョン

対象ユーザー

メッセージを取得する

メッセージ コレクションを取得する

最低限必要なスコープ

要求のサンプル

応答のサンプル

応答の種類

メッセージを取得する

最低限必要なスコープ

要求のサンプル

応答のサンプル

応答の種類

メッセージを同期する

メッセージを作成して送信する

オンザフライで新しいメッセージを送信する

最低限必要なスコープ

要求のサンプル

応答のサンプル

下書きメッセージを作成する

最低限必要なスコープ

要求のサンプル

応答のサンプル

応答の種類

下書きメッセージを送信する

最低限必要なスコープ

要求のサンプル

応答のサンプル

メッセージに返信、または全部のメッセージに返信

オンザフライで送信者に返信する

最低限必要なスコープ

要求のサンプル

応答のサンプル

オンザフライで全員に返信する

最低限必要なスコープ

要求のサンプル

応答のサンプル

下書きの返信メッセージを作成する

最低限必要なスコープ

要求のサンプル

応答のサンプル

応答の種類

下書きの全員に返信メッセージを作成する

最低限必要なスコープ

要求のサンプル

応答のサンプル

応答の種類

新規または下書きメッセージを転送する

メッセージを直接転送する

最低限必要なスコープ

要求のサンプル

応答のサンプル

転送メッセージの下書きを作成する

最低限必要なスコープ

要求のサンプル

応答のサンプル

応答の種類

メッセージを更新する

メッセージを更新する

最低限必要なスコープ

要求のサンプル

応答のサンプル

応答の種類

メッセージを削除する

メッセージを削除する

最低限必要なスコープ

要求のサンプル

応答のサンプル

メッセージを移動またはコピーする

メッセージを移動する

最低限必要なスコープ

要求のサンプル

メッセージコレクションを取得する

タイムゾーンの選択肢を取得する (プレビュー)

メールヒントを取得する (プレビュー)