次の方法で共有

user: sendMail

  • [アーティクル]

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

要求本文に指定されたメッセージを、JSON または MIME 形式で送信します。

JSON 形式を使用する場合は、 添付ファイル を含め、 メンション を使用して新しいメッセージで別のユーザーを呼び出すことができます。

MIME 形式を使用すると、以下のことが可能になります。

このメソッドでは、[送信済みアイテム] フォルダーにメッセージを保存できます。

また、後で送信するための下書きメッセージを作成することもできます。

メールが受信者に配信される前のバックエンドに関連する手順の詳細については、 こちらを参照してください。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ✅ ✅ ✅

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) Mail.Send 注意事項なし。
委任 (個人用 Microsoft アカウント) Mail.Send 注意事項なし。
アプリケーション Mail.Send 注意事項なし。

HTTP 要求

POST /me/sendMail
POST /users/{id | userPrincipalName}/sendMail

要求ヘッダー

名前 種類 説明
Authorization string ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type string エンティティ本文内のデータの性質です。 必須です。
JSON オブジェクトには application/json を、MIME コンテンツには text/plain を使用します。

要求本文

JSON オブジェクトを使用する場合、次のパラメーターを含む JSON オブジェクトを指定します。

パラメーター 種類 説明
メッセージ Message 送信するメッセージです。 必須。
SaveToSentItems ブール値 [送信済みアイテム] 内のメッセージを保存するかどうかを示します。 パラメーターが false の場合にのみ指定します。既定値は true です。 省略可能。

メンションを使用して新しいメッセージで別のユーザーを呼び出すには:

  • 要求本文 に、必須の toRecipients プロパティ、 mentions プロパティ、および書き込み可能なメッセージ プロパティを含めます。
  • mentions プロパティのメンションごとに、メンションされたプロパティを指定する必要があります。

ボディを MIME 形式で指定する場合は、要求本文に MIME コンテンツを Base64 エンコードした文字列として指定します。 パラメーターは含めないでください。

応答

成功した場合、このメソッドは 202 Accepted 応答コードを返します。 応答本文では何も返されません。

注: 202 Accepted 応答コードは、要求が受け入れられたことを示しますが、要求処理が完了したことを示すものではありません。 メッセージの配信には、 Exchange Online の制限と調整が適用されます。

要求本文に形式が正しくない MIME コンテンツが含まれている場合、このメソッドは 400 Bad request と次のエラー メッセージを返します。"MIME コンテンツの base64 文字列が無効です" というエラー メッセージが返されます。

例

例 1: JSON 形式を使用して新規メールを送信する

要求

POST https://graph.microsoft.com/beta/me/sendMail
Content-type: application/json

{
  "message": {
    "subject": "Meet for lunch?",
    "body": {
      "contentType": "Text",
      "content": "The new cafeteria is open."
    },
    "toRecipients": [
      {
        "emailAddress": {
          "address": "samanthab@contoso.com"
        }
      }
    ],
    "ccRecipients": [
      {
        "emailAddress": {
          "address": "danas@contoso.com"
        }
      }
    ]
  },
  "saveToSentItems": "false"
}

応答

HTTP/1.1 202 Accepted

例 2: @-mention を含むメッセージを送信する

この例では、サインインしているユーザーによる Samantha Booth へのメッセージを示します。 メッセージには、別のユーザー Dana Swope のメンションも含まれています。

要求

POST https://graph.microsoft.com/beta/me/sendMail
Content-type: application/json

{
  "message": {
    "subject": "Project kickoff",
    "toRecipients": [
      {
        "emailAddress": {
          "name": "Samantha Booth",
          "address": "samanthab@contoso.com"
        }
      }
    ],
    "mentions": [
      {
        "mentioned": {
          "name": "Dana Swope",
          "address": "danas@contoso.com"
        }
      }
    ]
  }
}

応答

HTTP/1.1 202 Accepted

例 3: カスタム インターネット メッセージ ヘッダーを含むメッセージを送信する

要求

POST https://graph.microsoft.com/beta/me/sendMail
Content-type: application/json

{
  "message": {
    "subject": "9/9/2018: concert",
    "body": {
      "contentType": "HTML",
      "content": "The group represents Nevada."
    },
    "toRecipients": [
      {
        "emailAddress": {
          "address": "AlexW@contoso.com"
        }
      }
    ],
    "internetMessageHeaders": [
      {
        "name": "x-custom-header-group-name",
        "value": "Nevada"
      },
      {
        "name": "x-custom-header-group-id",
        "value": "NV001"
      }
    ]
  }
}

応答

HTTP/1.1 202 Accepted

例 4: 添付ファイルを含むメッセージを送信する

要求

POST https://graph.microsoft.com/beta/me/sendMail
Content-type: application/json

{
  "message": {
    "subject": "Meet for lunch?",
    "body": {
      "contentType": "Text",
      "content": "The new cafeteria is open."
    },
    "toRecipients": [
      {
        "emailAddress": {
          "address": "meganb@contoso.com"
        }
      }
    ],
    "attachments": [
      {
        "@odata.type": "#microsoft.graph.fileAttachment",
        "name": "attachment.txt",
        "contentType": "text/plain",
        "contentBytes": "SGVsbG8gV29ybGQh"
      }
    ]
  }
}

