Querying the Recipient Status

This API is used to query the status of a recipient.

For details, see Calling APIs.

POST /v1/{project_id}/workspaces/{workspace_id}/sa/reports/emails/search

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
workspace_id	Yes	String	Workspace ID.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
email_address	Yes	String	Recipient email address. Separate multiple email addresses with semicolons (;).

Status code: 200

**Table 3** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID. Format: request_uuid-timestamp-hostname.

**Table 4** Response body parameters
Parameter	Type	Description
[items]	Array of EmailStatusInfo objects	EmailStatusInfo

**Table 5** EmailStatusInfo
Parameter	Type	Description
report_address	String	Email address.
email_status	Boolean	Email status. true: the email can be sent directly. false: an email confirmation is required.

Status code: 400

**Table 6** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID. Format: request_uuid-timestamp-hostname.

**Table 7** Response body parameters
Parameter	Type	Description
code	String	Definition Error code. Range N/A
message	String	Definition Error description. Range N/A

None

None

Status Code	Description
200	Request succeeded.
400	Request failed.

Parent topic: Security Reports

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.