メール API

Yokohama API リファレンス

Release

yokohama

ft:locale

ja-JP

ft:publication_title

Yokohama API リファレンス

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

メール API

リリースバージョン: Yokohama

更新日 2026年03月12日

所要時間：12分

メール API は、REST を使用したメールメッセージの送受信を可能にするエンドポイントを提供します。

ユーザーがメールを送信するには、email_api_send ロールが必要です。

注:

メール [sys_email] テーブルへの読み取り/書き込みアクセス権がない場合は、エラーが発生する可能性があります。

メール - GET /now/email/{id}

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

URL 形式

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

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

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

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

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

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

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

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

表 : 5. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

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

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


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

サンプル 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

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