Extract Basic Information from Email File‎

POST /Command/ExtractBasicInfoFromEmailFile

Extracts basic information such as Sender and Recipient from an email file specified by File ID

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.
File ID	`integer`	Required	The File ID in Playbook

Body Sample Data

application/json

CODE

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "File ID": 23
  }
}

Response

200 OK

application/json

Response Fields

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

Sample Data

CODE

{
    "error": "",
    "returnData": "Succeed",
    "contextData": {
        "Size": 74x,
        "Sender": "\"Zhan\" <jzhan@d3security.com>",
        "Recipient": "\"Zhan\" <jzhan@d3security.com>",
        "CCRecipient": "",
        "BCCRecipient": "",
        "ReplyTo": "",
        "Subject": "Welcome to use SOAR30",
        "ReceivedTime": "12/30/1899 12:00:00 AM",
        "SentTime": "2020-05-27T21:45:53",
        "BodyPartCharset": "",
        "BodyPartContentTransferEncoding": "7bit",
        "HTMLBodyPartCharset": "UTF-8",
        "TextBody": "Hi All,\r\n\r\nWelcome to use D3 SOAR30.\r\n\r\nThank you.\r\n\r\nD3 Security\r\n",
        "HTMLBody": "<div dir=\"ltr\">Hi All,<div><br></div><div>Welcome to use D3 SOAR30.</div><div><br></div><div>Thank you.</div><div><br></div><div>D3 Security</div></div>\r\n",
        "AttachmentsCount": "0",
        "AttachmentsNames": "Welcome to use SOAR30.eml",
        "EmailClientIp": []
    }
}

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."}