次の方法で共有

Outlook メール REST API リファレンス (ベータ版)

  • [アーティクル]

適用対象: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com

注意

このドキュメントでは、現時点ではプレビュー段階の @- メンション、登録解除メッセージ、クイック応答、および言語とタイム ゾーンの選択肢に対応する API についても説明しています。プレビュー機能は、最終版までに変更される場合があり、それらの機能を使用するコードが動作しなくなる場合もあります。このため、一般に、運用コードでは運用バージョンの API のみを使用してください。入手可能な場合、現時点ではバージョン 2.0 が優先バージョンです。

ベータ版の API が不要な場合 左の目次で、** 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 の使用」を参照してください。

メッセージを取得する

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

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

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

Prefer: outlook.allow-unsafe-html

GET 要求の Body プロパティと UniqueBody プロパティで返される目的の形式を指定するには、Prefer: outlook.body-content-type ヘッダーを使用します。

  • テキスト形式で返されるメッセージ本文を取得するには、Prefer: outlook.body-content-type="text" を指定します。
  • HTML 形式でメッセージ本文を返すには、Prefer: outlook.body-content-type="html" を指定するか、単にヘッダーをスキップします。

いずれかのヘッダーを指定すると、応答には対応する Preference-Applied ヘッダーが確認として含まれます。

  • テキスト形式要求の場合: Preference-Applied: outlook.body-content-type="text"
  • HTML 形式要求の場合: Preference-Applied: outlook.body-content-type="html"

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

最低限必要なスコープ

以下のいずれかです。

注意

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

サインインしたユーザーの ([削除済みアイテム] と [低優先メール] フォルダーを含む) メールボックス全体から、メッセージ コレクションを取得します。

GET https://outlook.office.com/api/beta/me/messages

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

GET https://outlook.office.com/api/beta/me/MailFolders/{folder_id}/messages
必須のパラメーター 種類 説明
URL パラメーター
folder_id string フォルダーの ID、または既知のフォルダー名 Inbox、Drafts、SentItems、または DeletedItems (特定のフォルダーからメッセージを取得する場合) です。AllItems を指定すると、メールボックス全体からすべてのメッセージを返します。

注意

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

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

要求のサンプル

GET https://outlook.office.com/api/beta/me/MailFolders/sentitems/messages/?$select=Sender,Subject

応答のサンプル

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/MailFolders('sentitems')/Messages(Sender,Subject)",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGI2TIzAAAA=')",
            "@odata.etag": "W/\"CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqS\"",
            "Id": "AAMkAGI2TIzAAAA=",
            "Subject": "Meeting Notes",
            "Sender": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGI2TIy-AAA=')",
            "@odata.etag": "W/\"CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqP\"",
            "Id": "AAMkAGI2TIy-AAA=",
            "Subject": "Contract Signing",
            "Sender": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.type": "#Microsoft.OutlookServices.EventMessage",
            "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGI2TIy9AAA=')",
            "@odata.etag": "W/\"CwAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqJ\"",
            "Id": "AAMkAGI2TIy9AAA=",
            "Subject": "Rob:Alex 1:1",
            "Sender": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        }
    ]
}

応答の種類

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

メッセージを取得する

最低限必要なスコープ

以下のいずれかです。

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

GET https://outlook.office.com/api/beta/me/messages/{message_id}
必須のパラメーター 種類 説明
URL パラメーター
message_id string メッセージ ID。

要求のサンプル

GET https://outlook.office.com/api/beta/me/messages/AAMkAGI2THVSAAA=

応答のサンプル

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Messages/$entity",
    "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGI2THVSAAA=')",
    "@odata.etag": "W/\"CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIKz\"",
    "Id": "AAMkAGI2THVSAAA=",
    "CreatedDateTime": "2014-10-20T00:41:57Z",
    "LastModifiedDateTime": "2014-10-20T00:41:57Z",
    "ChangeKey": "CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIKz",
    "InternetMessageId": "SN2PR00M@SN2.namprd00.prod.outlook.com",
    "Categories": [],
    "ReceivedDateTime": "2014-10-20T00:41:57Z",
    "SentDateTime": "2014-10-20T00:41:53Z",
    "HasAttachments": true,
    "Subject": "Re: Meeting Notes",
    "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"
    },
    "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",
    "Importance": "Normal",
    "ParentFolderId": "AAMkAGI2AAEMAAA=",
    "Sender": {
        "EmailAddress": {
            "Name": "Katie Jordan",
            "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com"
        }
    },
    "From": {
        "EmailAddress": {
            "Name": "Katie Jordan",
            "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com"
        }
    },
    "ToRecipients": [
        {
            "EmailAddress": {
                "Name": "Alex D",
                "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
            }
        }
    ],
    "CcRecipients": [],
    "BccRecipients": [],
    "ReplyTo": [],
    "ConversationId": "AAQkAGI2yEto=",
    "ConversationIndex": "AQHRh3zqrkAcds2kw==",
    "IsDeliveryReceiptRequested": false,
    "IsReadReceiptRequested": false,
    "IsRead": false,
    "IsDraft": false,
    "WebLink": "https://outlook.office365.com/owa/?ItemID=AAMkAGI2THVSAAA%3D&exvsurl=1&viewmodel=ReadMessageItem"
}

応答の種類

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

注意

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

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

GET https://outlook.office.com/api/beta/me/messages/AAMkAGE1I5MTAAA=?$select=Sender,Subject

メッセージを同期する

最低限必要なスコープ

以下のいずれかです。

ローカル データ ストアはサーバー上のメッセージと同期できます。メッセージの同期はフォルダー単位の操作であり、たとえば、受信トレイ内のすべてのメッセージを同期できます。フォルダー階層内のメッセージを同期するには、各フォルダーを個別に同期する必要があります。

API では、フォルダー内のすべてのメッセージを取得する完全な同期と、最後の完全な同期から変更されたすべてのメッセージを取得する差分同期の両方がサポートされています。

通常、メール フォルダーを同期するには、2 つ以上の GET 要求が必要です。GET 要求はメッセージを取得するのとよく似た方法で実行できますが、特定の要求ヘッダーおよび必要に応じて deltaToken または skipToken を含める必要があります。

要求ヘッダー

  • 以前の同期要求から返される skipToken を含む同期要求を除き、すべての同期要求で Prefer: odata.track-changes ヘッダーを指定する必要があります。最初の応答で Preference-Applied: odata.track-changes ヘッダーを探して、リソースが同期をサポートすることを確認してから、先に進みます。

  • Prefer: odata.maxpagesize={x} ヘッダーを指定して、要求で返されるメッセージの最大数を指定することができます。

これは、完全なメッセージの同期ラウンドです：

  1. 必須の Prefer: odata.track-changes ヘッダーを指定して最初の GET 要求を行います。同期要求に対する最初の応答では、常に deltaToken が返されます。(2 番目以降の GET 要求は、前の応答で受信した deltaToken または skipToken のいずれかを含むため、最初の GET 要求とは異なります。)

  2. 最初の応答で Preference-Applied: odata.track-changes ヘッダーが返った場合は、フォルダーの同期に進むことができます。

  3. 第 2 の GET 要求を行います。最初の GET 要求から返された Prefer: odata.track-changes ヘッダーと deltaToken を指定して、追加のメッセージがあるかどうかを調べます。第 2 の要求では、追加のメッセージと、さらにメッセージがある場合は skipToken が返され、最後のメッセージが同期された場合は deltaToken が返されます (この場合、同期ラウンドは完了し、停止できます)。

  4. 前の呼び出しから返された skipToken を指定して GET 呼び出しを送信することで、同期を続けます。@odata.deltaLink ヘッダーと再び deltaToken (同期が完了したことを示します) が含まれる最後の応答を受け取ると、停止します。

完全同期ラウンドで受信した最後のデルタ トークンをキャッシュします。 これを使用して、増分同期ラウンドを開始します。

これは増分同期ラウンドです:

  1. 必須の Prefer: odata.track-changes ヘッダーと、完全同期ラウンドの最後の応答で受信したキャッシュ deltaToken を使用して、最初の GET 要求を行います。

  2. 2 番目以降の手順では、完全同期に使用されたパターンに従います。

特定のフォルダー内のメッセージを同期するには

最初の要求

GET https://outlook.office365.com/api/beta/me/MailFolders('{folder_id}')/messages

2 番目の要求、またはそれ以降のラウンドの最初の要求

GET https://outlook.office365.com/api/beta/me/MailFolders('{folder_id}')/messages/?$deltaToken={delta_token}

同じラウンドの 3 番目またはそれ以降の要求

前の応答に skipToken が含まれる場合は、次の同期要求の送信を続けます。@odata.deltaLink ヘッダーと deltaToken を再び含む応答を受け取ったら停止します。

GET https://outlook.office365.com/api/beta/me/MailFolders('{folder_id}')/messages/?$skipToken={skip_token}
パラメーター 型 説明
ヘッダー パラメーター
Prefer odata.track-changes 要求が同期要求であることを示します。ラウンドの最初の 2 つの GET 要求に対して必須です。
優先 odata.maxpagesize 各応答で返されるメッセージの数を設定します。省略可能。
URL パラメーター
folder_id string 同期するフォルダーの ID、または既知のフォルダー名 (Inbox、Drafts、SentItems、DeletedItems)。必須。
deltaToken 文字列 そのフォルダーの最後の同期要求を示すトークン。その前の同期応答で、@odata.deltaLink の値の一部として返されます。2 番目の GET 要求に対して必須です。
skipToken 文字列 ダウンロードするメッセージがまだあることを示すトークン。前の同期応答で @odata.nextLink の値の一部として返され手いる場合は必須です。

既定では、同期はフォルダー内のすべてのプロパティおよびすべてのメッセージを返します。$select クエリ式を使用して、最適なパフォーマンスに必要なプロパティのみを指定します。Id プロパティは常に返されます。

同期は、クエリ式 $select、$top、$expand をサポートします。$filter および $orderby のサポートは制限されており、$search はサポートされていません。

  • サポートされている $filter 式は “$filter=ReceivedDateTime+ge+{value}” または “$filter=ReceivedDateTime+gt+{value}" だけです。
  • サポートされている $orderby 式は “$orderby=ReceivedDateTime+desc” だけです。$orderby 式を含めない場合、戻り値の順序は保証されません。

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

応答の種類

要求されたメッセージと、差分メッセージについてサーバーにメッセージ データの追加ページを要求するための deltaToken または skipToken を含むコレクション。

例

次の例では、7 通のメッセージが含まれる特定のフォルダーを同期するための一連の要求を示します。最初の同期要求では、一度に 2 通のメッセージを返し (odata.maxpagesize が 2)、各メッセージの Sender プロパティと Subject プロパティだけを返すように指定します。

  • 最初の応答では、2 通のメッセージ、deltaLink、および deltaToken が返されます。
  • 2 番目の要求では、その deltaToken を使用します。2 番目の応答では、2 通のメッセージ、nextLink、および skipToken が返されます。
  • 同期を完了するには、4 番目の同期応答で deltaLink と deltaToken が返されるまで (この場合、このラウンドの同期は完了します)、前の同期要求で返された skipToken を 3 番目と 4 番目の要求で使用します。次のラウンドの同期のために deltaToken を保存します。

最初の要求のサンプル

GET https://outlook.office.com/api/beta/Me/MailFolders('AAMkAGI5MAAAwW-j-AAA=')/messages?$select=Subject,Sender HTTP/1.1
Prefer: odata.maxpagesize=2
Prefer: odata.track-changes

最初の応答データのサンプル

最初の応答には、このフォルダーが同期をサポートすることを示す Preference-Applied: odata.track-changes ヘッダーが含まれます。応答には、2 つのメッセージと deltaToken も含まれます。

Preference-Applied: odata.track-changes

{
  "@odata.context":"https://outlook.office.com/api/beta/$metadata#Me/MailFolders('AAMkAGI5MAAAwW-j-AAA%3D')/Messages(Subject,Sender)",
  "value":[
    {
      "@odata.id":"https://outlook.office.com/api/beta/Users('f97adce1-d718-4a0e-9af8-b10167e3a346@0d76cf04-f6a0-46cc-947b-d2e1bdd98d11')/Messages('AAMkAGI5MAAAwXADPAAA=')",
      "@odata.etag":"W/\"CQAAABYAAAA+Z5tnXBgBRpOasqS9T0shAAAwYS9+\"",
      "Id":"AAMkAGI5MAAAwXADPAAA=",
      "Subject":"Updates from All Company",
      "Sender":{
        "EmailAddress":{
          "Name":"Contoso Demo on Yammer",
          "Address":"noreply@yammer.com"
        }
      }
    },
    {
      "@odata.id":"https://outlook.office.com/api/beta/Users('f97adce1-d718-4a0e-9af8-b10167e3a346@0d76cf04-f6a0-46cc-947b-d2e1bdd98d11')/Messages('AAMkAGI5MAAAwXADVAAA=')",
      "@odata.etag":"W/\"CQAAABYAAAA+Z5tnXBgBRpOasqS9T0shAAAwYS+E\"",
      "Id":"AAMkAGI5MAAAwXADVAAA=",
      "Subject":"RE: Latin American Ad Campaign - XT Series",
      "Sender":{
        "EmailAddress":{
          "Name":"Alex Darrow",
          "Address":"AlexD@contoso.onmicrosoft.com"
        }
      }
    }
  ],
  "@odata.deltaLink":"https://outlook.office.com/api/beta/Me/MailFolders('AAMkAGI5MAAAwW-j-AAA=')/messages/?%24select=Subject%2cSender&%24deltatoken=MfzCBD5nm2dcGAFGk5qypL1PSyEAADFmX28BAAAA"
}

2 番目の要求のサンプル

2 番目の要求では、前の応答で返された deltaToken を指定します。

GET https://outlook.office.com/api/beta/Me/MailFolders('AAMkAGI5MAAAwW-j-AAA=')/messages/?%24select=Subject%2cSender&%24deltatoken=MfzCBD5nm2dcGAFGk5qypL1PSyEAADFmX28BAAAA HTTP/1.1
Prefer: odata.maxpagesize=2
Prefer: odata.track-changes

2 番目の応答データのサンプル

2 番目の応答には、次の 2 つのメッセージと、フォルダーに同期するメッセージがまだあることを示す skipToken が含まれます。

{
  "@odata.context":"https://outlook.office.com/api/beta/$metadata#Me/MailFolders('AAMkAGI5MAAAwW-j-AAA%3D')/Messages(Subject,Sender)/$delta",
  "value":[
    {
      "@odata.id":"https://outlook.office.com/api/beta/Users('f97adce1-d718-4a0e-9af8-b10167e3a346@0d76cf04-f6a0-46cc-947b-d2e1bdd98d11')/Messages('AAMkAGI5MAAAwXADQAAA=')",
      "@odata.etag":"W/\"CQAAABYAAAA+Z5tnXBgBRpOasqS9T0shAAAwYS9/\"",
      "Id":"AAMkAGI5MAAAwXADQAAA=",
      "Subject":"International Launch Planning for XT2000",
      "Sender":{
        "EmailAddress":{
          "Name":"Engineering",
          "Address":"engineering@contoso.onmicrosoft.com"
        }
      }
    },
    {
      "@odata.id":"https://outlook.office.com/api/beta/Users('f97adce1-d718-4a0e-9af8-b10167e3a346@0d76cf04-f6a0-46cc-947b-d2e1bdd98d11')/Messages('AAMkAGI5MAAAwXADUAAA=')",
      "@odata.etag":"W/\"CQAAABYAAAA+Z5tnXBgBRpOasqS9T0shAAAwYS+D\"",
      "Id":"AAMkAGI5MAAAwXADUAAA=",
      "Subject":"RE: Latin American Ad Campaign - XT Series",
      "Sender":{
        "EmailAddress":{
          "Name":"Anne Wallace",
          "Address":"AnneW@contoso.onmicrosoft.com"
        }
      }
    }
  ],
  "@odata.nextLink":"https://outlook.office.com/api/beta/Me/MailFolders('AAMkAGI5MAAAwW-j-AAA=')/messages/?%24select=Subject%2cSender&%24skipToken=MfzCAj5nm2dcGAFGk5qypL1PSyEAADFmX28CAAAA"
}

