Get Headers Step
- 12 Dec 2023
- 1 Minute to read
- Print
- DarkLight
Get Headers Step
- Updated on 12 Dec 2023
- 1 Minute to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Step Details | |
| Introduced in Version | --- |
| Modified in Version | 8.17.0, 8.6.0, 7.14.0 |
| Location | Communication > Email > IMAP/POP |
The Get Headers step for IMAP and POP email servers returns the header data of a specified number of emails from the user's configured email server.
Properties
Gmail
| Property | Description | Data Type |
|---|---|---|
| Use Recent Flag | Using pop with Gmail will not retrieve all messages. Using the recent flag will get Gmail to return messages from the last 30 days. Note: The "Use Recent Flag" setting must be used on BOTH the "Get Header" step and the "Get Email" step to return the most recent emails; if Use Recent Flag is enabled on the "Get Header" step but not enabled on the "Get Email" step, then it will return no emails found. | Boolean |
Input
| Property | Description | Data Type |
|---|---|---|
| Count | Specifies the number of email headers to return | Int32 |
| OAuth Token | Allows a user to specify the IMAP or POP3 email server token. (Requires: email account configured for OAuth and POP3 or IMAP; OAuth Provider and Token for POP3 or IMAP) | String |
| Password | The password of the user connecting to the email server | String |
| Port | The port number of the email server | Int32 |
| Secure Connection | Used if the email server credentials require a secure connection (must be set to true when using OAuth for POP3 or IMAP) | Boolean |
| Server | IMAP or POP email server | String |
| Sort Descending | When enabled, this will reverse the order of the messages before retrieving headers so that the newest messages will be returned by the step. | Boolean |
| Use OAuth | Specifies the use of OAuth authentication | Boolean |
| Username | Username to connect to the email server | String |
Output
| Property | Description | Data Type |
|---|---|---|
| Headers | List of the email header data found | EmailHeader list |
Step Changes
| Description | Version | Developer Task |
|---|---|---|
| Added two new properties: Use Recent Flag and Sort Descending for the Get Email Step and Get Headers Step. | 8.17 | DT-038377 |
Related Information
Forum Posts:
Using Email Steps with Gmail Issue
Was this article helpful?
