Set Flag
Table of ContentsUp
Note: This task is applicable to all Zoho services, except Zoho Creator.
Overview
The zoho.mail.setFlag task is used to flag an email in Zoho Mail.
Syntax
<response> = zoho.mail.setFlag(<message_id>, <flag_name>, <connection>);
where:
Params | Data type | Description |
<response> | KEY-VALUE | The response returned representing the status of the executed task. |
<message_id> | NUMBER | The ID of the email that will be flagged. Note: You can get the message_id from the Zoho Mail URL. The URL is in the following format: |
<flag_name> | TEXT | The name of the flag. Allowed values:
|
<connection> | TEXT | The link name of the Zoho Mail connection Note:
|
Example : Flag an email as important in Zoho Mail
The following script flags the specified email as important in Zoho Mail:
response = zoho.mail.setFlag(6729326000000548039, "important", "mail_oauth_connection");
where:
response
The KEY-VALUE response that represents the status of the executed task.
6729326000000548039
The NUMBER that represents the ID of the email that will be flagged.
"important"
The TEXT that represents the flag name.
"mail_oauth_connection"
The TEXT that represents the link name of Zoho Mail oauth connection.
Response Format
Success Response
The success response will be returned in the following format:
{
"message":"Action markFlag is successful",
"status":"success"
}