3 番目の要求のサンプル

3 番目の要求には、前の応答から返される skipToken が含まれます。

GET https://outlook.office.com/api/beta/Me/MailFolders('AAMkAGI5MAAAwW-j-AAA=')/messages/?%24select=Subject%2cSender&%24skipToken=MfzCAj5nm2dcGAFGk5qypL1PSyEAADFmX28CAAAA HTTP/1.1
Prefer: odata.maxpagesize=2

3 番目の応答データのサンプル

3 番目の応答では、さらに 2 つのメッセージと、フォルダーに同期するメッセージがまだあることを示す別の skipToken が返されます。

{
  "@odata.context":"https://outlook.office.com/api/beta/$metadata#Me/MailFolders('AAMkAGI5MAAAwW-j-AAA%3D')/Messages(Subject,Sender)/$delta",
  "value":[
    {
      "@odata.id":"https://outlook.office.com/api/beta/Users('f97adce1-d718-4a0e-9af8-b10167e3a346@0d76cf04-f6a0-46cc-947b-d2e1bdd98d11')/Messages('AAMkAGI5MAAAwXADTAAA=')",
      "@odata.etag":"W/\"CQAAABYAAAA+Z5tnXBgBRpOasqS9T0shAAAwYS+C\"",
      "Id":"AAMkAGI5MAAAwXADTAAA=",
      "Subject":"RE: Latin American Ad Campaign - XT Series",
      "Sender":{
        "EmailAddress":{
          "Name":"Pavel Bansky",
          "Address":"PavelB@contoso.onmicrosoft.com"
        }
      }
    },
    {
      "@odata.id":"https://outlook.office.com/api/beta/Users('f97adce1-d718-4a0e-9af8-b10167e3a346@0d76cf04-f6a0-46cc-947b-d2e1bdd98d11')/Messages('AAMkAGI5MAAAwXADSAAA=')",
      "@odata.etag":"W/\"CQAAABYAAAA+Z5tnXBgBRpOasqS9T0shAAAwYS+B\"",
      "Id":"AAMkAGI5MAAAwXADSAAA=",
      "Subject":"Latin American Ad Campaign - XT Series",
      "Sender":{
        "EmailAddress":{
          "Name":"Engineering",
          "Address":"engineering@contoso.onmicrosoft.com"
        }
      }
    }
  ],
  "@odata.nextLink":"https://outlook.office.com/api/beta/Me/MailFolders('AAMkAGI5MAAAwW-j-AAA=')/messages/?%24select=Subject%2cSender&%24skipToken=MfzCAj5nm2dcGAFGk5qypL1PSyEAADFmX28DAAAA"
}

4 番目の要求のサンプル

4 番目の要求には、前の応答で返された skipToken を含めます。

GET https://outlook.office.com/api/beta/Me/MailFolders('AAMkAGI5MAAAwW-j-AAA=')/messages/?%24select=Subject%2cSender&%24skipToken=MfzCAj5nm2dcGAFGk5qypL1PSyEAADFmX28DAAAA HTTP/1.1
Prefer: odata.maxpagesize=2

4 番目と最後の応答データのサンプル

4 番目の応答では、フォルダーに残っている 1 つだけのメッセージと、そのフォルダーの同期が完了したことを示す deltaToken が返されます。そのフォルダーの同期の次のラウンドのために deltaToken を保存します。

{
  "@odata.context":"https://outlook.office.com/api/beta/$metadata#Me/MailFolders('AAMkAGI5MAAAwW-j-AAA%3D')/Messages(Subject,Sender)/$delta",
  "value":[
    {
      "@odata.id":"https://outlook.office.com/api/beta/Users('f97adce1-d718-4a0e-9af8-b10167e3a346@0d76cf04-f6a0-46cc-947b-d2e1bdd98d11')/Messages('AAMkAGI5MAAAwXADRAAA=')",
      "@odata.etag":"W/\"CQAAABYAAAA+Z5tnXBgBRpOasqS9T0shAAAwYS+A\"",
      "Id":"AAMkAGI5MAAAwXADRAAA=",
      "Subject":"Data sheets for the XT2000 ",
      "Sender":{
        "EmailAddress":{
          "Name":"Engineering",
          "Address":"engineering@contoso.onmicrosoft.com"
        }
      }
    }
  ],
  "@odata.deltaLink": "https://outlook.office365.com/api/beta/Me/MailFolders('AAMkAGI5MAAAwW-j-AAA=')/messages/?%24deltaToken=0_zCBD5nm2dcGAFGk5qypL1PSyEAADBb9RkEAAAA"
}

増分同期要求のサンプル

最初の要求には、最後の完全同期応答からの deltaToken が含まれます。

GET https://outlook.office.com/api/beta/Me/MailFolders('AAMkAGI5MAAAwW-j-AAA=')/messages/?%24select=Subject%2cSender&%24deltatoken=0_zCBD5nm2dcGAFGk5qypL1PSyEAADBb9RkEAAAA HTTP/1.1
Prefer: odata.maxpagesize=2
Prefer: odata.track-changes

増分同期要求に対する応答には、フォルダー メッセージ セットへの変更が含まれています。

増分同期応答のサンプル

応答は、メッセージ セットに 1 つの変更が加えられたことを示します。 メッセージが削除されます。


{
  "@odata.context":"https://outlook.office.com/api/beta/$metadata#Me/MailFolders('AAMkAGI5MAAAwW-j-AAA%3D')/Messages(Subject,Sender)/$delta",
  "value": [
        {
            "id": "Messages('AAMkAGY5MDFjNTQyLWI3NzItNGE4My04ZWE4LWQ4YmMwNTJkYTg1YwBGAAAAAAD7fYH1FVR1TayS78jtGGehBwDB1GgBNTpbT6Qe-PzdAR4YAh7cdimCAADwOTzPjXdMTKEex95TwbKkAACLEykWAAA=')",
            "reason": "deleted"
        }
    ]
,
  "@odata.deltaLink": "https://outlook.office365.com/api/beta/Me/MailFolders('AAMkAGI5MAAAwW-j-AAA=')/messages/?%24deltaToken=4_zRDV5nm2dcGAFGk5qypL1PSyEAADBb9RkEAAAA"
}

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

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

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

最低限必要なスコープ

以下のいずれかです。

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

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

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

要求のサンプル

POST https://outlook.office.com/api/beta/me/sendmail
Content-Type: application/json

{
  "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

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

最低限必要なスコープ

以下のいずれかです。

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

POST https://outlook.office.com/api/beta/me/messages
POST https://outlook.office.com/api/beta/me/MailFolders/{folder_id}/messages
必須のパラメーター 種類 説明
URL パラメーター
folder_id string 宛先フォルダーの ID または既知のフォルダー名 (Inbox または Drafts)。

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

要求のサンプル

POST https://outlook.office.com/api/beta/me/MailFolders/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"
      }
    }
  ]
}

応答のサンプル

Status code: 201

{
  "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGE0Mz7k0AAA=')",
  "@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0Ag5\"",
  "Id": "AAMkAGE0Mz7k0AAA=",
  "ChangeKey": "CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0Ag5",
  "Categories": [],
  "InternetMessageId": "SN2PR00M@SN2.namprd00.prod.outlook.com",
  "CreatedDateTime": "2014-10-18T20:06:51Z",
  "LastModifiedDateTime": "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": "AAMkAGE0MAAEPAAA=",
  "From": null,
  "Sender": null,
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Katie Jordan"
      }
    }
  ],
  "CcRecipients": [],
  "BccRecipients": [],
  "ReplyTo": [],
  "ConversationId": "AAQkAGE0Mpv2hisc=",
  "ConversationIndex": "AQHRf4zqrkAcds2kw==",
  "ReceivedDateTime": "2014-10-18T20:06:51Z",
  "SentDateTime": "2014-10-18T20:06:51Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": true,
  "IsRead": true
}

応答の種類

下書きメッセージです。

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

最低限必要なスコープ

以下のいずれかです。

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

POST https://outlook.office.com/api/beta/me/messages/{message_id}/send
必須のパラメーター 種類 説明
URL パラメーター
message_id string 送信する下書きメッセージの ID です。

要求のサンプル

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

応答のサンプル

Status code: 202

メッセージに返信または全員に返信する

注意

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

1 回の呼び出しでメッセージに返信、コメントの追加、またはメッセージ プロパティを更新するか、1 回の呼び出しで最初に返信の下書きを作成してメッセージプロパティを更新してから、下書きを送信することができます。

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

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

最低限必要なスコープ

以下のいずれかです。

1 回の返信呼び出しでメッセージ送信者に返信、コメントを追加、または更新可能なプロパティを変更します。その後、メッセージは [送信済みアイテム] フォルダーに保存されます。

または、最初に下書きの返信メッセージを作成してコメントを含めるか、メッセージのプロパティを更新し、返信を送信します。

POST https://outlook.office.com/api/beta/me/messages/{message_id}/reply
必須のパラメーター 種類 説明
URL パラメーター
message_id string 返信するメッセージの ID です。
本文パラメーター
コメント string 含めるコメントです。空の文字列にすることができます。
メッセージ メッセージ 返信メッセージで更新する書き込み可能なプロパティです。

注意

  • コメントまたは Message パラメーターの Body プロパティを指定できます。両方を指定すると、「HTTP 400 要求が正しくありません」というエラーが返されます。
  • ReplyTo が元のメッセージに指定されている場合、インターネット メッセージ形式 (RFC 2822) ごとに、From の受信者ではなく、ReplyTo の受信者に返信を送信する必要があります。

要求のサンプル

次の例では、コメントを含め、受信者を返信メッセージに追加します。

POST https://outlook.office.com/api/beta/me/messages/AAMkADA1MTAAAAqldOAAA=/reply
Content-Type: application/json

{
  "Message":{  
    "ToRecipients":[
      {
        "EmailAddress": {
          "Address":"fannyd@contoso.onmicrosoft.com",
          "Name":"Fanny Downs"
        }
      },
      {
        "EmailAddress":{
          "Address":"randiw@contoso.onmicrosoft.com",
          "Name":"Randi Welch"
        }
      }
     ]
  },
  "Comment": "Fanny, Randi, would you name the group please?" 
}

応答のサンプル

Status code: 202

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

最低限必要なスコープ

以下のいずれかです。

コメントを指定して、更新可能なプロパティを変更することによってメッセージ受信者全員に返信し、全員に ReplyAll メソッドを使用します。その後、メッセージは [送信済みアイテム] フォルダーに保存されます。

または、最初に下書きの全員に返信メッセージを作成してコメントを含めるか、メッセージのプロパティを更新し、返信を送信します。

POST https://outlook.office.com/api/beta/me/messages/{message_id}/replyall
必須のパラメーター 種類 説明
URL パラメーター
message_id string 返信するメッセージの ID です。
本文パラメーター
コメント string 含めるコメントです。空の文字列にすることができます。
メッセージ メッセージ 全員に返信メッセージで更新する書き込み可能なプロパティです。

注意

  • コメントまたは Message パラメーターの Body プロパティを指定できます。両方を指定すると、「HTTP 400 要求が正しくありません」というエラーが返されます。
  • ReplyTo が元のメッセージに指定されている場合、インターネット メッセージ形式 (RFC 2822) ごとに、From とToRecipients の受信者ではなく、ReplyTo とToRecipients の受信者に返信を送信する必要があります。

要求のサンプル

次の例では、コメントを含め、添付ファイルを全員に返信メッセージに追加します。

POST https://outlook.office.com/api/beta/me/messages/AAMkADA1MTAAAH5JaKAAA=/ReplyAll
Content-Type: application/json

{
    "Message":{
      "Attachments": [ 
        { 
          "@odata.type": "#Microsoft.OutlookServices.FileAttachment", 
          "Name": "guidelines.txt", 
          "ContentBytes": "bWFjIGFuZCBjaGVlc2UgdG9kYXk=" 
        } 
      ]
    },
    "Comment": "Please take a look at the attached guidelines before you decide on the name." 
}

応答のサンプル

Status code: 202

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

最低限必要なスコープ

以下のいずれかです。

1 回の CreateReply 呼び出しで下書きの返信メッセージを作成して、コメントを含めるかメッセージのプロパティを更新します。その後、下書きメッセージを送信できます。

POST https://outlook.office.com/api/beta/me/messages/{message_id}/createreply
必須のパラメーター 種類 説明
URL パラメーター
message_id string 返信するメッセージの ID です。
本文パラメーター
コメント string 含めるコメントです。空の文字列にすることができます。
メッセージ メッセージ 返信メッセージで更新する書き込み可能なプロパティです。

注意

  • コメントまたは Message パラメーターの Body プロパティを指定できます。両方を指定すると、「HTTP 400 要求が正しくありません」というエラーが返されます。
  • ReplyTo が元のメッセージに指定されている場合、インターネット メッセージ形式 (RFC 2822) ごとに、From の受信者ではなく、ReplyTo の受信者に返信する必要があります。

要求のサンプル

次の例では、下書きの返信を作成し、要求の本文にコメントと受信者を追加します。

POST https://outlook.office.com/api/beta/me/messages/AAMkADA1MTAAAAqldOAAA=/createreply
Content-Type: application/json

{
  "Message":{  
    "ToRecipients":[
      {
        "EmailAddress": {
          "Address":"fannyd@contoso.onmicrosoft.com",
          "Name":"Fanny Downs"
        }
      }
     ]
  },
  "Comment": "Fanny, would you name the group if the project is approved, please?" 
}

応答のサンプル

Status code: 201

{
  "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/beta/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=",
  "ConversationIndex": "AQHRdar6akFxUaMjCku9aYa0ij9oUZ9IbLr7gBHStBQ=",
  "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、およびその他の適切なプロパティが事前に設定された下書きの返信メッセージです。

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

最低限必要なスコープ

以下のいずれかです。

1 回の CreateReplyAll 呼び出しで下書きの全員に返信メッセージを作成して、コメントを含めるかメッセージのプロパティを更新します。その後、下書きメッセージを送信できます。

POST https://outlook.office.com/api/beta/me/messages/{message_id}/createreplyall
必須のパラメーター 種類 説明
URL パラメーター
message_id string 全員に返信するメッセージの ID です。
本文パラメーター
コメント string 含めるコメントです。空の文字列にすることができます。
メッセージ メッセージ 全員に返信メッセージで更新する書き込み可能なプロパティです。

注意

  • コメントまたは Message パラメーターの Body プロパティを指定できます。両方を指定すると、「HTTP 400 要求が正しくありません」というエラーが返されます。
  • ReplyTo が元のメッセージに指定されている場合、インターネット メッセージ形式 (RFC 2822) ごとに、From とToRecipients プロパティの受信者ではなく、ReplyTo と ToRecipients プロパティの受信者に返信する必要があります。

要求のサンプル

次の例では、1 回の CreateReplyAll 呼び出しで全員に返信する下書きを作成し、添付ファイルをコメントに追加します。

POST https://outlook.office.com/api/beta/me/messages/AAMkADA1MTAAAH5JaKAAA=/createreplyall
Content-Type: application/json

{
    "Message":{
      "Attachments": [ 
        { 
          "@odata.type": "#Microsoft.OutlookServices.FileAttachment", 
          "Name": "guidelines.txt", 
          "ContentBytes": "bWFjIGFuZCBjaGVlc2UgdG9kYXk=" 
        } 
      ]
    },
    "Comment": "if the project gets approved, please take a look at the attached guidelines before you decide on the name." 
}

応答のサンプル

Status code: 201

{
  "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/beta/Users('86b6ceaf-57f7-4278-97c4-4da0a97f6cdb@70559e59-b378-49ea-8e53-07a3a3d27f5b')/Messages('AAMkADA1MTAAAH5JKpAAA=')",
  "@odata.etag": "W/\"CQAAABYAAADX8oL1Wa7jQbcPAHouCzswAAAH5/DP\"",
  "Id": "AAMkADA1MTAAAH5JKpAAA=",
  "CreatedDateTime": "2016-03-15T08:37:34Z",
  "LastModifiedDateTime": "2016-03-15T08:37:34Z",
  "ChangeKey": "CQAAABYAAADX8oL1Wa7jQbcPAHouCzswAAAH5/DP",
  "Categories": [ ],
  "ReceivedDateTime": "2016-03-15T08:37:34Z",
  "SentDateTime": "2016-03-15T08:37:34Z",
  "HasAttachments": true,
  "InternetMessageId": "<DM2PR00MB005732BE05BD669AC7CE056EF7890@DM2PR00MB0057.namprd00.prod.outlook.com>",
  "Subject": "RE: Let's start a group",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n<body dir=\"ltr\">\r\nif the project gets approved, please take a look at the attached guidelines before you decide on the name.\r\n<b>From:</b> Admin<br>\r\n<b>Sent:</b> Tuesday, March 15, 2016 6:36:32 AM<br>\r\n<b>To:</b> Fanny Downs; Randi Welch<br>\r\n<b>Subject:</b> RE: Let's start a group\r\n<div>Fanny, Randi, would you name the group 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</body>\r\n</html>"
  },
  "BodyPreview": "if the project gets approved, please take a look at the attached guidelines before you decide on the name.\r\n________________________________\r\nFrom: Admin\r\nSent: Tuesday, March 15, 2016 6:36:32 AM\r\nTo: Fanny Downs; Randi Welch\r\nSubj",
  "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"
      }
    },
    {
      "EmailAddress": {
        "Name": "Randi Welch",
        "Address": "randiw@contoso.onmicrosoft.com"
      }
    }
  ],
  "CcRecipients": [ ],
  "BccRecipients": [ ],
  "ReplyTo": [ ],
  "ConversationId": "AAQkADA1MTLvWmGtIo-aFE=",
  "ConversationIndex": "AQHRdar6akFxUaMjCku9aYa0ij9oUZ9IbLr7gBGx9qGAACHRQA==",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsRead": true,
  "IsDraft": true,
  "WebLink": "https://outlook.office.com/owa/?ItemID=AAMkADA1MTAAAH5JKpAAA%3D&exvsurl=1&viewmodel=ReadMessageItem",
  "MentionedMe": null,
  "AppliedHashtagsPreview": null,
  "LikesPreview": null,
  "MentionsPreview": null,
  "Mentioned": [ ],
  "InferenceClassification": "Focused",
  "UnsubscribeData": [ ],
  "UnsubscribeEnabled": false,
  "Flag": { "FlagStatus": "NotFlagged" }
}

