---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# メール API

# メール API {#ariaid-title1}

* リリースバージョン: Xanadu
* 
* 更新日 2026年06月24日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：12分

メール API は、REST を使用したメールメッセージの送受信を可能にするエンドポイントを提供します。{#email-api__release-notes-feature-description}
ユーザーがメールを送信するには、email_api_send ロールが必要です。  
注:  
メール \[sys_email\] テーブルへの読み取り/書き込みアクセス権がない場合は、エラーが発生する可能性があります。

## メール - GET /now/email/{id} {#ariaid-title2}

指定されたメールレコードのメールの詳細を返します。

### URL 形式 {#email-GET__section_kdx_pzs_cmb}

バージョニングされた URL：/api/now/{api_version}/email/{id}

### サポートされている要求パラメーター

{#email-GET__entry__2}{#email-GET__version-RESTAPI}

| 名前 | 説明 |
|-|-|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、<kbd class="ph userinput">v1</kbd> や <kbd class="ph userinput">v2</kbd>。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
| id | 詳細を返すメールの sys_id。メール \[sys_email\] テーブルにあります。 |
[表 : 1. パスパラメーター]

{#email-GET__entry__8}

| 名前 | 説明 |
|-|-|
| sysparm_fields | 応答で返すカンマで区切られたフィールドのリストです。 データタイプ：文字列 |
[表 : 2. クエリパラメーター]

{#email-GET__entry__12}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 3. 要求本文パラメーター (XML または JSON)]

### ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#email-GET__entry__16}{#email-GET__accept-RESTAPI}

| ヘッダー | 説明 |
|-|-|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json |
[表 : 4. 要求ヘッダー]

{#email-GET__entry__20}

| ヘッダー | 説明 |
|-|-|
| なし |   |
[表 : 5. 応答ヘッダー]

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#email-GET__entry__24}{#email-GET__entry-200-status-code}{#email-GET__entry-401-status-code}{#email-GET__entry-500-status-code}

| ステータスコード | 説明 |
|-|-|
| 200 | 成功。要求が正常に処理されました。 |
| 401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 |
| 403 | レコードが見つからないか、要求元ユーザーにレコードへのアクセス権がないことを示します。ユーザーに適切なロールとアクセス権限があることを確認します。 |
| 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 |
[表 : 6. ステータスコード]

### 応答本文のパラメーター (JSON または XML)

{#email-GET__entry__34}

| 要素 | 説明 |
|-|-|
| bcc | メールメッセージを Bcc される受信者のメールアドレスのリスト。blind_copied フィールドにマップされます。 データタイプ：アレイ |
| cc | メールメッセージを Cc される受信者のメールアドレスのリスト。copied フィールドにマップされます。 データタイプ：アレイ |
| headers | メッセージとその値に関連付けられたヘッダーの名前と値のペア。 データタイプ：オブジェクト |
| html | メールメッセージの HTML 対応本文。body フィールドにマップされます。 データタイプ：文字列 |
| id | メールレコードの sys_id。 データタイプ：文字列 |
| importance | メールメッセージの重要性。重要性フィールドにマップされます。 データタイプ：文字列 |
| state | メールメッセージの処理ステータス。システムスケジュール設定済みジョブがメールメッセージを処理したかどうかを示します。 次の値が含まれます。 * error * ignored * processed * ready {#email-GET__ul_l1x_dp2_zw} データタイプ：文字列 |
| subject | メールメッセージの件名。subject フィールドにマップされます。 データタイプ：文字列 |
| text | メールメッセージのテキストのみの本文。body_text フィールドにマップされます。 データタイプ：文字列 |
| to | メールメッセージを直接送られる受信者のメールアドレスのリスト。recipients フィールドにマップされます。 データタイプ：アレイ |
| type | 受信または送信メールとしてのメールメッセージの現在のステータス。 次の値が含まれます。 * 受信 * 受信 - 無視 * 送信-失敗 * 送信 - 無視 * 送信-準備完了 * 送信 {#email-GET__ul_z3k_n42_zw} データタイプ：文字列 |
[ ]

### サンプル cURL 要求

    curl "http://instance.servicenow.com/api/now/email/06e095427f0022007f005212bdfa91b3" \
    --request GET \
    --header "Accept:application/json" \
    --user "user-name":"password"

    {
      "result" : {
        "headers" : {
          "X-ServiceNow-SysEmail-Version" : "2",
          "X-ServiceNow-Source" : "Notification-24e34b54c61122aa0108c1b7a33697cf"
        },
        "cc" : [
          ""
        ],
        "type" : "send-ready",
        "html" : "<html><head></head><body><div><p><font size=\"5\" color=\"#808080\" face=\"helvetica\"><strong>Incident has been closed.</strong></font></p></div>\n\t\t<div><p><font size=\"4\" color=\"#808080\" face=\"helvetica\"><strong>Summary details</strong></font></p><p><font size=\"3\" color=\"#808080\" face=\"helvetica\">Closed by: System Administrator</font></p><p><font size=\"3\" color=\"#808080\" face=\"helvetica\">Closed notes: Fixed</font></p></div>\n\t\t<div><p><font size=\"3\" color=\"#808080\" face=\"helvetica\">You can view all the details of the incident by following the link below:</font></p><font face=\"helvetica\"><a href=\"incident.do?sys_id=e8e875b0c0a80164009dc852b4d677d5&amp;sysparm_stack=incident_list.do?sysparm_query=active=true\" style=\"background-color: #278efc;border: 1px solid #0368d4;color: #ffffff;font-size: 16px;font-family: Helvetica, Arial, sans-serif;text-decoration: none; border-radius: 3px;-webkit-border-radius: 3px;-moz-border-radius: 3px;display: inline-block;padding: 5px;\">Take me to the Incident</a></font><br /><br /><p><font size=\"3\" color=\"#808080\" face=\"helvetica\">Thank you.</font></p></div><div> </div><div style=\"display:inline\">Ref:MSG0000006</div></body></html>",
        "bcc" : [
          ""
        ],
        "subject" : "Your incident INC0000005 has been closed",
        "to" : [
          "alejandro.mascall@example.com"
        ],
        "state" : "ready",
        "id" : "06e095427f0022007f005212bdfa91b3",
        "importance" : "",
        "text" : ""
      }
    }

## メール - POST /now/email {#ariaid-title3}

渡された情報を使用してメールレコードを作成します。

### URL 形式 {#email-POST__section_urw_jpt_cmb}

バージョニングされた URL：/api/now/{api_version}/email

### サポートされている要求パラメーター

{#email-POST__entry__2}{#email-POST__version-RESTAPI}

| 名前 | 説明 |
|-|-|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、<kbd class="ph userinput">v1</kbd> や <kbd class="ph userinput">v2</kbd>。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
[表 : 7. パスパラメーター]

{#email-POST__entry__6}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 8. クエリパラメーター]

{#email-POST__entry__10}

| 要素 | 説明 |
|-|-|
| bcc | メールメッセージを Bcc される受信者のメールアドレスのリスト。blind_copied フィールドにマップされます。 注: このフィールドには最大 100 件のアドレスのみを指定できます。 データタイプ：アレイ |
| cc | メールメッセージを Cc される受信者のメールアドレスのリスト。copied フィールドにマップされます。 注: このフィールドには最大 100 件のアドレスのみを指定できます。 データタイプ：アレイ |
| headers | メッセージとその値に関連付けられたヘッダーの名前と値のペア。 データタイプ：オブジェクト |
| html | メールメッセージの HTML 対応本文。body フィールドにマップされます。 データタイプ：文字列 |
| importance | メールメッセージの重要性。重要性フィールドにマップされます。 データタイプ：文字列 |
| subject | メールメッセージの件名。subject フィールドにマップされます。 データタイプ：文字列 |
| table_name | メールを保存するテーブルの名前。このパラメーターを使用して、システムの別の場所にある特定の関連レコードにメールメッセージを関連付けます。 注: このパラメーターでは、table_record_id パラメーターも指定する必要があります。 データタイプ：文字列 |
| table_record_id | メールが適用されるターゲット関連レコード。このパラメーターを使用して、システムの別の場所にある特定の関連レコードにメールメッセージを関連付けます。 注: このパラメーターでは、table_name パラメーターも指定する必要があります。 データタイプ：文字列 |
| text | メールメッセージのテキストのみの本文。body_text フィールドにマップされます。 データタイプ：文字列 |
| to | 必須です。メールメッセージを直接送られる受信者のメールアドレスのリスト。recipients フィールドにマップされます。 注: このフィールドには最大 100 件のアドレスのみを指定できます。 データタイプ：アレイ |
[表 : 9. 要求本文パラメーター (XML または JSON)]

### ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#email-POST__entry__32}{#email-POST__accept-RESTAPI}{#email-POST__content_type-RESTAPI}

| ヘッダー | 説明 |
|-|-|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json |
| Content-Type | 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json |
[表 : 10. 要求ヘッダー]

{#email-POST__entry__38}

| ヘッダー | 説明 |
|-|-|
| なし |   |
[表 : 11. 応答ヘッダー]

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#email-POST__entry__42}{#email-POST__entry-200-status-code}{#email-POST__entry-400-status-code}{#email-POST__entry-401-status-code}{#email-POST__entry-500-status-code}

| ステータスコード | 説明 |
|-|-|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 |
| 401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 |
| 403 | 要求元ユーザーにレコードへのアクセス権がありません。ユーザーに適切なロールとアクセス権限があることを確認します。 |
| 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 |
[表 : 12. ステータスコード]

### 応答本文のパラメーター (JSON または XML)

{#email-POST__entry__54}

| 要素 | 説明 |
|-|-|
| href | メール API GET 要求としてのメールレコードへのリンク。 データタイプ：文字列 |
| id | メールレコードの sys_id。 データタイプ：文字列 |
| links | メールレコードへのリンクのリスト。 データタイプ：アレイ |
| rel | href パラメーターにリストされているリンクのタイプ。 可能な値： * self：メールレコードのメール API GET 要求。 * status：メールレコードのメール API GET 要求であり、id、タイプ、ステータス、およびエラーフィールドのみを表示します。 {#email-POST__ul_gwp_rrt_cmb} データタイプ：文字列 |
[ ]

### サンプル cURL 要求

    curl "http://instance.servicenow.com/api/now/email" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --user 'username':'password'\
    --data "{
      \"to\": [
        \"User1 <user1@example.com>\",
        \"User2 <user2@example.com>\"
      ],
      \"cc\": [
        \"User3 <user3@example.com>\",
        \"User4 <user4@example.com>\"
      ],
      \"bcc\": [
        \"User5 <user5@example.com>\",
        \"User6 <user6@example.com>\"
      ],
      \"subject\": \"Hello There\",
      \"text\": \"Test Message\",
      \"html\": \"<b>Test Message</b>\",
      \"table_name\": \"incident\",
      \"table_record_id\": \"136b2140bd0312004d7d1371f1abbdb6\",
      \"headers\": {
        \"X-Custom\": \"header\"
      }
    }"

    {
     "result": {
       "id": "b963219a44b02200964f63773cd6adfc",
       "links": [
         {
           "rel": "self",
           "href": "/now/v1/email/b963219a44b02200964f63773cd6adfc"
         },
         {
           "rel": "status",
           "href": "/now/v1/email/b963219a44b02200964f63773cd6adfc?sysparm_fields=id,type,state,error"
         }
       ]
     }
    }