応答

HTTP/1.1 202 Accepted

例 5: MIME 形式を使用して新しいメッセージを送信する

要求

POST https://graph.microsoft.com/beta/me/sendMail
Content-type: text/plain

RnJvbTogQWRlbGUgVmFuY2UgPEFkZWxlVkBjb250b3NvLmNvbT4KVG86IEFsZXggV2lsYmVyIDxB
bGV4V0Bjb250b3NvLmNvbT4KU3ViamVjdDpUZXN0IE1lc3NhZ2UKQ29udGVudC1UeXBlOiBtdWx0
aXBhcnQvbWl4ZWQ7Cglib3VuZGFyeT0iXzAwNF9UWVpQUjA0TUI2OTgxNzNGRDAwMjE1MkQ1QURC
OEZCNDdDOEJDQVRZWlBSMDRNQjY5ODFhcGNwXyIKTUlNRS1WZXJzaW9uOiAxLjAKCi0tXzAwNF9U
WVpQUjA0TUI2OTgxNzNGRDAwMjE1MkQ1QURCOEZCNDdDOEJDQVRZWlBSMDRNQjY5ODFhcGNwXwpD
b250ZW50LVR5cGU6IG11bHRpcGFydC9hbHRlcm5hdGl2ZTsKCWJvdW5kYXJ5PSJfMDAwX1RZWlBS
MDRNQjY5ODE3M0ZEMDAyMTUyRDVBREI4RkI0N0M4QkNBVFlaUFIwNE1CNjk4MWFwY3BfIgoKLS1f
MDAwX1RZWlBSMDRNQjY5ODE3M0ZEMDAyMTUyRDVBREI4RkI0N0M4QkNBVFlaUFIwNE1CNjk4MWFw
Y3BfCkNvbnRlbnQtVHlwZTogdGV4dC9wbGFpbjsgY2hhcnNldD0iaXNvLTg4NTktMSIKQ29udGVu
dC1UcmFuc2Zlci1FbmNvZGluZzogcXVvdGVkLXByaW50YWJsZQoKdGVzdCB0ZXh0IGJvZHkKCgot
LV8wMDBfVFlaUFIwNE1CNjk4MTczRkQwMDIxNTJENUFEQjhGQjQ3QzhCQ0FUWVpQUjA0TUI2OTgx
YXBjcF8KQ29udGVudC1UeXBlOiB0ZXh0L2h0bWw7IGNoYXJzZXQ9Imlzby04ODU5LTEiCkNvbnRl
bnQtVHJhbnNmZXItRW5jb2Rpbmc6IHF1b3RlZC1wcmludGFibGUKCjxodG1sPgo8aGVhZD4KPC9o
ZWFkPgo8Ym9keT4KdGVzdCBodG1sIGJvZHkKPC9ib2R5Pgo8L2h0bWw+CgotLV8wMDBfVFlaUFIw
NE1CNjk4MTczRkQwMDIxNTJENUFEQjhGQjQ3QzhCQ0FUWVpQUjA0TUI2OTgxYXBjcF8tLQoKLS1f
MDA0X1RZWlBSMDRNQjY5ODE3M0ZEMDAyMTUyRDVBREI4RkI0N0M4QkNBVFlaUFIwNE1CNjk4MWFw
Y3BfCkNvbnRlbnQtVHlwZTogdGV4dC9wbGFpbjsKQ29udGVudC1EaXNwb3NpdGlvbjogYXR0YWNo
bWVudDsKICAgICAgICBmaWxlbmFtZT0idGVzdC50eHQiCgp0aGlzIGlzIHRoZSBhdHRhY2htZW50
IHRleHQKCi0tXzAwNF9UWVpQUjA0TUI2OTgxNzNGRDAwMjE1MkQ1QURCOEZCNDdDOEJDQVRZWlBS
MDRNQjY5ODFhcGNwXy0t

応答

次の例は応答を示しています。

HTTP/1.1 202 Accepted

要求本文に不正な MIME コンテンツが含まれていた場合、このメソッドは次のエラー メッセージを返します。

HTTP/1.1 400 Bad Request
Content-type: application/json

{
  "error": {
    "code": "ErrorMimeContentInvalidBase64String",
    "message": "Invalid base64 string for MIME content."
  }
}

例 6: フォローアップのフラグが設定された新しいメッセージを送信する

要求

POST https://graph.microsoft.com/beta/me/sendMail
Content-type: application/json

{
  "subject": "Please respond by Friday",
  "toRecipients": [
    {
      "emailAddress": {
        "address": "meganb@contoso.com"
      }
    }
  ],
  "flag": {
    "flagStatus": "flagged",
    "startDateTime": {
      "dateTime": "2023-08-30T12:13:00",
      "timeZone": "Eastern Standard Time"
    },
    "dueDateTime": {
      "dateTime": "2023-09-01T17:00:00",
      "timeZone": "Eastern Standard Time"
    }
  }
}

応答

HTTP/1.1 202 Accepted