応答の種類

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

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

注意

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

1 回の呼び出しでメッセージの転送、コメントの追加、またはメッセージ プロパティの更新をすべて行えます。または、はじめに下書きを作成し、1 回の呼び出しでメッセージ プロパティを更新して、下書きを送信することもできます。

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

最低限必要なスコープ

以下のいずれかです。

1 回の転送呼び出しでメッセージを転送、コメントを追加、または更新可能なプロパティを変更します。その後、メッセージは [送信済みアイテム] フォルダーに保存されます。

または、最初に下書きの転送メッセージを作成してコメントを含めるか、メッセージのプロパティを更新し、転送メッセージを送信します。

POST https://outlook.office.com/api/beta/me/messages/{message_id}/forward
必須のパラメーター 種類 説明
URL パラメーター
message_id string 転送するメッセージの ID です。
本文パラメーター
コメント string 含めるコメントです。空の文字列にすることができます。
ToRecipients コレクション(受信者) 受信者の一覧です。
メッセージ メッセージ 返信メッセージで更新する書き込み可能なプロパティです。

注意

  • コメントまたは Message パラメーターの Body プロパティを指定できます。両方を指定すると、「HTTP 400 要求が正しくありません」というエラーが返されます。
  • パラメーター、または Message パラメーターの ToRecipients プロパティを指定する必要があります。両方を指定するか、どちらも指定しないと、「HTTP 400 要求が正しくありません」というエラーが返されます。ToRecipients

要求のサンプル

次の例では、IsDeliveryReceiptRequested プロパティを true に設定し、コメントを追加してメッセージを転送します。

POST https://outlook.office.com/api/beta/me/messages/AAMkADA1MTAAAH5JaLAAA=/forward
Content-Type: application/json

{
  "Message":{  
    "IsDeliveryReceiptRequested": true,
    "ToRecipients":[
      {
        "EmailAddress": {
          "Address":"danas@contoso.onmicrosoft.com",
          "Name":"Dana Swope"
        }
      }
     ]
  },
  "Comment": "Dana, just want to make sure you get this." 
}

応答のサンプル

Status code: 202

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

最低限必要なスコープ

以下のいずれかです。

1 回の CreateForward 呼び出しで下書きの転送メッセージを作成して、コメントを含めるかメッセージのプロパティを更新します。その後、下書きメッセージを送信できます。

POST https://outlook.office.com/api/beta/me/messages/{message_id}/createforward
必須のパラメーター 種類 説明
URL パラメーター
message_id string 転送するメッセージの ID です。
本文パラメーター
コメント string 含めるコメントです。空の文字列にすることができます。
ToRecipients コレクション(受信者) 受信者の一覧です。
メッセージ メッセージ 返信メッセージで更新する書き込み可能なプロパティです。

注意

  • コメントまたは Message パラメーターの Body プロパティを指定できます。両方を指定すると、「HTTP 400 要求が正しくありません」というエラーが返されます。
  • パラメーター、または Message パラメーターの ToRecipients プロパティを指定する必要があります。両方を指定するか、どちらも指定しないと、「HTTP 400 要求が正しくありません」というエラーが返されます。ToRecipients

要求のサンプル

POST https://outlook.office.com/api/beta/me/messages/AAMkADA1MTAAAH5JaLAAA=/createforward
Content-Type: application/json

{
  "Message":{  
    "IsDeliveryReceiptRequested": true,
    "ToRecipients":[
      {
        "EmailAddress": {
          "Address":"danas@contoso.onmicrosoft.com",
          "Name":"Dana Swope"
        }
      }
     ]
  },
  "Comment": "Dana, just want to make sure you get this; you'll need this if the project gets approved." 
}

応答のサンプル

Status code: 201

{
  "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/beta/Users('86b6ceaf-57f7-4278-97c4-4da0a97f6cdb@70559e59-b378-49ea-8e53-07a3a3d27f5b')/Messages('AAMkADA1MTAAAH5JKqAAA=')",
  "@odata.etag": "W/\"CQAAABYAAADX8oL1Wa7jQbcPAHouCzswAAAH5/DQ\"",
  "Id": "AAMkADA1MTAAAH5JKqAAA=",
  "CreatedDateTime": "2016-03-15T08:42:10Z",
  "LastModifiedDateTime": "2016-03-15T08:42:10Z",
  "ChangeKey": "CQAAABYAAADX8oL1Wa7jQbcPAHouCzswAAAH5/DQ",
  "Categories": [ ],
  "ReceivedDateTime": "2016-03-15T08:42:10Z",
  "SentDateTime": "2016-03-15T08:42:10Z",
  "HasAttachments": true,
  "InternetMessageId": "<DM2PR00MB0057E0EBC90EF37FC9233941F7890@DM2PR00MB0057.namprd00.prod.outlook.com>",
  "Subject": "FW: Let's start a group",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n<body>\r\nDana, just want to make sure you get this; you'll need this if the project gets approved.\r\n<b>From:</b> Admin<br>\r\n<b>Sent:</b> Tuesday, March 15, 2016 6:47:54 AM<br>\r\n<b>To:</b> Fanny Downs; Randi Welch<br>\r\n<b>Subject:</b> RE: Let's start a group</body>\r\n</html>\r\n"
  },
  "BodyPreview": "Dana, just want to make sure you get this; you'll need this if the project gets approved.\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",
  "Importance": "Normal",
  "ParentFolderId": "AQMkADA1MTAAAAIBDwAAAA==",
  "Sender": {
    "EmailAddress": {
      "Name": "Admin",
      "Address": "admin@contoso.onmicrosoft.com"
    }
  },
  "From": null,
  "ToRecipients": [
    {
      "EmailAddress": {
        "Name": "Dana Swope",
        "Address": "danas@contoso.onmicrosoft.com"
      }
    }
  ],
  "CcRecipients": [ ],
  "BccRecipients": [ ],
  "ReplyTo": [ ],
  "ConversationId": "AAQkADA1MTLvWmGtIo-aFE=",
  "ConversationIndex": "AQHRdar6akFxUaMjCku9aYa0ij9oUZ9IbLr7gBGx9qGAAAMtlIAAH+3c",
  "IsDeliveryReceiptRequested": true,
  "IsReadReceiptRequested": false,
  "IsRead": true,
  "IsDraft": true,
  "WebLink": "https://outlook.office.com/owa/?ItemID=AAMkADA1MTAAAH5JKqAAA%3D&exvsurl=1&viewmodel=ReadMessageItem",
  "MentionedMe": null,
  "AppliedHashtagsPreview": null,
  "LikesPreview": null,
  "MentionsPreview": null,
  "Mentioned": [ ],
  "InferenceClassification": "Focused",
  "UnsubscribeData": [ ],
  "UnsubscribeEnabled": false,
  "Flag": { "FlagStatus": "NotFlagged" }
}

応答の種類

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

メッセージを更新する

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

メッセージを更新する

最低限必要なスコープ

以下のいずれかです。

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

PATCH https://outlook.office.com/api/beta/me/messages/{message_id}
必須のパラメーター 種類 説明
URL パラメーター
message_id string 更新するメッセージの ID です。

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

要求のサンプル

次の要求のサンプルでは、メール メッセージに 2 つの分類項目をセットし、開始日と期限日の付いたフラグを設定します。

注意

メモ: FlagStatus が Flagged に設定されている場合は、Flag.CompletedDate プロパティは設定しないでください。

PATCH https://outlook.office.com/api/beta/me/messages/AAMkAGE0Mz8S-AAA=
Content-Type: application/json

{
  "Categories": [
    "Orange category",
    "Green category"
  ],
  "IsRead": true,
  "Flag": {
    "FlagStatus": "Flagged",
      DueDateTime": {
      "DateTime": "2017-12-22T08:00:00.0000000",
      "TimeZone": "UTC"
    },
    "StartDateTime": {
      "DateTime": "2017-12-18T08:00:00.0000000",
      "TimeZone": "UTC"
    }
  }
}

応答のサンプル

Status code: 200


{
  "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGE0Mz8S-AAA=')",
  "@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AIP\"",
  "Id": "AAMkAGE0Mz8S-AAA=",
  "ChangeKey": "CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AIP",
  "InternetMessageId": "SN2PR00M@SN2.namprd00.prod.outlook.com",
  "Categories": [
    "Orange category",
    "Green category"
  ],
  "CreatedDateTime": "2014-10-17T17:12:15Z",
  "LastModifiedDateTime": "2014-10-19T03:24:35Z",
  "Subject": "Meeting notes from today",
  "BodyPreview": "See attached",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n...</html>\r\n"
  },
  "Importance": "Normal",
  "HasAttachments": true,
  "ParentFolderId": "AAMkAGE0MAAEMAAA=",
  "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": "AAQkAGE0Mip-qvhs=",
  "ConversationIndex": "AQHRh5tqrkAcds2kw==",
  "ReceivedDateTime": "2014-10-17T17:12:15Z",
  "SentDateTime": "2014-10-17T17:12:12Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": false,
  "IsRead": true,
  "Flag": {
    "FlagStatus": "Flagged",
    "DueDateTime": {
      "DateTime": "2017-12-22T08:00:00.0000000",
      "TimeZone": "UTC"
    },
    "StartDateTime": {
      "DateTime": "2017-12-18T08:00:00.0000000",
      "TimeZone": "UTC"
    }
  }
}

要求のサンプル

次の要求のサンプルでは、以前にフラグが立てられたメール メッセージを完了済みとしてマークします。

PATCH https://outlook.office.com/api/beta/me/messages/AAMkADk0MGFkODE3LWE4MmYtNDRhOS04OGQxLTM4NzJkSLkRkXbBznTvAAEwgCZNAAA= 
Content-Type: application/json; charset=utf-8
Content-Length: 164


{
  "Flag": {
    "CompletedDateTime":{
      "DateTime": "2018-02-05T18:00:00",
      "TimeZone": "Pacific Standard Time"
    },
    "FlagStatus": "Complete"
  }
}

応答のサンプル

HTTP/1.1 200 OK

{
    "Id": "AAMkADk0MGFkODE3LWE4MmYtNDRhOS04OGQxLTM4NzJkSLkRkXbBznTvAAEwgCZNAAA=",
    "CreatedDateTime": "2017-12-15T22:11:41Z",
    "LastModifiedDateTime": "2017-12-16T00:49:44Z",
    "ChangeKey": "CQAAABYAAABmngqUDhbeSLkRkXbBznTvAAEw/ThM",
    "Categories": [],
    "ReceivedDateTime": "2017-12-15T22:11:41Z",
    "SentDateTime": "2017-12-15T22:11:36Z",
    "HasAttachments": false,
    "InternetMessageId": "<e711230d-d066-469e-a128-c429c5789d97@SINGMEHUB02.gme.gbl>",
    "Subject": "An agent sent you a message in Microsoft Teams",
    "BodyPreview": "Hi John,\r\nYou're missing all the action in Microsoft Teams\r\n\r\n\r\nAn agent\r\nSent a new message to your chat\r\n\r\n         Open Microsoft Teams\r\n\r\nRather not receive these emails? Click your profile picture, select Options and then Notificatio",
    "Importance": "Normal",
    "ParentFolderId": "AAMkADk0MGFkODE3LWE4MmYtNDRhOS04OGQxLTM4NzJkNzQ0NWVlMgAuAAAAAAB79HWXBjsTRocnYZpOfEpCAQCHGmLqkYhISaO_lSymODLQABa6L5YsAAA=",
    "ConversationId": "AAQkADk0MGFkODE3LWE4MmYtNDRhOS04OGQxLTM4NzJkNzQ0NWVlMgAQAPQcMVQTnE5Aql13YD1jbQw=",
    "ConversationIndex": "AQHTdfGv9BwxVBOcTkCqXXdgPWNtDA==",
    "IsDeliveryReceiptRequested": null,
    "IsReadReceiptRequested": false,
    "IsRead": true,
    "IsDraft": false,
    "WebLink": "https://outlook.office365.com/owa/?ItemID=AAMkADTvAAEwgCZNAAA%3D&exvsurl=1&viewmodel=ReadMessageItem",
    "InferenceClassification": "Other",
    "UnsubscribeData": [],
    "UnsubscribeEnabled": false,
    "Body": {
        "ContentType": "HTML",
        "Content": "<html style=\"font-family:'Segoe UI',Tahoma,Geneva,Verdana,sans-serif; font-size:18px\"></html>\r\n"
    },
    "Sender": {
        "EmailAddress": {
            "Name": "Microsoft Teams",
            "Address": "noreply@email.teams.microsoft.com"
        }
    },
    "From": {
        "EmailAddress": {
            "Name": "Microsoft Teams",
            "Address": "noreply@email.teams.microsoft.com"
        }
    },
    "ToRecipients": [
        {
            "EmailAddress": {
                "Name": "John",
                "Address": "john@contoso.com"
            }
        }
    ],
    "CcRecipients": [],
    "BccRecipients": [],
    "ReplyTo": [],
    "MentionsPreview": null,
    "Flag": {
        "FlagStatus": "Complete",
        "CompletedDateTime": {
            "DateTime": "2018-02-06T00:00:00.0000000",
            "TimeZone": "UTC"
        }
    }
}

応答の種類

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

メッセージを削除する

注意

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

メッセージを削除する

最低限必要なスコープ

以下のいずれかです。

DELETE https://outlook.office.com/api/beta/me/messages/{message_id}
必須のパラメーター 種類 説明
URL パラメーター
message_id string 削除するメッセージの ID です。

要求のサンプル

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

応答のサンプル

Status code: 204

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

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

メッセージを移動する

最低限必要なスコープ

以下のいずれかです。

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

