activities
latest
false
- Overview
- Excel
- Release Notes
- About the Excel activity package
- Project Compatibility
- Supported character encoding
- Project Settings
- Add or Update Excel Sensitivity Label
- Append Range
- Auto Fill
- Autofit Range
- Change Pivot Data Source
- Clear Sheet/Range/Table
- Copy/Paste Range
- Create Pivot Table
- Delete Column
- Delete Rows
- Delete Sheet
- Duplicate Sheet
- Export to CSV
- Fill Range
- Filter
- Filter Pivot Table
- Find First/Last Data Row
- Find/Replace Value
- For Each Excel Row
- For Each Excel Sheet
- Format As Table
- Format Cells
- Get Cell Color
- Get Excel Chart
- Get Excel Sensitivity Label
- Get Selected Range
- Insert Column
- Insert Chart
- Insert Rows
- Insert Sheet
- Invoke VBA
- Lookup
- Match Function
- Protect Sheet
- Read Cell Formula
- Read Cell Value
- Read Range
- Refresh Excel Data Connections
- Refresh Pivot Table
- Remove Duplicates
- Rename Sheet
- Run Spreadsheet Macro
- Save Excel File
- Save Excel File As
- Save Excel File As PDF
- Select Range
- Sort Range
- Text to Columns
- Unprotect Sheet
- Update Excel Chart
- Use Excel File
- VLookup
- Write Cell
- Write CSV
- Write DataTable to Excel
- Excel Application Scope
- Append To CSV
- Read CSV
- Write CSV
- Delete Column
- Filter Table
- Get Table Range
- Insert Column
- Sort Table
- Append Range
- Close Workbook
- Get Cell Color
- Read Cell
- Read Cell Formula
- Read Column
- Read Range
- Read Row
- Select Range
- Set Range Color
- Write Cell
- Write Range
- Save Workbook
- Create Table
- Get Workbook Sheet
- Get Workbook Sheets
- Refresh Pivot Table
- Create Pivot Table
- Get Selected Range
- Copy Sheet
- Delete Range
- Auto Fill Range
- Copy Paste Range
- Execute Macro
- Insert/Delete Columns
- Insert/Delete Rows
- Invoke VBA
- LookUp Range
- Remove Duplicates Range
- Excel Process Scope
- Manage CSV Files
- Filter CSV Files
- Verify CSV Files
- Table Functions
- Manage Multiple Excel Files
- Interpret Excel Results
- Manage Pivot Tables
- Manage Range Selection
- Read From Excel Files
- Manage Databases in Excel
- Compare CSV Files
- Compare Numeric Values
- Sort Data in Excel Files
- Filter and Delete Rows in Excel Files
- Manipulate Range Selections
- Verify Excel Workbook Data
- Read, Write, and Append Data in Excel
- Google Workspace
- Release notes
- About the Google Workspace activities package
- Project compatibility
- Wait for Calendar Event Created and Resume
- Wait for Calendar Event Received and Resume
- Wait for Calendar Event Replied and Resume
- Wait for Calendar Event Updated
- Wait for Email Received and Resume
- Wait for Email Sent and Resume
- Wait for File Created and Resume
- Wait for File Updated and Resume
- Wait for Folder Created and Resume
- Wait for Sheet Created and Resume
- Wait for Sheet Cell Updated and Resume
- Wait for Task Created and Resume
- Wait for Task Completed and Resume
- Add Attendee
- Create Event
- Delete Event
- Modify Event
- Search Events
- Use Google Drive
- Share File
- Delete File Permission
- Get File Permissions
- Update File Permission
- Copy File
- Create Folder
- Delete File
- Download File
- Find Files and Folders
- Get File Info
- Move File
- Upload File
- Create Document
- Create New Spreadsheet
- Get Mail Messages
- Send Mail Messages
- Change Labels
- Use Google Spreadsheet
- Add Delete Columns
- Add Delete Rows
- Auto Fill Range
- Add New Sheet
- Append Row
- Batch Spreadsheet Updates
- Copy Sheet
- Copy Paste Range
- Delete Range
- Delete Sheet
- Get Cell Color
- Get Sheets
- Read Cell
- Read Column
- Read Range
- Read Row
- Rename Sheet
- Write Cell
- Write Range
- Clear Range
- Download Spreadsheet
- Use Google Document
- Batch Document Updates
- Get Document
- Get Text Index
- Insert Text
- Replace Text
- Read All Text
- Create Script Project
- Get Project Content
- Upload Script File
- Create Deployment
- Run Script
- Mail
- Microsoft 365
- Release notes
- About the Microsoft 365 activity package
- Project compatibility
- Connections
- AddEmailCategories
- ArchiveEmail
- DeleteEmail
- DownloadEmail
- DownloadEmailAttachment
- DownloadEmailAttachments
- ForwardEmail
- GetEmail
- GetEmailAttachmentsInfo
- GetEmails
- GetMailFolders
- GetNewestEmail
- MarkEmailAsRead
- MarkEmailAsUnread
- MoveEmail
- RemoveEmailCategories
- ReplyToEmail
- SendEmail
- TurnOffAutomaticReplies
- TurnOnAutomaticReplies
- Merge multiple sheets into a new summary Excel sheet
- Automatically accept calendar invites from your manager
- Move files to dedicated folders by type
- Verify if new employment documents (I9 and ID) match
- Add new customers to a SharePoint List
- Delete SharePoint List items newer than yesterday
- Notify me on Slack when an important Outlook Email is received
- Include creation date in new OneDrive file names
- Notify me by email when a new file is created
- Microsoft 365 Scope
- Add Sheet
- Append Range
- Clear Range
- Copy Range
- Copy Sheet
- Create Workbook
- Delete Range
- Delete Sheet
- Get Cell Color
- Get Sheets
- Read Cell
- Read Column
- Read Range
- Read Row
- Rename Sheet
- Write Cell
- Write Range
- Set Range Color
- Create Table
- Get Table Range
- Insert Column
- Delete Column
- Insert Rows
- Delete Rows
- VLookup Range
- Use OneDrive & SharePoint
- Copy File/Folder
- Create Folder
- Delete File/Folder
- Download File
- Export File as PDF
- Find Files And Folders
- Get File/Folder
- Move File/Folder
- Upload File
- Share File/Folder
- For Each File/Folder
- Forward Mail
- Get Mail
- Move Mail
- Send Mail
- Reply to Mail
- Delete Mail
- Set Mail Categories
- Add Attachment
- Add Attendee
- Add Location
- Create Event
- Delete Event
- Find Meeting Times
- Get Calendars
- Modify Event
- RSVP
- Search Events
- Create Group
- Delete Group
- Get Group
- List Groups
- Create Bucket
- Delete Bucket
- List Buckets
- List Bucket Tasks
- Create Plan
- Get Plan
- List Plans
- Create Task
- Delete Task
- Get Task
- List Tasks
- Update Task
- For Each List
- Get List Info
- For Each List Item
- Delete List Item
- Add List Items
- Update List Item
- Get List Items
- Authentication troubleshooting
- AADSTS50011: Redirect URI mismatch
- AADSTS50076: Using multifactor authentication
- AADSTS50079: The user is required to use multifactor authentication
- AADSTS500113: No reply address registered for the application
- AADSTS65001: The user or administrator has not consented to use the application
- AADSTS7000218: The request body must contain the following parameter: client_assertion or client_secret
- AADSTS70002: InvalidClient - Error validating the credentials
- AADSTS50055: The password is expired
- AADSTS700082: The refresh token has expired due to inactivity
- AADSTS50194: Application is not configured as a multitenant application
- Mail troubleshooting
- Calendar troubleshooting
- Files troubleshooting
- Sheets troubleshooting
- Presentations
- Release Notes
- About the Presentations activity package
- Project Compatibility
- Add or Update Powerpoint Sensitivity Label
- Add Data Table to Slide
- Add File to Slide
- Add Image or Video to Slide
- Add New Slide
- Add Text to Slide
- Copy Paste Slide
- Delete Slide
- Format Slide Content
- Get Powerpoint Sensitivity Label
- Replace Text in Presentation
- Paste Item Into Slide
- Run Presentation Macro
- Save PowerPoint File As
- Save Presentation as PDF
- Use PowerPoint Presentation
- Word
- Release Notes
- About the Word Activities Package
- Project Compatibility
- Word Application Scope / Use Word File
- Add or Update Word Sensitivity Label
- Add Hyperlink to Document
- Add Picture
- Append Text
- Get Word Sensitivity Label
- Insert DataTable in Document
- Paste Chart/Picture Into Document
- Read Text
- Replace Picture
- Replace Text in Document
- Save Document As
- Save Document as PDF
- Set Bookmark Content
Productivity Activities
Last updated Nov 21, 2024
Get IMAP Email List
UiPath.Mail.IMAP.Activities.GetIMAPMailMessages
Retrieves an IMAP email message from a specified server.
Note: This activity is called Get IMAP Mail Messages in versions older than
1.24.
Common
- DisplayName - The display name of the activity.
- TimeoutMS - Specifies the amount of time (in milliseconds) to wait for the activity to run before an error is thrown. The default value is 30000 milliseconds (30 seconds).
Host
- MailFolder - The mail folder from which the messages are to be retrieved.
- Server - The email server host that is to be used.
- Port - The port used to get the email message.
Note: Using an IP address in the Server field instead of a DNS name only works when there are no SSL connections or if there is an SSL certificate issued for the IP address.
Logon
- Client Name - The Name property of the IMAP client implementation.
- Client Version - The Version property of the IMAP client implementation.
- Email - The email account used to get the message.
- Password - The password of the email account used to get the message. If UseOAuth is selected, the value of this parameter must be an OAuth2 access token.
- Secure Password - The password of the email account used, as a secure string. If UseOAuth is selected, the value of this parameter must be an OAuth2 access token.
- Use OAuth - Indicates whether to use an OAuth2 access token instead of a password. By default, this option is not selected.
Misc
- Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
Options
- DeleteMessages - Specifies if the read messages should be marked for delete.
- FilterExpression - Returns only those mail messages matching the filter expression.
-
FilterExpressionCharacterSet - The MIME name of the character set to be used for the filter expression.
Note: The list of valid MIME names that can be used is available at Character Sets. - Ignore CRL - Specifies whether to ignore the Certificate Revocation List validation when connecting. This field only accepts
Booleanvalues and variables. If left empty, the defaultFalsevalue is used. - MarkAsRead - Specifies whether to mark retrieved messages as read. By default, this check box is cleared.
- OnlyUnreadMessages - Specifies whether to retrieve only unread messages. By default, this check box is selected.
- OrderByDate - Order mail messages by date. Choose one of two options: Newest First, OldestFirst. The default value is Newest First.
- SecureConnection - Specifies the SSL and/or TLS encryption to be used for the connection.
- Top - The number of messages to be retrieved, starting from either the newest or the oldest, depending on the OrderByDate parameter.
Output
- Messages - The retrieved messages as a collection of MailMessage objects.
- Connection - The connection established in Integration Service for the Mail connector.
- Email folder - The mail folder from which the messages are to be retrieved.
- Additional filters - Returns only those mail messages matching the filter expression.
Common
- TimeoutMS - Specifies the amount of time (in milliseconds) to wait for the activity to run before an error is thrown. The default value is 30000 milliseconds (30 seconds).
Connection details
- Use Integration Service - Whether to use an Integration Service connection or not. Default value is True. When set to false, the server connection fields are displayed.
- Server - The email server host to be used. This field supports
Stringtype input. - Port - The port used to get the email message. This field supports
Int32type input. - Use OAuth - Indicates whether to use an OAuth2 access token instead of a password. By default, this option is not selected.
- Email - The email account used to get the message. This field
supports
Stringtype input. - Password - The password of the email account used to get the message.
If Use OAuth is enabled, the value of this parameter must be an OAuth2
access token. This field supports
Stringtype input. - Secure password - The password of the email account used, as a secure string. If Use OAuth is selected, the value of this parameter must be an OAuth2 access token.
- Ignore CRL - Indicates whether to ignore the Certificate Revocation List validation when connecting. Boolean value. Default is False.
- Secure connection - Specifies the SSL and/or TSL encryption to be used for the connection.
- Client name - Specifies a value for the Name property of the IMAP client implementation.
- Client version - Specifies a value for the Version property of the IMAP client implementation.
Options
- Limit emails to first - The number of messages to be retrieved,
starting from the top of the list. This field spports
Int32type input. - Unread only - Specifies whether to retrieve only unread messages. Default value: True.
- Mark as read - Specifies whether to mark retrieved messages as read.
- Delete messages - Specifies if the read messages should be marked for delete.
- Order by date - Order mail messages by date. Choose one of two options: Newest First, OldestFirst. The default value is Newest First.
-
FilterExpressionCharacterSet - The MIME name of the character set to be used for the filter expression. The list of valid MIME names that can be used is available at Character Sets.
Output
- Email list - The retrieved
messages as a collection of
UiPathMailMessageobjects.
The following table shows examples of filters that can be useful when you query IMAP mail messages:
|
Query |
Filter Expression |
|---|---|
|
All mail messages that contain "Welcome" in the subject |
"SUBJECT ""Welcome""" |
|
All mail messages that contain "Welcome" in the subject and are from "[email protected]" |
"SUBJECT ""Welcome"" FROM [email protected]" |
|
All mail messages that contain "Welcome" in the subject and are not from "[email protected]" |
"SUBJECT ""Welcome"" NOT FROM [email protected]" |
|
All mail messages that contain "Please review" in the body |
"BODY ""Please review""" |
|
All flagged mail messages (i.e. \)\)Flagged flag set) |
"FLAGGED" |
|
All mail messages since 02/23/2021 |
"SINCE 23-Feb-2021" |
|
All non-delivery report mail messages received on 02/23/2021 or 01/23/2021 |
"OR (ON 23-Feb-2021 FROM [email protected]) (ON 23-Jan-2021 FROM [email protected])" |
|
All mail messages unanswered today and from an email address that contains "examples.com" |
"UNANSWERED ON " + DateTime.Today.ToString("dd-MMM-yyyy") + " FROM examples.com" |
Note: Learn more about how to specify a filter expression here.
