Get Headers Step
  • 12 Dec 2023
  • 1 Minute to read
  • Dark
    Light

Get Headers Step

  • Dark
    Light

Article Summary

Step Details

Introduced in Version---
Modified in Version8.17.0, 8.6.0, 7.14.0
LocationCommunication > 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

PropertyDescriptionData Type
Use Recent FlagUsing 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

PropertyDescriptionData Type
CountSpecifies the number of email headers to returnInt32
OAuth TokenAllows 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
PasswordThe password of the user connecting to the email serverString
PortThe port number of the email serverInt32
Secure ConnectionUsed if the email server credentials require a secure connection (must be set to true when using OAuth for POP3 or IMAP)Boolean
ServerIMAP or POP email serverString
Sort DescendingWhen 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 OAuthSpecifies the use of OAuth authenticationBoolean
UsernameUsername to connect to the email serverString

Output

PropertyDescriptionData Type
HeadersList of the email header data foundEmailHeader list


Step Changes

DescriptionVersionDeveloper Task
Added two new properties: Use Recent Flag and Sort Descending for the Get Email Step and Get Headers Step.8.17DT-038377

Related Information

Forum Posts:
Using Email Steps with Gmail Issue


Was this article helpful?