POST https://outlook.office.com/api/beta/me/messages/{message_id}/move
必須のパラメーター 種類 説明
URL パラメーター
message_id string 移動するメッセージの ID です。
本文パラメーター
DestinationId string 宛先フォルダーの ID、あるいは Inbox、Drafts、SentItems または DeletedItems の既知のフォルダー名です。

要求のサンプル

POST https://outlook.office.com/api/beta/me/messages/AAMkAGI2TIy-AAA=/move
Content-Type: application/json

{
  "DestinationId": "AAMkAGI2AAEJAAA="
}

応答のサンプル

Status code: 201

{
  "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGE0MGz_vSAAA=')",
  "@odata.etag": "W/\"CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqP\"",
  "Id": "AAMkAGI2shBhAAA=",
  "ChangeKey": "CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqP",
  "InternetMessageId": "SN2PR00M@SN2.namprd00.prod.outlook.com",
  "Categories": [],
  "CreatedDateTime": "2014-10-20T00:13:21Z",
  "LastModifiedDateTime": "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": "AAMkAGI2AAEJAAA=",
  "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": "AAQkAGI2NGWgitxag=",
  "ConversationIndex": "AQHRh6etrkAcds2kw==",
  "ReceivedDateTime": "2014-10-20T00:13:21Z",
  "SentDateTime": "2014-10-20T00:13:21Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": false,
  "IsRead": true
}

応答の種類

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

メッセージをコピーする

最低限必要なスコープ

以下のいずれかです。

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

POST https://outlook.office.com/api/beta/me/messages/{message_id}/copy
必須のパラメーター 種類 説明
URL パラメーター
message_id string コピーするメッセージの ID です。
本文パラメーター
DestinationId string 宛先フォルダーの ID、あるいは Inbox、Drafts、SentItems または DeletedItems の既知のフォルダー名です。

要求のサンプル

POST https://outlook.office.com/api/beta/me/messages/AAMkAGI2TIy-AAA=/copy
Content-Type: application/json

{
  "DestinationId": "inbox"
}

応答のサンプル

Status code: 201

{
  "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGE0Mz8TDAAA=')",
  "@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AIS\"",
  "Id": "AAMkAGI2T8DtAAA=",
  "ChangeKey": "CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqP",
  "InternetMessageId": "SN2PR00M@SN2.namprd00.prod.outlook.com",
  "Categories": [],
  "CreatedDateTime": "2014-10-20T00:13:21Z",
  "LastModifiedDateTime": "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": "AAMkAGE0MAAEMAAA=",
  "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=",
  "ConversationIndex": "AQHRh6sdrkAcds2kw==",
  "ReceivedDateTime": "2014-10-20T00:13:21Z",
  "SentDateTime": "2014-10-20T00:13:21Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": false,
  "IsRead": true
}

応答の種類

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

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

優先受信トレイでは、受信トレイの Focused タブに重要メッセージを表示し、その他の受信トレイのメッセージを Other タブに表示します。システム主体の分類方法によって、既定の方法で受信トレイのメッセージが整理されます。ユーザー インターフェイスまたはプログラムを介して、時間の経過によってシステムを修正し、学習させることができます。使用頻度が増えるほど、システムは、受信したメッセージの重要性をより高い精度で予想できるようになります。

プログラム レベルでは、優先受信トレイ REST API は指定のユーザー メッセージで機能し、メッセージごとの InferenceClassificationプロパティをサポートします。使用可能な値は Focused と Other であり、ユーザーがそれぞれのメッセージの重要性をどのように見なしているかを示しています。メッセージ分類システムを修正し学習させるには、メッセージ レベルで InferenceClassification プロパティの PATCH 操作を使用します。

優先受信トレイ REST API では、オーバーライドを作成することもできます。それぞれのオーバーライドは InferenceClassificationOverride インスタンスで表され、分類システムが常に一貫した方法 (常に "優先" または "その他") で、それまでに学習した方法に関係なく、特定の送信者からのメッセージを指定するように指示するものです。指定したユーザーのオーバーライドを作成、取得、更新、削除することができます。そのユーザーのオーバーライド (ある場合) は、InferenceClassification インスタンスのコレクションである、InferenceClassificationOverride ナビゲーション プロパティでアクセスできます。オーバーライドでは、ユーザーは受信メッセージの分類をさらに細かく制御でき、分類システムの信頼性を高めることができます。

分類システムでは受信トレイの受信メッセージについてのみ分類を学習し、適用することに注意してください。その他のフォルダーにあるメッセージは、既定で "優先" になっています。オーバーライドの設定は、今後、受信トレイに入ってくるメッセージに反映され、オーバーライドでは、受信トレイを含むフォルダーにある既存のメッセージの InferenceClassification プロパティは変更されません。

メッセージ分類システムの記憶

オーバーライドを使用した、送信者ごとに一貫した分類

メッセージ分類を更新する

最低限必要なスコープ

以下のいずれかです。

指定したメッセージの InferenceClassification プロパティを変更します。メッセージが受信トレイにある場合は、該当する Focused または Other タブでユーザーにメッセージが表示されます。この種の訂正によって、メッセージ分類システムは、指定したユーザーに関する将来の分類をカスタマイズする方法を学習します。

PATCH https://outlook.office.com/api/beta/me/messages('{message_id}')

PATCH https://outlook.office.com/api/beta/Users('{user_id}')/messages('{message_id}')
パラメーター 型 説明
URL パラメーター
message_id string 送信する下書きメッセージの ID です。
user_id string ユーザーの電子メール アドレスです。

応答の種類

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

要求のサンプル

この例では、サインイン ユーザーの指定したメッセージについて InferenceClassification プロパティを Other に変更します。

PATCH https://outlook.office.com/api/beta/me/messages('AAMkADA1MTQBAAA=')

{
    "InferenceClassification": "Other"
}

応答のサンプル

個々に示す応答オブジェクトは、更新された InferenceClassification プロパティを示しており、切り詰めて簡略化されています。実際の PATCH 要求では、メッセージのすべてのプロパティが返されます。

Status code: 200 OK

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Messages/$entity",
    "@odata.id": "https://outlook.office.com/api/beta/Users('86b6ceaf-57f7-4278-97c4-4da0a97f6cdb@70559e59-b378-49ea-8e53-07a3a3d27f5b')/Messages('AAMkADA1MTQBAAA=')",
    "@odata.etag": "W/\"CQAAABYAAADX8oL1Wa7jQbcPAHouCzswAAAffAsD\"",
    "Id": "AAMkADA1MTQBAAA=",
    "Importance": "Normal",
    "Sender": {
        "EmailAddress": {
            "Name": "Fanny Downs",
            "Address": "fannyd@adatum.onmicrosoft.com"
        }
    },
    "From": {
        "EmailAddress": {
            "Name": "Fanny Downs",
            "Address": "fannyd@adatum.onmicrosoft.com"
        }
    },
    "ToRecipients": [
        {
            "EmailAddress": {
                "Name": "Admin",
                "Address": "admin@adatum.onmicrosoft.com"
            }
        }
    ],
    "InferenceClassification": "Other"
}

送信者のオーバーライドを作成する

最低限必要なスコープ

以下のいずれかです。

SMTP アドレスで示される送信者のオーバーライドを作成します。この SMTP アドレスからの将来のメッセージは、オーバーライドで指定されたとおり一貫して分類されます。

注意

  • 同じ STMP アドレスですでにオーバーライドがある場合は、そのオーバーライドの ClassifyAs および Name フィールドが指定の値で更新されます。
  • メールボックスでサポートされているオーバーライドは、一意の送信者 SMTP アドレスに基づき、最大 1000 件までです。
  • POST 操作では、同時に作成できるオーバーライドは 1 件です。複数のオーバーライドを作成するには、複数の POST 要求を送信するか、またはバッチで送信します。
POST https://outlook.office.com/api/beta/me/InferenceClassification/Overrides

POST https://outlook.office.com/api/beta/Users('{user_id}')/InferenceClassification/Overrides
パラメーター 型 説明
URL パラメーター
user_id string ユーザーの電子メール アドレスです。

応答の種類

新しく作成された InferenceClassificationOverride、または同じ SMTP アドレスが既にある場合は更新された InferenceClassificationOverride インスタンス。

要求のサンプル

POST https://outlook.office.com/api/beta/me/InferenceClassification/Overrides

{
    "ClassifyAs": "Focused",
    "SenderEmailAddress": {
        "Name": "Fanny Downs",
        "Address": "fannyd@adatum.onmicrosoft.com"
    }
}

応答のサンプル

Status code: 201 Created

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/InferenceClassification/Overrides/$entity",
    "@odata.id": "https://outlook.office.com/api/beta/Users('86b6ceaf-57f7-4278-97c4-4da0a97f6cdb@70559e59-b378-49ea-8e53-07a3a3d27f5b')/InferenceClassificationOverrides('98f5bdef-576a-404d-a2ea-07a3cf11a9b9')",
    "Id": "98f5bdef-576a-404d-a2ea-07a3cf11a9b9",
    "ClassifyAs": "Focused",
    "SenderEmailAddress": {
        "Name": "Fanny Downs",
        "Address": "fannyd@adatum.onmicrosoft.com"
    }
}

すべてのユーザーのオーバーライドを取得する

最低限必要なスコープ

以下のいずれかです。

ユーザーが設定したオーバーライドを取得して、特定の送信者からのメッセージを常に一定の方法で分類します。

それぞれのオーバーライドは、送信者の SMTP アドレスに対応します。最初は、ユーザーにはオーバーライドはありません。

GET https://outlook.office.com/api/beta/me/InferenceClassification/Overrides

GET https://outlook.office.com/api/beta/Users('{user_id}')/InferenceClassification/Overrides
パラメーター 型 説明
URL パラメーター
user_id string ユーザーの電子メール アドレスです。

応答の種類

InferenceClassificationOverride インスタンスのコレクション。ユーザーがオーバーライドを設定していない場合は、空のコレクションが返されます。

要求のサンプル

GET https://outlook.office.com/api/beta/me/InferenceClassification/Overrides

応答のサンプル

Status code: 200 OK

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/InferenceClassification/Overrides",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/beta/Users('86b6ceaf-57f7-4278-97c4-4da0a97f6cdb@70559e59-b378-49ea-8e53-07a3a3d27f5b')/InferenceClassificationOverrides('98f5bdef-576a-404d-a2ea-07a3cf11a9b9')",
            "Id": "98f5bdef-576a-404d-a2ea-07a3cf11a9b9",
            "ClassifyAs": "Focused",
            "SenderEmailAddress": {
                "Name": "Fanny Downs",
                "Address": "fannyd@adatum.onmicrosoft.com"
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/beta/Users('86b6ceaf-57f7-4278-97c4-4da0a97f6cdb@70559e59-b378-49ea-8e53-07a3a3d27f5b')/InferenceClassificationOverrides('98f5bdef-576a-404d-a2ea-07a3cf34af4r')",
            "Id": "98f5bdef-576a-404d-a2ea-07a3cf34af4r",
            "ClassifyAs": "Other",
            "SenderEmailAddress": {
                "Name": "Randi Welch",
                "Address": "randiw@adatum.onmicrosoft.com"
            }
        }
    ]
}

送信者のオーバーライドを更新する

最低限必要なスコープ

以下のいずれかです。

指定のとおり、オーバーライドの ClassifyAs フィールドを変更します。

InferenceClassificationOverride インスタンスのその他のフィールドの変更には、PATCH を使用できません。

送信者にオーバーライドがあり、その送信者が表示名を変更すると、既存のオーバーライドで POST を使用して [名前] フィールドの更新を実施できます。

送信者にオーバーライドがあり、その送信者が SMTP アドレスを変更すると、既存のオーバーライドを削除して、新しい SMTP アドレスで新しくオーバーライドを作成することが、この送信者のオーバーライドを「更新」する唯一の方法になります。

PATCH https://outlook.office.com/api/beta/me/InferenceClassification/Overrides('{override_id}')

PATCH https://outlook.office.com/api/beta/Users('{user_id}')/InferenceClassification/Overrides('{override_id}')
パラメーター 型 説明
URL パラメーター
override_id string 更新するオーバーライドの ID です。
user_id string ユーザーの電子メール アドレスです。

応答の種類

更新された InferenceClassificationOverride インスタンス。

要求のサンプル

次の例では、サインイン ユーザーのオーバーライドを変更します。オーバーライドは SMTP アドレス randiw@adatum.onmicrosoft.com の送信者のものであり、Other から Focused に変更されます。

PATCH https://outlook.office.com/api/beta/me/InferenceClassification/Overrides('98f5bdef-576a-404d-a2ea-07a3cf34af4r')

{
    "ClassifyAs": "Focused"
}

応答のサンプル

Status code: 200 OK

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/InferenceClassification/Overrides/$entity",
    "@odata.id": "https://outlook.office.com/api/beta/Users('86b6ceaf-57f7-4278-97c4-4da0a97f6cdb@70559e59-b378-49ea-8e53-07a3a3d27f5b')/InferenceClassificationOverrides('98f5bdef-576a-404d-a2ea-07a3cf34af4r')",
    "Id": "98f5bdef-576a-404d-a2ea-07a3cf34af4r",
    "ClassifyAs": "Focused",
    "SenderEmailAddress": {
        "Name": "Randi Welch",
        "Address": "randiw@adatum.onmicrosoft.com"
    }
}

送信者のオーバーライドを削除する

最低限必要なスコープ

以下のいずれかです。

その ID で指定されたオーバーライドを削除します。

DELETE https://outlook.office.com/api/beta/me/InferenceClassification/Overrides('{override_id}')

DELETE https://outlook.office.com/api/beta/Users('{user_id}')/InferenceClassification/Overrides('{override_id}')
パラメーター 型 説明
URL パラメーター
override_id string 送信する下書きメッセージの ID です。
user_id string ユーザーの電子メール アドレスです。

要求のサンプル

DELETE https://outlook.office.com/api/beta/me/InferenceClassification/Overrides('98f5bdef-576a-404d-a2ea-07a3cf34af4r')

応答のサンプル

Status code: 204 No Content

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

ソーシャルの世界では、メッセージ内で受信者の注意を引くために受信者に呼びかけることが一般的に行われています。Mention リソースは、メッセージ内で他の受信者に通知したり、メッセージの送信者からの通知を取得したりできる軽快なメカニズムを提供します。

でメンションを始めることで、ユーザー インターフェイスを通してアプリのメッセージ内でメンションを挿入することが可能です。(他のアプリでも同様のシナリオで一般的に使用されるため、@- メンションと呼ばれます)。プログラミングにより、メッセージを作成する際に同じ POST call 内の Mentions プロパティにメンションを追加することで、アプリ上でメンションを作成することができます。@

アプリ上で、受信トレイに通知されているメッセージがないかどうかを検索することができます。メッセージ内の各メンションの詳細を検索できます。メッセージ内のメンションを削除することもできます。

新しいメッセージ内にメンションを作成する

メッセージのメンションに関する情報を取得する

メッセージ内のメンションを削除する

新しいメッセージの一部としてメンションを作成および送信する

最低限必要なスコープ

以下のいずれかです。

1 つまたは複数の Mention のインスタンス コレクションを含む要求本文で指定されたメッセージを作成し、送信します。

これには、Message リソース上で利用可能な、同じ SendMail アクションを使用します。加えて、Message body パラメーターの一部としてMentions プロパティが含まれます。

POST https://outlook.office.com/api/beta/me/sendmail
必須のパラメーター 種類 説明
本文パラメーター
メッセージ メッセージ 送信するメッセージです。
SavetoSentItems ブール値 [送信済みアイテム] 内のメッセージを保存するかどうかを示します。既定値は true です。false の場合にのみ必須です。

要求本文に必要な ToRecipients プロパティとMentions プロパティ、および任意の書き込み可能な message プロパティを設定して、Message パラメーターを指定します。

また、Mentions プロパティ内の各メンションに対して、Mentioned および CreatedBy プロパティを指定する必要があります。

要求のサンプル

POST https://outlook.office.com/api/beta/me/sendmail
Content-Type: application/json

