Get Gmail Email By ID
You can select this activity to retrieve a specific Gmail email by using the unique message ID.
This table lists the properties of the activity:
| Property Type | Property Name | Data Type | Description |
|---|---|---|---|
| Input | Mail ID | InArgument<String> | The unique ID of the email to retrieve. This field is mandatory. |
| Options | Include Attachments | Boolean | Indicates whether to include email attachments in the retrieved email. The default value is set to True. |
| Common | Continue on error | Boolean | Set the value to True for continuing the workflow even if the activity fails. The default value is set to True. |
| Output | OutArgument<Mail> | The retrieved email as a Mail object. This field is required. | |
| Output | Response code | OutArgument<Int32> | Response code for the activity. |
Activity behavior
Review this behavior of the activity when retrieving email messages:
- The activity retrieves the email message by using the Gmail API messages.get endpoint.
- If the Mail ID value does not match an existing message, the Email output is null and the Response Code is 400.
- If the operation is completed successfully, the Email output is populated with a GmailMail object and the Response Code is 200.
- If an unexpected error occurs, the Response Code is 500.