ReadEmail

Frends task, that allows to read emails from IMAP server and

Task version: 2.2.0

Required Frends version: 5.5+

Required .NET version: 6.0

Compatible Agents: Crossplatform

Source code: https://github.com/FrendsPlatform/Frends.IMAP

Task Parameters

Settings

Name	Description
Host : String	Host address Default: imap.frends.com Example: imap.frends.com
Port : Int32	Host port Default: 993 Example: 993
UseSSL : Boolean	Use SSL or not Default: True Example: true
AcceptAllCerts : Boolean	Controls whether task will save attachments to designated directory or not Default: False Example: false
UserName : String	Account name to login with Default: accountName Example: user
🗝Password : String	Account password Default: - Example: ***

Options

Name	Description
MaxEmails : Int32	Maximum number of emails to retrieve Default: 10 Example: 10
GetOnlyUnreadEmails : Boolean	Should get only unread emails? Default: - Example: false
MarkEmailsAsRead : Boolean	If true, then marks queried emails as read Default: - Example: false
DeleteReadEmails : Boolean	If true, then received, read emails will be hard deleted. Note: If MarkEmailsAsRead is false, then this option will delete only those emails that were already read. Default: - Example: false
SaveAttachments : Boolean	Controls whether task will save attachments to designated directory or not Default: False Example: false
SavedAttachmentsDirectory : String	Directory to store all attachments Default: c:/SavedAttachments Example: c:/SavedAttachments
CreateDirectoryIfNotFound : Boolean	If true, then creates an attachment directory if not existing Default: False Example: false

Task Result

Name	Description
Emails : List<EmailMessage>	List of emails that were retrieved.

Task Changelog

Changelog for Task Frends.IMAP.ReadEmail.

[2.2.0] - 2026-05-21

Fixed

• Ensure to delete only emails flagged as Read

[2.1.0] - 2026-02-23

Fixed

• Ensure FrendsTaskMetadata.json is included in NuGet package

[2.0.0] - 2023-06-12

Fixed

• Fixed task not handling attachments at all (#3).
• Added better description of task.

Changed

• Breaking change! Result is change from just a list of messages to a wrapper that contains an Emails subproperty with the list of messages.

[1.0.0] - 2022-02-09

Added

• Initial implementation