{
  "Message": {
    "Subject": "Project kickoff",
    "ToRecipients":[
      {
          "EmailAddress":{
          "Name":"Fanny Downs",
          "Address":"fannyd@contoso.onmicrosoft.com"
          }
      }
    ],
    "Mentions":[
      {
        "Mentioned":{
          "Name":"Dana Swope",
          "Address":"danas@contoso.onmicrosoft.com"
         },
        "CreatedBy": {
            "Name":"Randi Welch",
            "Address":"randiw@contoso.onmicrosoft.com"
        }
      }
    ]
  }
}

応答のサンプル

Status code: 202 Accepted

下書きの一部としてメンションを作成する

最低限必要なスコープ

以下のいずれかです。

1 つまたは複数の Mention のインスタンス コレクションを含む、新しいメッセージの下書きを作成します。下書きはどのフォルダーでも作成でき、また必要に応じて送信前に更新することも可能です。

これには、Message リソース上で利用可能な、同じ POST メソッドを使用します。加えて、要求本文に Mentions プロパティが含まれます。

POST https://outlook.office.com/api/beta/me/messages
POST https://outlook.office.com/api/beta/me/MailFolders/{folder_id}/messages
必須のパラメーター 種類 説明
URL パラメーター
folder_id string 宛先フォルダーの ID、あるいは Inbox または Drafts の既知のフォルダー名です。

Mentions プロパティを指定し、要求本文に任意の書き込み可能な メッセージ プロパティを指定します。

また、Mentions プロパティ内の各メンションに対して、Mentioned および CreatedBy プロパティを指定する必要があります。

応答の種類

下書きメッセージです。

要求のサンプル

POST https://outlook.office.com/api/beta/me/messages
Content-Type: application/json

{
    "Subject": "Party planning",
    "ToRecipients":[
      {
          "EmailAddress":{
          "Name":"Fanny Downs",
          "Address":"fannyd@contoso.onmicrosoft.com"
          }
      }
    ],
    "Mentions":[
      {    
        "Mentioned":{
          "Name":"Dana Swope",
          "Address":"danas@contoso.onmicrosoft.com"
         },
        "CreatedBy": {
            "Name":"Randi Welch",
            "Address":"randiw@contoso.onmicrosoft.com"
        }
      }
    ]
}

応答のサンプル

作成された下書きメッセージを以下に示します。

注意

ここに示す応答オブジェクトは、簡潔にするために切り詰められます。 実際の呼び出しではすべてのプロパティが返されます。

Status code: 201 Created

{
  "@odata.context":"https://outlook.office.com/api/beta/$metadata#Me/Messages/$entity",
  "@odata.id":"https://outlook.office.com/api/beta/Users('266efe5a-0fd7-4edd-877b-b2d1e561f193@ae01a323-3934-4475-a32d-af1274312bb0')/Messages('AQMkADJmMTUAAAW1fsAAAAA==')",
  "@odata.etag":"W/\"CQAAABYAAAAPFhK2FclcRbABBJhCde8iAAAAbYj7\"",
  "Id":"AQMkADJmMTUAAAW1fsAAAAA==",
  "Body":{
    "ContentType":"Text",
    "Content":""
  },
  "BodyPreview":"",
  "Sender":null,
  "From":null,
  "ToRecipients":[
    {
      "EmailAddress":{
        "Name":"Fanny Downs",
        "Address":"fannyd@contoso.onmicrosoft.com"
      }
    }
  ],
  "MentionsPreview":{
    "IsMentioned":false
  },
  "Mentions@odata.context":"https://outlook.office.com/api/beta/$metadata#Me/Messages('AQMkADJmMTUAAAW1fsAAAAA%3D%3D')/Mentions",
  "Mentions":[
    {
      "@odata.id":"https://outlook.office.com/api/beta/Users('266efe5a-0fd7-4edd-877b-b2d1e561f193@ae01a323-3934-4475-a32d-af1274312bb0')/Messages('AQMkADJmMTUAAAW1fsAAAAA==')/Mentions('4577bba4-b063-4cea-9073-6f7ca815fcec')",
      "Id":"4577bba4-b063-4cea-9073-6f7ca815fcec",
      "Mentioned":{
        "Name":"Dana Swope",
        "Address":"danas@contoso.onmicrosoft.com",
        "ExternalId":"72137a84-1a8b-4b92-aa06-cca538e8616b"
      },
      "MentionText":null,
      "ClientReference":null,
      "CreatedBy":{
        "Name":"Randi Welch",
        "Address":"randiw@contoso.onmicrosoft.com",
        "ExternalId":"266efe5a-0fd7-4edd-877b-b2d1e561f193"
      },
      "CreatedDateTime":"2016-07-22T02:22:44Z",
      "ServerCreatedDateTime":"2016-07-22T02:22:44.201Z",
      "DeepLink":null,
      "Application":null
    }
  ]
}

サインイン中のユーザーをメンションしているすべてのメッセージを取得する

最低限必要なスコープ

以下のいずれかです。

サインインしているユーザーのメールボックス内のすべてのメッセージや、このユーザーの Mention を含むすべてのメッセージを取得します。

これには、Message リソース上で利用可能な、同じ GET メソッドを使用します。加えて、MentionsPreview プロパティに $filter クエリ パラメーターが含まれます。

既定では、GET /me/messages の呼び出しでは Mentions プロパティは返されません。$expand クエリ パラメーターを使用して、メッセージ内の各メンションの詳細を検索します。

注意

実際の呼び出しで、クエリ パラメーター文字列内の空白文字が適切にエンコードされていることを確認してください。

GET https://outlook.office.com/api/beta/me/messages?$filter=MentionsPreview/IsMentioned eq true

GET https://outlook.office.com/api/beta/me/MailFolders/{folder_id}/messages?$filter=MentionsPreview/IsMentioned eq true
必須のパラメーター 種類 説明
URL パラメーター
folder_id string 宛先フォルダーの ID、あるいは Inbox または Drafts の既知のフォルダー名です。

応答の種類

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

要求のサンプル

次の例では、サインイン中のユーザーのメールボックス内のすべてのメッセージをフィルターし、ユーザーがメンションされているメールを抽出しています。$select を使用し、応答にメッセージごとのプロパティのサブセットを返します。クエリのパラメーター文字列内の空白文字用の URL エンコードも組み込まれています。

GET https://outlook.office.com/api/beta/me/messages?$filter=MentionsPreview/IsMentioned%20eq%20true&$select=Subject,Sender,ReceivedDateTime,MentionsPreview

応答のサンプル

応答にはサインイン中のユーザーをメンションしている 2 通のメッセージが含まれています。

Status code: 200 OK

{
  "@odata.context":"https://outlook.office.com/api/beta/$metadata#Me/Messages(Subject,Sender,ReceivedDateTime,MentionsPreview)",
  "value":[
    {
      "@odata.id":"https://outlook.office.com/api/beta/Users('266efe5a-0fd7-4edd-877b-b2d1e561f193@ae01a323-3934-4475-a32d-af1274312bb0')/Messages('AQMkADJmMTUAAAgVZAAAA')",
      "@odata.etag":"W/\"CQAAABYAAAAPFhK2FclcRbABBJhCde8iAAAAAATI\"",
      "Id":"AQMkADJmMTUAAAgVZAAAA",
      "ReceivedDateTime":"2016-07-21T07:40:21Z",
      "Subject":"Re: Start planning soon",
      "Sender":{
        "EmailAddress":{
          "Name":"Randi Welch",
          "Address":"randiw@contoso.onmicrosoft.com"
        }
      },
      "MentionsPreview":{
        "IsMentioned":true
      }
    },
    {
      "@odata.id":"https://outlook.office.com/api/beta/Users('266efe5a-0fd7-4edd-877b-b2d1e561f193@ae01a323-3934-4475-a32d-af1274312bb0')/Messages('AQMkADJmMTUAAAjwVAAAA')",
      "@odata.etag":"W/\"CQAAABYAAAAPFhK2FclcRbABBJhCde8iAAAAAEGj\"",
      "Id":"AQMkADJmMTUAAAjwVAAAA",
      "ReceivedDateTime":"2016-07-21T07:40:20Z",
      "Subject":"Re: Start planning soon",
      "Sender":{
        "EmailAddress":{
          "Name":"Randi Welch",
          "Address":"randiw@contoso.onmicrosoft.com"
        }
      },
      "MentionsPreview":{
        "IsMentioned":true
      }
    }
  ]
}

メッセージ内の各メンションの詳細を取得する

最低限必要なスコープ

以下のいずれかです。

展開したメッセージ内の各 Mention の詳細を含むメッセージを取得します。

これには、Message リソース上で利用可能な、同じ GET メソッドを使用します。加えて、Mentions ナビゲーション プロパティに $expand クエリ パラメーターが含まれます。

GET https://outlook.office.com/api/beta/me/messages('{message_id}')?$expand=Mentions
必須のパラメーター 種類 説明
URL パラメーター
message_id string 要求されたメッセージの ID です。

応答の種類

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

要求のサンプル

次の例では、サインイン中のユーザーは Dana Swope です。Dana のメールボックス内で指定されたメッセージ内のすべてのメンションの詳細を取得する例を示しています。

GET https://outlook.office.com/api/beta/me/messages('AQMkADJmMTUAAAgVZAAAA')?$expand=Mentions

応答のサンプル

次の例では、Mentions プロパティ内の各メンションの詳細を含む、要求されたメッセージの例を示しています。このメッセージでは、2 人がメンションされています。1 人目はサインイン中のユーザーである Dana、もう 1 人目は Randi Welch です。

注意

Mention のサポートに関連するプロパティに焦点を置くため、ここで表示されている応答オブジェクトは、簡潔にするために切り詰めてあります。

Status code: 200 OK

{
  "@odata.context":"https://outlook.office.com/api/beta/$metadata#Me/Messages/$entity",
  "@odata.id":"https://outlook.office.com/api/beta/Users('266efe5a-0fd7-4edd-877b-b2d1e561f193@ae01a323-3934-4475-a32d-af1274312bb0')/Messages('AQMkADJmMTUAAAgVZAAAA')",
  "@odata.etag":"W/\"CQAAABYAAAAPFhK2FclcRbABBJhCde8iAAAAAATI\"",
  "Id":"AQMkADJmMTUAAAgVZAAAA",
  "Subject":"Start planning soon",
  "Body":{
    "ContentType":"HTML",
    "Content":"<html><head></head><body"><p><a href=\"mailto:danas@contoso.onmicrosoft.com\">@Dana Swope</a>,<a href=\"mailto:randiw@contoso.onmicrosoft.com\">@Randi Welch</a>, forgot to mention, I will be away&nbsp;this weekend. I can start on Monday though.</p></body></html>"
  },
  "BodyPreview":"@Dana Swope<mailto:danas@contoso.onmicrosoft.com>, @Randi Welch, forgot to mention, I will be away this weekend. I can start on Monday though.",
  "Sender":{
    "EmailAddress":{
      "Name":"Fanny Downs",
      "Address":"fannyd@contoso.onmicrosoft.com"
    }
  },
  "From":{
    "EmailAddress":{
      "Name":"Fanny Downs",
      "Address":"fannyd@contoso.onmicrosoft.com"
    }
  },
  "ToRecipients":[
    {
      "EmailAddress":{
        "Name":"Dana Swope",
        "Address":"danas@contoso.onmicrosoft.com"
      }
    },
    {
      "EmailAddress":{
        "Name":"Randi Welch",
        "Address":"randiw@contoso.onmicrosoft.com"
      }
    }
  ],
  "CcRecipients":[
  ],
  "BccRecipients":[
  ],
  "MentionsPreview":{
    "IsMentioned":true
  },
  "Mentions@odata.context":"https://outlook.office.com/api/beta/$metadata#Me/Messages('AQMkADJmMTUAAAgVZAAAA')/Mentions",
  "Mentions":[
    {
      "@odata.id":"https://outlook.office.com/api/beta/Users('266efe5a-0fd7-4edd-877b-b2d1e561f193@ae01a323-3934-4475-a32d-af1274312bb0')/Messages('AQMkADJmMTUAAAgVZAAAA')/Mentions('138f4c0a-1130-4776-b780-bf79d73abb3f')",
      "Id":"138f4c0a-1130-4776-b780-bf79d73abb3f",
      "Mentioned":{
        "Name":"Dana Swope",
        "Address":"danas@contoso.onmicrosoft.com",
        "ExternalId":"72137a84-1a8b-4b92-aa06-cca538e8616b"
      },
      "MentionText":null,
      "ClientReference":null,
      "CreatedBy":{
        "Name":"Fanny Downs",
        "Address":"fannyd@contoso.onmicrosoft.com",
        "ExternalId":"266efe5a-0fd7-4edd-877b-b2d1e561f193"
      },
      "CreatedDateTime":"2016-07-21T07:40:20.152Z",
      "ServerCreatedDateTime":"2016-07-21T07:40:20.152Z",
      "DeepLink":null,
      "Application":null
    },
    {
      "@odata.id":"https://outlook.office.com/api/beta/Users('266efe5a-0fd7-4edd-877b-b2d1e561f193@ae01a323-3934-4475-a32d-af1274312bb0')/Messages('AQMkADJmMTUAAAgVZAAAA')/Mentions('7b94df1a-0086-482a-b0da-e62fae12f983')",
      "Id":"7b94df1a-0086-482a-b0da-e62fae12f983",
      "Mentioned":{
        "Name":"Randi Welch",
        "Address":"randiw@contoso.onmicrosoft.com",
        "ExternalId":"266efe5a-0fd7-4edd-877b-b2d1e561f193"
      },
      "MentionText":null,
      "ClientReference":null,
      "CreatedBy":{
        "Name":"Fanny Downs",
        "Address":"fannyd@contoso.onmicrosoft.com",
        "ExternalId":"266efe5a-0fd7-4edd-877b-b2d1e561f193"
      },
      "CreatedDateTime":"2016-07-21T07:40:20.158Z",
      "ServerCreatedDateTime":"2016-07-21T07:40:20.158Z",
      "DeepLink":null,
      "Application":null
    }
  ]
}

メンションの削除

最低限必要なスコープ

以下のいずれかです。

サインインしているユーザーのメールボックス内で指定したメッセージにおいて、指定したメンションを削除します。

DELETE https://outlook.office.com/api/beta/me/messages('{message_id}')/mentions('{mention_id}')
必須のパラメーター 種類 説明
URL パラメーター
mention_id string 削除するメンションの ID です。
message_id string メンションを含むメッセージの ID です。

要求のサンプル

DELETE https://outlook.office.com/api/beta/me/messages('AAMkADA1MTk1ZAAAKXBQCAAA=')/mentions('7b94df1a-0086-482a-b0da-e62fae12f983')

応答のサンプル

Status code: 204 No Content

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

Outlook では、一定の条件が満たされた場合に特定の操作を実行する、受信トレイで受信したメッセージのルールを設定できます。

ルールには、プログラムで受信トレイ フォルダーの MessageRules ナビゲーション プロパティ経由でアクセスできます。各ルールは MessageRule リソース、利用可能なルールの処理は MessageRuleActions 複合型、利用可能なルール条件および例外は MessageRulePredicates 複合型で表されます。

ルールを作成する (プレビュー)

最低限必要なスコープ

条件とアクションのセットを指定してルールを作成します。Outlook では、ユーザーの受信トレイで受信したメッセージが指定した条件を満たしている場合に、それらのアクションが実行されます。

POST https://outlook.office.com/api/beta/me/mailfolders/inbox/messagerules

ルールを作成するときに通常使用される本体のパラメーターを次に示します。要求本文では、その他の書き込み可能で適切な MessageRule プロパティを指定できます。

本文のパラメーター 型 説明
アクション MessageRuleActions 該当する条件があり、それが満たされる場合にメッセージに対して実行されるアクションです。必須。
条件 MessageRulePredicates 満たされた場合に、そのルールに該当するアクションをトリガーする条件です。省略可能。
DisplayName 文字列 ルールの表示名必須。
例外 MessageRulePredicates ルールの例外条件を表します。省略可能。
IsEnabled ブール値 ルールのメッセージへの適用が有効になっているかどうかを示します。省略可能。
シーケンス Int32 他のルールもある中で、そのルールが実行される順序を示します。必須です。

