Parse Email Header‎

POST /Command/ParseEmailHeader

Parses email headers from raw email data

Request

Authentication: API keys or JSON web tokens (JWT)

Body Parameters

Parameter Name	Type	Required/Optional	Description
Username	`string`	Required	The username of your D3 SOAR account.
Site	`string`	Required	The D3 SOAR site to run the remote command.
Raw Email Data	`string`	Required	Raw data of an email

Body Sample Data

application/json

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Raw Email Data": "from: \r\nto: \r\nsubject: \r\nX-FLAG=CONFIRM_DELIVERY:\r\nX-FLAG=ATTACH:  -X"
  }
}

Response

200 OK

application/json

Response Fields

Field Name	Type	Description
result	`string`	The result data from the API request.
error	`string`	The error message if the command execution failed.
returnData	`string`	The return data from the API request.
contextData	`JSON Object`	The context data from the API request.

Sample Data

JSON

{
    "result": "<table cellspacing=\\\"2\\\" cellpadding=\\\"5\\\" border=\\\"1\\\" border=\\\"0\\\" style=\\\"border:solid 1 #fff;background-color:#333;\\\"><tr valign=\\\"middle\\\"><td class=\\\"\\\">from</td><td class=\\\"\\\"></td></tr><tr valign=\\\"middle\\\"><td class=\\\"\\\">to</td><td class=\\\"\\\"></td></tr><tr valign=\\\"middle\\\"><td class=\\\"\\\">subject</td><td class=\\\"\\\"></td></tr><tr valign=\\\"middle\\\"><td class=\\\"\\\">X-FLAG=CONFIRM_DELIVERY</td><td class=\\\"\\\"></td></tr><tr valign=\\\"middle\\\"><td class=\\\"\\\">X-FLAG=ATTACH</td><td class=\\\"\\\">-X</td></tr></table>",
    "error": "",
    "returnData": "Succeed",
    "contextData": {
        "from": "",
        "to": "",
        "subject": "",
        "X-FLAG=CONFIRM_DELIVERY": "",
        "X-FLAG=ATTACH": "-X"
    }
}

400 BadRequest

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The body of the request must be a valid JSON object"}

401 Unauthorized

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "Invalid authentication key."}

429 TooManyRequests

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The request exceeds rate limits or is otherwise blocked by rate limiting policies."}

500 InternalServerError

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "Unexpected Error."}