要求のサンプル

次のルールでは、受信メッセージの送信者名に「adele」という語が含まれている場合にメッセージを Alex Wilbur に転送します。

POST https://outlook.office.com/api/beta/me/mailfolders/inbox/messagerules
Content-Type: application/json

{      
    "DisplayName": "From partner",      
    "Sequence": 2,      
    "IsEnabled": true,          
    "Conditions": {
        "SenderContains": [
          "adele"       
        ]
     },
     "Actions": {
        "ForwardTo": [
          {
             "EmailAddress": {
                "Name": "Alex Wilbur",
                "Address": "AlexW@MOD154847.onmicrosoft.com"
              }
           }
        ],
        "StopProcessingRules": true
     }    
}

応答のサンプル

Status code: 201 Created

{
  "Id":"AQAAAJ5dZqA=",
  "DisplayName":"From partner",
  "Sequence":2,
  "IsEnabled":true,
  "HasError":false,
  "IsReadOnly":false,
  "Conditions":{
    "SenderContains":[
      "ADELE"
    ]
  },
  "Actions":{
      "StopProcessingRules":true,
      "ForwardTo":[
        {
          "EmailAddress":{
            "Name":"Alex Wilbur",
            "Address":"AlexW@MOD154847.onmicrosoft.com"
          }
        }
      ]
  }
}

ルールを取得する (プレビュー)

最低限必要なスコープ

ユーザーの [受信トレイ] に定義されているすべてのルールを取得するか、その ID を指定して特定のルールを取得することができます。

受信トレイのすべての規則を取得する

GET https://outlook.office.com/api/beta/me/mailfolders/inbox/messagerules

要求のサンプル

GET https://outlook.office.com/api/beta/me/mailfolders/inbox/messagerules

応答のサンプル

Status code: 200 OK

{
  "@odata.context":"https://outlook.office.com/api/beta/$metadata#Me/MailFolders('inbox')/MessageRules",
  "value":[
    {
      "@odata.id":"https://outlook.office.com/api/beta/Users('94447c6e-ea4c-494c-a9ed-d905e366c5cb@007e925e-fb5a-4f60-9cb6-58a21e692480')/MailFolders('inbox')/MessageRules('AQAAAJ5dZp8=')",
      "Id":"AQAAAJ5dZp8=",
      "DisplayName":"Remove spam",
      "Sequence":1,
      "IsEnabled":true,
      "HasError":false,
      "IsReadOnly":false,
      "Conditions":{
        "SubjectContains":[
          "enter to win"
        ]
      },
      "Actions":{
        "Delete":true,
        "StopProcessingRules":true
      }
    },
    {
      "@odata.id":"https://outlook.office.com/api/beta/Users('94447c6e-ea4c-494c-a9ed-d905e366c5cb@007e925e-fb5a-4f60-9cb6-58a21e692480')/MailFolders('inbox')/MessageRules('AQAAAJ5dZqA=')",
      "Id":"AQAAAJ5dZqA=",
      "DisplayName":"From partner",
      "Sequence":2,
      "IsEnabled":true,
      "HasError":false,
      "IsReadOnly":false,
      "Conditions":{
        "SenderContains":[
          "ADELE"
        ]
      },
      "Actions":{
        "StopProcessingRules":true,
        "ForwardTo":[
          {
            "EmailAddress":{
              "Name":"Alex Wilbur",
              "Address":"AlexW@MOD154847.onmicrosoft.com"
            }
          }
        ]
      }
    }
  ]
}

特定のルールを取得する

GET https://outlook.office.com/api/beta/me/mailfolders/inbox/messagerules('{rule_id}')
URL パラメーターー 型 説明
rule_id 文字列 取得するルールの ID。

要求のサンプル

GET https://outlook.office.com/api/beta/me/mailfolders/inbox/messagerules('AQAAAJ5dZqA=')

応答のサンプル

Status code: 200 OK

{
  "@odata.context":"https://outlook.office.com/api/beta/$metadata#Me/MailFolders('inbox')/MessageRules/$entity",
  "@odata.id":"https://outlook.office.com/api/beta/Users('94447c6e-ea4c-494c-a9ed-d905e366c5cb@007e925e-fb5a-4f60-9cb6-58a21e692480')/MailFolders('inbox')/MessageRules('AQAAAJ5dZqA=')",
  "Id":"AQAAAJ5dZqA=",
  "DisplayName":"From partner",
  "Sequence":2,
  "IsEnabled":true,
  "HasError":false,
  "IsReadOnly":false,
  "Conditions":{
    "SenderContains":[
      "ADELE"
    ]
  },
  "Actions":{
      "StopProcessingRules":true,
      "ForwardTo":[
        {
          "EmailAddress":{
            "Name":"Alex Wilbur",
            "Address":"AlexW@MOD154847.onmicrosoft.com"
          }
        }
      ]
  }
}

ルールを更新する (プレビュー)

最低限必要なスコープ

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

PATCH https://outlook.office.com/api/beta/me/mailfolders/inbox/messagerules('{rule_id}')
URL パラメーターー 型 説明
rule_id 文字列 更新するルールの ID。

要求のサンプル

次の例では、ルールの名前、および前の例のルールに対して実行するアクションを転送元からアドレスに変更し、その重要度を高くマークします。

PATCH https://outlook.office.com/api/beta/me/mailfolders/inbox/messagerules('AQAAAJ5dZqA=')
Content-Type: application/json

{
    "DisplayName": "Important from partner",
    "Actions": {
        "MarkImportance": "High"
     }
}

応答のサンプル

Status code: 200 OK

{
  "Id":"AQAAAJ5dZqA=",
  "DisplayName":"Important from partner",
  "Sequence":2,
  "IsEnabled":true,
  "HasError":false,
  "IsReadOnly":false,
  "Conditions":{
    "SenderContains":[
      "ADELE"
    ]
  },
  "Actions":{
      "MarkImportance": "High"
  }
}

ルールを削除する (プレビュー)

最低限必要なスコープ

指定したルールを削除します。

DELETE https://outlook.office.com/api/beta/me/mailfolders/inbox/messagerules('{rule_id}')
URL パラメーターー 型 説明
rule_id 文字列 削除するルールの ID。

要求のサンプル

DELETE https://outlook.office.com/api/beta/me/mailfolders/inbox/messagerules('AQAAAJ5dZp8=')

応答のサンプル

Status code: 204 No Content

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

最低限必要なスコープ

以下のいずれかです。

サイン インユーザーに代わって電子メール要求を送信し、電子メール配布リストから登録を解除します。List-Unsubscribe ヘッダー内の情報を使用します。

POST https://outlook.office.com/api/beta/me/messages('{message_id}')/unsubscribe
必須のパラメーター 種類 説明
URL パラメーター
message_id string 送信する下書きメッセージの ID です。

メッセージ送信者は、メーリング リストで受信者を除外するオプションを組み込む簡単な方法を使用できます。これは、それぞれのメッセージで RFC-2369 に続いて List-Unsubscribe ヘッダーを指定することで処理できます。

注意

特に、登録解除アクションを有効にするには、送信者が URL ベースの登録解除情報ではなく、mailto: を指定する必要があります。

そのヘッダーを設定すると、メッセージ インスタンスの UnsubscribeEnabled プロパティが true に設定され、UnsubscribeData プロパティがヘッダー データに設定されます。

メッセージの UnsubscribeEnabled プロパティが true の場合、Unsubscribe アクションを使用して、メッセージ送信者が管理するとおり、同じような今後のメッセージについてユーザーを登録解除することができます。

Unsubscribe アクションが完了すると、メッセージは削除済みアイテム フォルダーに移動します。将来のメール配布からのユーザーの実際の除外は、送信者によって管理されます。

要求のサンプル

POST https://outlook.office.com/api/beta/me/messages('AAMkADA1MTk1ZAAAKXBQCAAA=')/unsubscribe

応答のサンプル

Status code: 202 Accepted

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

最低限必要なスコープ

以下のいずれかです。

ユーザーに対してサポートされている (ユーザーのメールボックス サーバーで構成されている) ロケールと言語のリストを取得します。

ユーザーの優先言語は、このサポート対象のリストから選択されます。優先言語を取得するには、ユーザーのメールボックス設定を取得します。

GET https://outlook.office.com/api/beta/me/SupportedLanguages

応答の種類

LocaleInfo のコレクション。

要求のサンプル

GET https://outlook.office.com/api/beta/me/SupportedLanguages

応答のサンプル

次に示す応答のサンプルは、応答の JSON 形式を明確にするために、切り詰めて簡略化されています。

Status code: 200

{
  "@odata.context":"https://outlook.office.com/api/beta/$metadata#Collection(Microsoft.OutlookServices.LocaleInfo)",
  "value":[
    {
      "Locale":"af-ZA",
      "DisplayName":"Afrikaans (Suid-Afrika)"
    },
    {
      "Locale":"en-US",
      "DisplayName":"English (United States)"
    },
    {
       "Locale":"en-CA",
       "DisplayName":"English (Canada)"
    }
  ]
}

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

最低限必要なスコープ

以下のいずれかです。

ユーザーに対してサポートされている (ユーザーのメールボックス サーバーで構成されている) タイム ゾーンのリストを取得します。

Windows のタイム ゾーン形式または Internet Assigned Numbers Authority (IANA) のタイム ゾーン (別称: Olson タイム ゾーン) 形式でタイム ゾーンが返されるようにするオプションを指定することもできます。形式を指定していない場合、タイム ゾーンは Windows のタイム ゾーン形式で返されます。

ユーザーの優先タイム ゾーンは、このサポート対象のリストから選択されます。タイム ゾーンを取得するには、ユーザーのメールボックス設定を取得します。

GET https://outlook.office.com/api/beta/me/SupportedTimeZones(TimeZoneStandard='{timezone_format}')
省略可能なパラメーター 型 説明
URL パラメーター
timezone_format TimeZoneStandard タイム ゾーンの形式。サポートされている値は Windows および Iana です。

応答の種類

TimeZoneInformation のコレクション。

要求のサンプル

次の例では、サインインしているユーザーに対してサポートされているタイム ゾーンのリストを Windows 形式で取得します。

GET https://outlook.office.com/api/beta/me/SupportedTimeZones(TimeZoneStandard='Windows')

応答のサンプル

次に示す応答のサンプルは、応答の JSON 形式を明確にするために、切り詰めて簡略化されています。

Status code: 200

{
  "@odata.context":"https://outlook.office.com/api/beta/$metadata#Collection(Microsoft.OutlookServices.TimeZoneInformation)",
  "value":[
    {
      "Alias":"Dateline Standard Time",
      "DisplayName":"(UTC-12:00) International Date Line West"
    },
    {
      "Alias":"Samoa Standard Time",
      "DisplayName":"(UTC+13:00) Samoa"
    },
    {
       "Alias":"UTC-11",
       "DisplayName":"(UTC-11:00) Coordinated Universal Time-11"
    },
    {
      "Alias":"Aleutian Standard Time",
      "DisplayName":"(UTC-10:00) Aleutian Islands"
    }
  ]
}

要求のサンプル

次の例では、サポートされているタイム ゾーンのリストを IANA 形式で取得します。

GET https://outlook.office.com/api/beta/me/SupportedTimeZones(TimeZoneStandard='Iana')

応答のサンプル

次に示す応答のサンプルは、応答の JSON 形式を明確にするために、切り詰めて簡略化されています。

Status code: 200

{
  "@odata.context":"https://outlook.office.com/api/beta/$metadata#Collection(Microsoft.OutlookServices.TimeZoneInformation)",
  "value":[
    {
      "Alias":"Etc/GMT+12",
      "DisplayName":"Etc/GMT+12"
    },
    {
      "Alias":"US/Samoa",
      "DisplayName":"US/Samoa"
    },
    {
      "Alias":"Etc/GMT+11",
      "DisplayName":"Etc/GMT+11"
    },
    {
      "Alias":"US/Aleutian",
      "DisplayName":"US/Aleutian"
    }
  ]
}

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

最低限必要なスコープ

ユーザーのプライマリ メールボックスの設定を取得します。設定の例として、ユーザーの優先言語と既定のタイムゾーン、自動応答の設定などが挙げられます。

ユーザーの優先言語とタイムゾーンの選択肢は、メールボックス サーバーで構成されいるものになります。ユーザーに対してサポートされている言語やサポートされているタイム ゾーンなどのリストを取得できます。

GET https://outlook.office.com/api/beta/me/MailboxSettings

応答の種類

MailboxSettings。

すべてのメールボックス設定から、優先言語の設定のみを取得するには:

GET https://outlook.office.com/api/beta/me/MailboxSettings/Language

応答の種類

LocaleInfo。

すべてのメールボックス設定から、優先タイム ゾーンのみを取得するには:

GET https://outlook.office.com/api/beta/me/MailboxSettings/TimeZone

応答の種類

Windows のタイム ゾーン形式で優先タイム ゾーンを表す文字列。

自動応答設定のみを取得することもできます。

要求のサンプル

次の例では、サインインしているユーザーのすべてのメールボックス設定を取得します。

GET https://outlook.office.com/api/beta/me/MailboxSettings

応答のサンプル

Status code: 200

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/MailboxSettings",
    "AutomaticRepliesSetting": {
        "Status": "Scheduled",
        "ExternalAudience": "All",
        "ScheduledStartDateTime": {
            "DateTime": "2016-03-14T07:00:00.0000000",
            "TimeZone": "UTC"
        },
        "ScheduledEndDateTime": {
            "DateTime": "2016-03-28T07:00:00.0000000",
            "TimeZone": "UTC"
        },
        "InternalReplyMessage": "<html>\n<body>\n<p>I'm at our company's worldwide reunion and will respond to your message as soon as I return.<br>\n</p></body>\n</html>\n",
        "ExternalReplyMessage": "<html>\n<body>\n<p>I'm at the Contoso worldwide reunion and will respond to your message as soon as I return.<br>\n</p></body>\n</html>\n"
    },
    "TimeZone": "Pacific Standard Time",
    "Language":{
        "Locale":"en-US",
        "DisplayName":"English (United States)"
    }
}

自動応答の設定を取得する

最低限必要なスコープ

サインインしているユーザーのメールボックスの自動応答の設定を取得します。

自動応答では、メールを受信したときに、そのメッセージの送信者に自動的にメッセージで通知することができます。たとえば、不在時に返信できない場合などにそれを通知できます。

自動応答はユーザーのメールボックス設定の一部 (MailboxSettings で表される) であるため、自動応答設定を含むすべてのメールボックス設定を取得、または自動応答設定だけを取得すると表示できます。

|||UNTRANSLATED_CONTENT_START|||You can use the Prefer: outlook.timezone HTTP header to specify the preferred time zone to display the ScheduledStartDateTime and ScheduledEndDateTime values.|||UNTRANSLATED_CONTENT_END|||

GET https://outlook.office.com/api/beta/me/MailboxSettings/AutomaticRepliesSetting

応答の種類

AutomaticRepliesSetting。

要求のサンプル

GET https://outlook.office.com/api/beta/me/MailboxSettings/AutomaticRepliesSetting

応答のサンプル

Status code: 200

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/MailboxSettings/AutomaticRepliesSetting",
    "Status": "AlwaysEnabled",
    "ExternalAudience": "None",
    "ScheduledStartDateTime": {
        "DateTime": "2016-03-19T02:00:00.0000000",
        "TimeZone": "UTC"
    },
    "ScheduledEndDateTime": {
        "DateTime": "2016-03-20T02:00:00.0000000",
        "TimeZone": "UTC"
    },
    "InternalReplyMessage": "<html>\n<body>\n<p>I'm at our company's worldwide reunion and will respond to your message as soon as I return.<br>\n</p></body>\n</html>\n",
    "ExternalReplyMessage": "<html>\n<body>\n<p>I'm at the Contoso worldwide reunion and will respond to your message as soon as I return.<br>\n</p></body>\n</html>\n"
}

自動応答の設定を更新する

最低限必要なスコープ

自動応答はユーザーの (MailboxSettings で表される) メールボックス設定の一部です。該当するメールボックス設定を更新して、自動応答を有効化、構成、または無効化することができます。

注意

メールボックス設定は作成または削除できません。

PATCH https://outlook.office.com/api/beta/me/MailboxSettings

応答の種類

MailboxSettings。

要求のサンプル

自動応答設定の取得を示す前の例に続き、次の例ではステータスを AlwaysEnabled から Scheduled に変更し、開始日と終了日を異なる日付範囲に変更します。

PATCH https://outlook.office.com/api/beta/me/MailboxSettings
Content-Type: application/json

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/MailboxSettings",
    "AutomaticRepliesSetting": {
        "Status": "Scheduled",
        "ScheduledStartDateTime": {
          "DateTime": "2016-03-20T18:00:00.0000000",
          "TimeZone": "UTC"
        },
        "ScheduledEndDateTime": {
          "DateTime": "2016-03-28T18:00:00.0000000",
          "TimeZone": "UTC"
        }
    }
}

応答のサンプル

Status code: 200

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/MailboxSettings",
    "AutomaticRepliesSetting": {
        "Status": "Scheduled",
        "ExternalAudience": "None",
        "ScheduledStartDateTime": {
            "DateTime": "2016-03-20T02:00:00.0000000",
            "TimeZone": "UTC"
        },
        "ScheduledEndDateTime": {
            "DateTime": "2016-03-28T02:00:00.0000000",
            "TimeZone": "UTC"
        },
    "InternalReplyMessage": "<html>\n<body>\n<p>I'm at our company's worldwide reunion and will respond to your message as soon as I return.<br>\n</p></body>\n</html>\n",
    "ExternalReplyMessage": "<html>\n<body>\n<p>I'm at the Contoso worldwide reunion and will respond to your message as soon as I return.<br>\n</p></body>\n</html>\n"
    },
    "TimeZone": "Pacific Standard Time",
    "Language":{
        "Locale":"en-US",
        "DisplayName":"English (United States)"
    }
}

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

最低限必要なスコープ

以下のいずれかです。

サインイン中のユーザーが利用できる、1 人または複数の受信者に対してのメール ヒントを取得します。この操作は、GetMailTips 操作に対しての POST 操作として実行されます。

POST https://outlook.office.com/api/beta/me/GetMailTips
必須のパラメーター 種類 説明
本文パラメーター
EmailAddresses コレクション(文字列) メール ヒントを取得する受信者の SMTP アドレスのコレクションです。
MailTipsOptions MailTipsType 指定された受信者用に取得するメール ヒントの種類です。

応答の種類

メール ヒントのコレクションです。

要求のサンプル

次の使用例では、指定した受信者に対して、自動応答設定や「メールボックスがいっぱい」のステータスを示すメールヒントを取得します。

POST https://outlook.office.com/api/beta/me/GetMailTips
Content-Type: application/json

{
    "EmailAddresses": [
        "danas@contoso.onmicrosoft.com", 
        "fannyd@contoso.onmicrosoft.com"
    ],
    "MailTipsOptions": "AutomaticReplies, MailboxFullStatus"
}

応答のサンプル

Status code: 200 OK

{
    "@odata.context":"https://outlook.office.com/api/beta/$metadata#Collection(Microsoft.OutlookServices.MailTips)",
    "value":[
        {
            "EmailAddress":{
                "Name":"",
                "Address":"danas@contoso.onmicrosoft.com"
            },
            "AutomaticReplies":{
                "Message":"<style type=\"text/css\" style=\"\">\r\n<!--\r\np\r\n\t{margin-top:0;\r\n\tmargin-bottom:0}\r\n-->\r\n</style>\r\n<div dir=\"ltr\">\r\n<div id=\"x_divtagdefaultwrapper\" style=\"font-size:12pt; color:#000000; background-color:#FFFFFF; font-family:Calibri,Arial,Helvetica,sans-serif\">\r\n<p>Hi, I am on vacation right now. I'll get back to you after I return.<br>\r\n</p>\r\n</div>\r\n</div>",
                "MessageLanguage":{
                    "Locale":"en-US",
                    "DisplayName":"English (United States)"
                }
            },
            "MailboxFull":false
        },
        {
            "EmailAddress":{
                "Name":"",
                "Address":"fannyd@contoso.onmicrosoft.com"
            },
            "AutomaticReplies":{
                "Message":""
            },
            "MailboxFull":false
        }
    ]
}

添付ファイルを取得する

添付ファイルのコレクションまたは添付ファイルを取得できます。

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

最低限必要なスコープ

以下のいずれかです。

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

GET https://outlook.office.com/api/beta/me/messages/{message_id}/attachments
必須のパラメーター 種類 説明
URL パラメーター
message_id string メッセージ ID。

注意

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

応答の種類

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

要求と応答のサンプル

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

要求のサンプル

GET https://outlook.office.com/api/beta/me/messages/AAMkAGI2THVSAAA=/attachments?$select=Name

応答のサンプル

Status code: 200

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Messages('AAMkAGI2THVSAAA%3D')/Attachments(Name)",
    "value": [
        {
            "@odata.type": "#Microsoft.OutlookServices.FileAttachment",
            "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGI2THVSAAA=')/Attachments('AAMkAGI2j4kShdM=')",
            "Id": "AAMkAGI2j4kShdM=",
            "Name": "minutes.docx"
        }
    ]
}

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

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

Content-Type: application/json

{
  "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Messages('AAMkADFiNTPAAA%3D')/Attachments",
  "value": [
    {
      "@odata.type": "#Microsoft.OutlookServices.ItemAttachment",
      "@odata.id": "https://outlook.office.com/api/beta/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,
      "LastModifiedDateTime": "2015-09-24T05:57:59Z",
    }
  ]
}

添付ファイルを取得する

最低限必要なスコープ

以下のいずれかです。

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

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

注意

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

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

注意

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

応答の種類

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

サンプル要求 (添付ファイル)

次の例では、特定のメッセージに添付するファイルを取得します。

GET https://outlook.office.com/api/beta/me/messages/AAMkAGI2THVSAAA=/attachments/AAMkAGI2j4kShdM=

応答のサンプル

Status code: 200

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

サンプル要求 (参照添付ファイル)

次の例では、メッセージの参照添付ファイルを取得します。

GET https://outlook.office.com/api/beta/me/messages/AAMkAGE1Mbs88AADUv0uFAAA=/attachments/AAMkAGE1Mbs88AADUv0uFAAABEgAQAPSg72tgf7hJp0PICVGCc0g=

応答のサンプル

Status code: 200

{
  "@odata.context": "https://outlook.office.com/api/beta/$metadata#users('ddfcd489-628b-40d7-b48b-57002df800e5')/messages('AAMkAGE1Mbs88AADUv0uFAAA%3D')/attachments/$entity",
  "@odata.type": "#Microsoft.OutlookServices.ReferenceAttachment",
  "Id": "AAMkAGE1Mbs88AADUv0uFAAABEgAQAPSg72tgf7hJp0PICVGCc0g=",
  "LastModifiedDateTime": "2016-03-12T06:04:38Z",
  "Name": "Koala picture",
  "ContentType": null,
  "Size": 382,
  "IsInline": false,
  "SourceUrl": "https://contoso-my.spoppe.com/personal/danas_contoso_onmicrosoft_com/Documents/Pics/koala.jpg",
  "ProviderType": "OneDriveBusiness",
  "ThumbnailUrl": null,
  "PreviewUrl": null,
  "Permission": "Edit",
  "IsFolder": false
}

サンプル要求 (添付ファイルの $expand)

次の例では、メッセージのプロパティを持つ 3 つの参照添付ファイルすべてのインラインを取得して展開します。

GET https://outlook.office.com/api/beta/me/messages/AAMkAGE1Mbs88AADUv0uFAAA=/?$expand=attachments

応答のサンプル

Status code: 200

{
  "@odata.context": "https://outlook.office.com/api/beta/$metadata#users('ddfcd489-628b-40d7-b48b-57002df800e5')/messages/$entity",
  "@odata.etag": "W/\"CQAAABYAAACY4MQpaFz9SbqUDe4+bs88AADZsPav\"",
  "Id": "AAMkAGE1Mbs88AADUv0uFAAA=",
  "CreatedDateTime": "2016-03-08T01:01:57Z",
  "LastModifiedDateTime": "2016-03-12T06:18:54Z",
  "ChangeKey": "CQAAABYAAACY4MQpaFz9SbqUDe4+bs88AADZsPav",
  "Categories": [ ],
  "ReceivedDateTime": "2016-03-08T01:01:57Z",
  "SentDateTime": "2016-03-08T01:01:51Z",
  "HasAttachments": true,
  "InternetMessageId": "<SN2SR0101MB00299F0D7D22EE5D380104ED84B20@SN2SR0101MB0029.namsdf01.sdf.exchangelabs.com>",
  "Subject": "RE: New year activity",
  "Body": {
    "ContentType": "html",
    "Content": "<html>\r\n<<body>Let's gather to celebrate the new year! </body>\r\n</html>\r\n"
  },
  "BodyPreview": "What about the tulips?\r\n________________________________\r\nFrom: Dana Swope <danas@contoso.onmicrosoft.com>\r\nSent: Monday, March 7, 2016 10:51:39 PM\r\nTo: Dana Swope; Culinary Expert Group\r\nSubject: RE: New year activity\r\n\r\nLet's gather to celebrate the new year! ",
  "Importance": "Normal",
  "ParentFolderId": "AQMkAGE1MQN7j5uzzwAAAIBDAAAAA==",
  "Sender": {
    "EmailAddress": {
      "Name": "Dana Swope",
      "Address": "danas@contoso.onmicrosoft.com"
    }
  },
  "From": {
    "EmailAddress": {
      "Name": "Dana Swope",
      "Address": "danas@contoso.onmicrosoft.com"
    }
  },
  "ToRecipients": [
    {
      "EmailAddress": {
        "Name": "Dana Swope",
        "Address": "danas@contoso.onmicrosoft.com"
      }
    },
    {
      "EmailAddress": {
        "Name": "Culinary Expert Group",
        "Address": "Chefs@contoso.onmicrosoft.com"
      }
    }
  ],
  "CcRecipients": [ ],
  "BccRecipients": [ ],
  "ReplyTo": [ ],
  "ConversationId": "AAQkAGE1MMM2SaRFsKgx7BKVfig=",
  "ConversationIndex": "AQHRaThgdSG4wzZJpEWwqDHsEpV+KJ9OtWGUgAAkYLI=",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsRead": true,
  "IsDraft": false,
  "WebLink": "https://outlook.office.com/owa/?ItemID=AAMkAGE1Mbs88AADUv0uFAAA%3D&exvsurl=1&viewmodel=ReadMessageItem",
  "InferenceClassification": "Focused",
  "UnsubscribeData": [ ],
  "UnsubscribeEnabled": false,
  "Flag": { "FlagStatus": "NotFlagged" },
  "Attachments@odata.context": "https://outlook.office.com/api/beta/$metadata#users('ddfcd489-628b-40d7-b48b-57002df800e5')/messages('AAMkAGE1Mbs88AADUv0uFAAA%3D')/attachments",
  "Attachments": [
    {
      "@odata.type": "#Microsoft.OutlookServices.ReferenceAttachment",
      "Id": "AAMkAGE1Mbs88AADUv0uFAAABEgAQAL53d0u3BKBJmCxKVxZKBZ8=",
      "LastModifiedDateTime": "2016-03-12T05:54:31Z",
      "Name": "Personal pictures",
      "ContentType": null,
      "Size": 362,
      "IsInline": false,
      "SourceUrl": "https://contoso-my.spoppe.com/personal/danas_contoso_onmicrosoft_com/Documents/Pics",
      "ProviderType": "OneDriveBusiness",
      "ThumbnailUrl": null,
      "PreviewUrl": null,
      "Permission": "edit",
      "IsFolder": true
    },
    {
      "@odata.type": "#Microsoft.OutlookServices.ReferenceAttachment",
      "Id": "AAMkAGE1Mbs88AADUv0uFAAABEgAQAPSg72tgf7hJp0PICVGCc0g=",
      "LastModifiedDateTime": "2016-03-12T06:04:38Z",
      "Name": "Koala picture",
      "ContentType": null,
      "Size": 382,
      "IsInline": false,
      "SourceUrl": "https://contoso-my.spoppe.com/personal/danas_contoso_onmicrosoft_com/Documents/Pics/koala.jpg",
      "ProviderType": "OneDriveBusiness",
      "ThumbnailUrl": null,
      "PreviewUrl": null,
      "Permission": "edit",
      "IsFolder": false
    },
    {
      "@odata.type": "#Microsoft.OutlookServices.ReferenceAttachment",
      "Id": "AAMkAGE1Mbs88AADUv0uFAAABEgAQAO3wkFiM3KlCpn81m8qS1W0=",
      "LastModifiedDateTime": "2016-03-12T06:18:54Z",
      "Name": "Hydrangea picture",
      "ContentType": null,
      "Size": 412,
      "IsInline": false,
      "SourceUrl": "https://contoso-my.spoppe.com/personal/danas_contoso_onmicrosoft_com/Documents/Pics/hydrangea.jpg",
      "ProviderType": "OneDriveBusiness",
      "ThumbnailUrl": null,
      "PreviewUrl": null,
      "Permission": "edit",
      "IsFolder": false
    }
  ]
}

要求のサンプル (入れ子になった添付ファイル アイテムの $expand)

次の例では、入れ子になった添付ファイル アイテムを取得します。

GET https://outlook-sdf.office.com/api/beta/me/messages/AAMkAGE1Mbs88AADUv0uFAAA=/attachments/AAMkAGE1Mbs88AADUv0uFAAABEgAQAL53d0u3BKBJmCxKVxZKBZ8=$expand=Microsoft.OutlookServices.ItemAttachment/Item

応答のサンプル

Status code: 200

{
    "Id": "AAMkAGE1Mbs88AADUv0uFAAABEgAQAL53d0u3BKBJmCxKVxZKBZ8=",
    "LastModifiedDateTime": "2017-04-25T20:05:55Z",
    "Name": "RE: Changes to GetConditionMetadata handler",
    "ContentType": null,
    "Size": 78927,
    "IsInline": false,
    "Item": {
        "Id": "", 
        "Name": "How to retrieve item attachment using Outlook REST API",
        "ContentType": message/rfc822,
        "Size": 71094,
        "IsInline": false,
        "LastModifiedDateTime": "2015-09-24T05:57:59Z",
    }
}

添付ファイルを作成する

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

添付ファイルを作成する

最低限必要なスコープ

以下のいずれかです。

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

POST https://outlook.office.com/api/beta/me/messages/{message_id}/attachments
必須のパラメーター 種類 説明
URL パラメーター
message_id string メッセージ ID。
本文パラメーター
@odata.type string #Microsoft.OutlookServices.FileAttachment
名前 string 添付ファイルの名前。
ContentBytes バイナリ 添付するファイル。

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

応答の種類

新しい添付ファイル。

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

最低限必要なスコープ

以下のいずれかです。

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

POST https://outlook.office.com/api/beta/me/messages/{message_id}/attachments
必須のパラメーター 種類 説明
URL パラメーター
message_id string メッセージ ID。
本文パラメーター
@odata.type string #Microsoft.OutlookServices.ItemAttachment
名前 string 添付ファイルの名前。
アイテム Message または Event エンティティです。 添付するアイテム。

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

応答の種類

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

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

最低限必要なスコープ

以下のいずれかです。

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

POST https://outlook.office.com/api/beta/me/messages/{message_id}/attachments
必須のパラメーター 種類 説明
URL パラメーター
message_id 文字列 メッセージ ID。
本文パラメーター
@odata.type 文字列 #Microsoft.OutlookServices.ReferenceAttachment
名前 文字列 添付ファイルの表示名。必須。
SourceUrl 文字列 添付ファイルの内容を取得するための URL。フォルダーへの URL の場合、Outlook または Outlook on the web 上でフォルダーが正しく表示されるには、IsFolder を true に設定します。必須。

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

応答の種類

参照添付ファイル。

要求のサンプル

次の例では、既存メッセージに参照添付ファイルを追加します。添付ファイルは、OneDrive for Business 上のファイルへのリンクです。

POST https://outlook.office.com/api/beta/me/messages/AAMkAGE1Mbs88AADUv0uFAAA=/attachments
Content-Type: application/json

{ 
    "@odata.type": "#Microsoft.OutlookServices.ReferenceAttachment", 
    "Name": "Koala picture", 
    "SourceUrl": "https://contoso-my.spoppe.com/personal/danas_contoso_onmicrosoft_com/Documents/Pics/koala.jpg", 
    "ProviderType": "oneDriveBusiness", 
    "Permission": "Edit", 
    "IsFolder": "False" 
}

応答のサンプル

Status code: 201 Created

{
  "@odata.context": "https://outlook.office.com/api/beta/$metadata#users('ddfcd489-628b-40d7-b48b-57002df800e5')/messages('AAMkAGE1Mbs88AADUv0uFAAA%3D')/attachments/$entity",
  "@odata.type": "#Microsoft.OutlookServices.ReferenceAttachment",
  "Id": "AAMkAGE1Mbs88AADUv0uFAAABEgAQAPSg72tgf7hJp0PICVGCc0g=",
  "LastModifiedDateTime": "2016-03-12T06:04:38Z",
  "Name": "Koala picture",
  "ContentType": null,
  "Size": 382,
  "IsInline": false,
  "SourceUrl": "https://contoso-my.spoppe.com/personal/danas_contoso_onmicrosoft_com/Documents/Pics/koala.jpg",
  "ProviderType": "oneDriveBusiness",
  "ThumbnailUrl": null,
  "PreviewUrl": null,
  "Permission": "edit",
  "IsFolder": false
}

要求のサンプル

次の例では、下書きメッセージを作成する場合と同じ呼び出しで、参照添付ファイルを追加します。添付ファイルは、OneDrive for Business 上のファイルへのリンクです。

POST https://outlook.office.com/api/beta/me/messages
Content-Type: application/json

{
    "Subject": "Plan for dinner",
    "Body": {
      "ContentType": "HTML",
      "Content": "Office anniversary is coming soon!"
    },
    "ToRecipients": [
      {
        "EmailAddress": {
          "Address": "randiw@contoso.onmicrosoft.com"
        }
      }
    ],
    "Attachments": [
      {
        "@odata.type": "#Microsoft.OutlookServices.ReferenceAttachment", 
        "Name": "Hydrangea picture", 
        "SourceUrl": "https://contoso-my.spoppe.com/personal/danas_contoso_onmicrosoft_com/Documents/Pics/hydrangea.jpg", 
        "ProviderType": "oneDriveBusiness", 
        "Permission": "Edit", 
        "IsFolder": "False" 
      }
    ]
}

応答のサンプル

Status code: 201 Created

{
  "@odata.context": "https://outlook.office.com/api/beta/$metadata#users('ddfcd489-628b-40d7-b48b-57002df800e5')/messages/$entity",
  "@odata.etag": "W/\"CQAAABYAAACY4MQpaFz9SbqUDe4+bs88AADZ8qi1\"",
  "Id": "AAMkAGE1Mbs88AADZ0CU9AAA=",
  "CreatedDateTime": "2016-03-12T09:04:54Z",
  "LastModifiedDateTime": "2016-03-12T09:04:54Z",
  "ChangeKey": "CQAAABYAAACY4MQpaFz9SbqUDe4+bs88AADZ8qi1",
  "Categories": [ ],
  "ReceivedDateTime": "2016-03-12T09:04:54Z",
  "SentDateTime": "2016-03-12T09:04:54Z",
  "HasAttachments": true,
  "InternetMessageId": "<BL2SR0101MB00188944566BDECE6EDE57F384B60@BL2SR0101MB0018.namsdf01.sdf.exchangelabs.com>",
  "Subject": "Plan for dinner",
  "Body": {
    "ContentType": "html",
    "Content": "<html>\r\n<body>\r\nOffice anniversary is coming soon!\r\n</body>\r\n</html>\r\n"
  },
  "BodyPreview": "Office anniversary is coming soon!",
  "Importance": "normal",
  "ParentFolderId": "AQMkAGE1MQN7j5uzzwAAAIBDwAAAA==",
  "Sender": null,
  "From": null,
  "ToRecipients": [
    {
      "EmailAddress": {
      "Name": "Randi Welch",
      "address": "randiw@contoso.onmicrosoft.com"
      }
    }
  ],
  "CcRecipients": [ ],
  "BccRecipients": [ ],
  "ReplyTo": [ ],
  "ConversationId": "AAQkAGE1MMAAQAJk0cqqggzpKtIHErqyDkcU=",
  "ConversationIndex": "AQHRfD4+mTRyqqCDOkq0gcSurIORxQ==",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsRead": true,
  "IsDraft": true,
  "WebLink": "https://outlook.office.com/owa/?ItemID=AAMkAGE1Mbs88AADZ0CU9AAA%3D&exvsurl=1&viewmodel=ReadMessageItem",
  "InferenceClassification": "focused",
  "UnsubscribeData": [ ],
  "UnsubscribeEnabled": false,
  "Flag": { "flagStatus": "notFlagged" },
  "Attachments@odata.context": "https://outlook.office.com/api/beta/$metadata#users('ddfcd489-628b-40d7-b48b-57002df800e5')/messages('AAMkAGE1Mbs88AADZ0CU9AAA%3D')/attachments",
  "Attachments": [
    {
      "@odata.type": "#Microsoft.OutlookServices.ReferenceAttachment",
      "Id": "AAMkAGE1Mbs88AADZ0CU9AAABEgAQAGe4H1iqXwtLsrCCLLkDxqo=",
      "LastModifiedDateTime": null,
      "Name": "Hydrangea picture",
      "ContentType": null,
      "Size": 0,
      "IsInline": false,
      "SourceUrl": "https://contoso-my.spoppe.com/personal/danas_contoso_onmicrosoft_com/Documents/Pics/hydrangea.jpg",
      "ProviderType": "oneDriveBusiness",
      "ThumbnailUrl": null,
      "PreviewUrl": null,
      "Permission": "edit",
      "IsFolder": false
    }
  ]
}

添付ファイルを削除する

最低限必要なスコープ

以下のいずれかです。

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

DELETE https://outlook.office.com/api/beta/me/messages/{message_id}/attachments/{attachment_id}
必須のパラメーター 種類 説明
URL パラメーター
message_id string メッセージ ID。
attachment_id string 添付ファイル ID。

要求のサンプル

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

応答のサンプル

Status code: 204

フォルダーを取得する

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

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

最低限必要なスコープ

以下のいずれかです。

サインインしているユーザーのメールボックス内のすべてのメール フォルダーを取得する (.../me/MailFolders) か、指定されたフォルダーからフォルダー コレクションを取得します。

GET https://outlook.office.com/api/beta/me/MailFolders
GET https://outlook.office.com/api/beta/me/MailFolders/{folder_id}/childfolders

注意

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

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

要求のサンプル

GET https://outlook.office.com/api/beta/me/MailFolders

応答のサンプル

Status code: 200

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/MailFolders",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/MailFolders('AAMkAGI2AAEKAAA=')",
            "Id": "AAMkAGI2AAEKAAA=",
            "DisplayName": "Deleted Items",
            "ParentFolderId": "AAMkAGI2AAEIAAA=",
            "ChildFolderCount": 0,
            "UnreadItemCount": 0,
            "TotalItemCount": 1,
            "WellKnownName": "deleteditems"
        },
        {
            "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/MailFolders('AAMkAGI2AAEPAAA=')",
            "Id": "AAMkAGI2AAEPAAA=",
            "DisplayName": "Drafts",
            "ParentFolderId": "AAMkAGI2AAEIAAA=",
            "ChildFolderCount": 0,
            "UnreadItemCount": 0,
            "TotalItemCount": 0,
            "WellKnownName": "drafts"
        },
        {
            "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/MailFolders('AAMkAGI2AAEMAAA=')",
            "Id": "AAMkAGI2AAEMAAA=",
            "DisplayName": "Inbox",
            "ParentFolderId": "AAMkAGI2AAEIAAA=",
            "ChildFolderCount": 0,
            "UnreadItemCount": 6,
            "TotalItemCount": 6,
            "WellKnownName": "inbox"
        },
        {
            "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/MailFolders('AAMkAGI2AAEeAAA=')",
            "Id": "AAMkAGI2AAEeAAA=",
            "DisplayName": "Junk Email",
            "ParentFolderId": "AAMkAGI2AAEIAAA=",
            "ChildFolderCount": 0,
            "UnreadItemCount": 0,
            "TotalItemCount": 0,
            "WellKnownName": "junkemail"
        },
        {
            "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/MailFolders('AAMkAGI2AAELAAA=')",
            "Id": "AAMkAGI2AAELAAA=",
            "DisplayName": "Outbox",
            "ParentFolderId": "AAMkAGI2AAEIAAA=",
            "ChildFolderCount": 0,
            "UnreadItemCount": 0,
            "TotalItemCount": 0,
            "WellKnownName": "outbox"
        },
        {
            "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/MailFolders('AAMkAGI2AAEJAAA=')",
            "Id": "AAMkAGI2AAEJAAA=",
            "DisplayName": "Sent Items",
            "ParentFolderId": "AAMkAGI2AAEIAAA=",
            "ChildFolderCount": 0,
            "UnreadItemCount": 0,
            "TotalItemCount": 3,
            "WellKnownName": "sentitems"
        }
    ]
}

応答の種類

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

フォルダーを取得する

最低限必要なスコープ

以下のいずれかです。

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

サインインしているユーザーのフォルダーを取得します。

GET https://outlook.office.com/api/beta/me/MailFolders/{folder_id}

ユーザーが共有しているメールボックス フォルダーを取得します。

GET https://outlook.office.com/api/beta/users/{user_id}/mailFolders/{folder_id}

注意

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

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

要求のサンプル

サインインしているユーザーの受信トレイを取得します

GET https://outlook.office.com/api/beta/me/MailFolders/inbox

応答のサンプル

Status code: 200

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/MailFolders/$entity",
    "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/MailFolders('AAMkAGI2AAEMAAA=')",
    "Id": "AAMkAGI2AAEMAAA=",
    "DisplayName": "Inbox",
    "ParentFolderId": "AAMkAGI2AAEIAAA=",
    "ChildFolderCount": 0,
    "UnreadItemCount": 6,
    "TotalItemCount": 6,
    "WellKnownName": "inbox"
}

要求のサンプル

他のユーザーが共有したフォルダーを取得する

GET https://outlook.office.com/api/beta/users/8c14ebe1-e4ba-4232cd011db47/mailFolders/AAMkADk0MGFkODE3LWE4MmYtNDRhOS04OGQxLTM

応答のサンプル

HTTP/1.1 200 OK

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/MailFolders/$entity",
    "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/MailFolders('AAMkADk0MGFkODE3LWE4MmYtNDRhOS04OGQxLTM')",
    "Id": "AAMkADk0MGFkODE3LWE4MmYtNDRhOS04OGQxLTM",
    "DisplayName": "Inbox",
    "ParentFolderId": "AAMkADk0MGFkODE3LWE4MmYtNDRhOS04OGQxLTM4QCHGmLqkYhISaO_lSymODLQABa6L5YpAAA=",
    "ChildFolderCount": 4,
    "UnreadItemCount": 27962,
    "TotalItemCount": 64420
}

応答の種類

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

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

メールボックス内のすべてのフォルダーのフラットなテーブルを取得できます。メール フォルダー階層を同期するときは、このカテゴリを要求します。

エンドポイント フォルダー カテゴリ
Me/MailFolders メール フォルダー

各フォルダー カテゴリの最上位レベルのみを同期できます。たとえば、Me/MailFolders は要求できますが、Me/MailFolders('inbox') は要求できません。

同期では、階層内のすべてのフォルダーを取得する完全な同期と、最後の完全な同期から変更されたすべてのフォルダーを取得する差分同期の両方がサポートされています。

最低限必要なスコープ

以下のいずれかです。

GET https://outlook.office.com/api/beta/me/MailFolders
必須のパラメーター 種類 説明
ヘッダー パラメーター
優先 odata.trackchanges 要求が同期要求であることを示します。
本文パラメーター
odata.deltaLink string 前回フォルダー階層が同期されたことを示すトークン。

クエリ パラメーター $filter、$orderby、$search、$top のどれが要求に含まれていても、これらは無視されます。

応答の種類

要求されたカテゴリ内のフォルダーのフラット リストです。

フォルダーを作成する

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

フォルダーを作成する

最低限必要なスコープ

以下のいずれかです。

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

POST https://outlook.office.com/api/beta/me/MailFolders/{folder_id}/childfolders
必須のパラメーター 種類 説明
URL パラメーター
folder_id string フォルダーの ID、あるいは Inbox、Drafts、SentItems または DeletedItems の既知のフォルダー名です。
本文パラメーター
DisplayName string フォルダーの表示名です。

要求のサンプル

POST https://outlook.office.com/api/beta/me/MailFolders/inbox/childfolders
Content-Type: application/json

{
  "DisplayName": "Company"
}

応答のサンプル

Status code: 201

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

応答の種類

新しいフォルダーです。

注釈

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

フォルダーを更新する

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

フォルダーを更新する

最低限必要なスコープ

以下のいずれかです。

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

PATCH https://outlook.office.com/api/beta/me/MailFolders/{folder_id}
必須のパラメーター 種類 説明
URL パラメーター
folder_id string フォルダーの ID、あるいは Inbox、Drafts、SentItems または DeletedItems の既知のフォルダー名です。
本文パラメーター
DisplayName string フォルダーの新しい表示名です。

要求のサンプル

PATCH https://outlook.office.com/api/beta/me/MailFolders/AAMkAGE0Mz-l_AAA=
Content-Type: application/json

{
  "DisplayName": "Business"
}

応答のサンプル

Status code: 200

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

応答の種類

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

フォルダーを削除する

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

注意

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

フォルダーを削除する

最低限必要なスコープ

以下のいずれかです。

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

DELETE https://outlook.office.com/api/beta/me/MailFolders/{folder_id}
必須のパラメーター 種類 説明
URL パラメーター
folder_id string フォルダーの ID、あるいは Inbox、Drafts、SentItems または DeletedItems の既知のフォルダー名です。

要求のサンプル

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

応答のサンプル

Status code: 204

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

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

フォルダーを移動する

最低限必要なスコープ

以下のいずれかです。

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

POST https://outlook.office.com/api/beta/me/MailFolders/{folder_id}/move
必須のパラメーター 種類 説明
URL パラメーター
folder_id string フォルダーの ID、あるいは Inbox、Drafts、SentItems または DeletedItems の既知のフォルダー名です。
本文パラメーター
DestinationId string 宛先フォルダーの ID、あるいは Inbox、Drafts、SentItems または DeletedItems の既知のフォルダー名です。

要求のサンプル

POST https://outlook.office.com/api/beta/me/MailFolders/AAMkAGE0Mz-l_AAA=/move
Content-Type: application/json

{
  "DestinationId": "AAMkAGE0MyxQ9AAA="
}

応答のサンプル

Status code: 201

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

応答の種類

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

フォルダーをコピーする

最低限必要なスコープ

以下のいずれかです。

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

POST https://outlook.office.com/api/beta/me/MailFolders/{folder_id}/copy
必須のパラメーター 種類 説明
URL パラメーター
folder_id string フォルダーの ID、あるいは Inbox、Drafts、SentItems または DeletedItems の既知のフォルダー名です。
本文パラメーター
DestinationId string 宛先フォルダーの ID、あるいは Inbox、Drafts、SentItems または DeletedItems の既知のフォルダー名です。

要求のサンプル

POST https://outlook.office.com/api/beta/me/MailFolders/AAMkAGE0Mz-l_AAA=/copy
Content-Type: application/json

{
  "DestinationId": "inbox"
}

応答のサンプル

Status code: 201

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

応答の種類

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

次の手順

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

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