You can install the task via FRENDS UI Task View or you can find the nuget package from the following nuget feed 'Nuget feed coming at later date'
Settings for message properties
| Property | Type | Description | Example |
|---|---|---|---|
| To | string | Recipient addresses separated by , or ; | jane.doe@somedomain.com |
| Cc | string | Cc recipient addresses separated by , or ; | jane.doe@somedomain.com |
| Bcc | string | Bcc recipient addresses separated by , or ; | jane.doe@somedomain.com |
| From | string | The email address the message is sent from | john.doe@somedomain.com |
| Sender Name | string | Name of the sender | Frends errors |
| Subject | string | Subject of the message | Hello Jane |
| Message | string | Body of the message | You've got mail! |
| Is message html | bool | Indicates whether the mail message body is in Html | false |
| Message encoding | string | Encoding of message body and subject. Use following table's name column for other options. https://msdn.microsoft.com/en-us/library/system.text.encoding(v=vs.110).aspx#Anchor_5 | utf-8 |
Settings for included attachments
| Property | Type | Description | Example |
|---|---|---|---|
| Attachment type | enum { FileAttachment, AttachmentFromString } | Chooses if the attachment file is created from a string or copied from disk | FileAttachment |
| File content | string | Usable with Attachment type AttachmentFromString. Sets the content of the attachment file | Lorem ipsum... |
| File name | string | Usable with Attachment type AttachmentFromString. Sets the name of the attachment file | error.txt |
| File path | string | Usable with Attachment type FileAttachment. Attachment file's path. Uses Directory.GetFiles(string, string) as a pattern matching technique. See https://msdn.microsoft.com/en-us/library/wz42302f(v=vs.110).aspx. Exception: If the path ends in a directory, all files in that folder are added as attachments. | C:\temp\*.csv |
| Throw exception if attachment not found | bool | Usable with Attachment type FileAttachment. If set true and no files match the given path, an exception is thrown | true |
| Send if no attachments found | bool | Usable with Attachment type FileAttachment. If set true and no files match the given path, email will be sent nevertheless | false |
Settings for connecting to SMTP server
| Property | Type | Description | Example |
|---|---|---|---|
| Smtp server | string | SMTP server address | smtp.somedomain.com |
| Port | int | SMTP server port | 25 |
| Use ssl | bool | Set this true if SMTP expects to be connected using SSL | false |
| Use windows authentication | bool | Set this true if you want to use windows authentication to authenticate to SMTP server | false |
| User name | string | Usable when windows authentication is set false. Use this username to log in to the SMTP server | user |
| Password | string | Usable when windows authentication is set false. Use this password to log in to the SMTP server | password |
| Property | Type | Description | Example |
|---|---|---|---|
| EmailSent | bool | Returns true if email message has been sent | true |
| StatusString | string | Contains information about the task's result. | No attachments found matching path "C:\temp\*.csv". No email sent. |
Read emails using IMAP server.
| Property | Type | Description | Example |
|---|---|---|---|
| Host | string | Host address | imap.frends.com |
| Port | int | Host port | 993 |
| UseSSL | bool | Use SSL when connecting host | true |
| AcceptAllCerts | bool | Accept all certificates when connecting the host, if true, will accept event invalid certificates. If false, will accept self-signed certificates if the root is untrusted | false |
| UserName | string | Account name to login with | emailUser |
| Password | string | Account password | *** |
| Property | Type | Description | Example |
|---|---|---|---|
| MaxEmails | int | Maximum number of emails to retrieve | 10 |
| GetOnlyUnreadEmails | bool | If true, will retrieve only unread emails | false |
| MarkEmailsAsRead | bool | If true, will mark retrieved emails as read | false |
| DeleteReadEmails | bool | If true, will delete retrieved emails from server | false |
ReadEmail task returns a list of EmailMessageResult objects. Each object contains following properties:
| Property | Type | Description | Example |
|---|---|---|---|
| Id | string | Email message id | ... |
| To | string | To field from email | agent@frends.com |
| Cc | string | Cc field from email | doubleagent@frends.com |
| From | string | From field from email | sender@frends.com |
| Date | DateTime | Received date | ... |
| Subject | string | Email subject | Important email! |
| BodyText | string | Plain text email body | ... |
| BodyHtml | string | Html email body | ... |
You can loop email message by giving task result as input to foreach-shape:
#result[ReadEmail]You can reference email properties like so:
#result[ReadEmail][0].BodyTextRead emails from exchange server with or without attachements.
This task can be only used on legacy (Windows) agent, because Microsoft.Exchange.WebServices.NETStandard does not implement all needed APIs on .Net standard.
| Property | Type | Description | Example |
|---|---|---|---|
| ExchangeServerVersion | enum | Exchange server version | Exchange2013_SP1 |
| UseAutoDiscover | bool | If true, task will try to autodiscover exchange server address from given email address | true |
| ServerAddress | string | Exchange server address | exchange.frends.com |
| UseAgentAccount | bool | If true, will try to authenticate against server with the running frends agent account | false |
| Username | string | Account username | agent@frends.com |
| Password | string | Account password | *** |
| Mailbox | string | Mail box to read emails from. Leave empty to read from default inbox | agentinbox@frends.com |
| Property | Type | Description | Example |
|---|---|---|---|
| MaxEmails | int | Maximum number of emails to retrieve | 10 |
| GetOnlyUnreadEmails | bool | If true, only attachments of unread emails will be fetched | false |
| MarkEmailsAsRead | bool | If true, will mark processed emails as read (unless execution is cancelled during processing) | false |
| DeleteReadEmails | bool | If true, will delete processed emails from server (unless execution is cancelled during processing) | false |
| EmailSenderFilter | string | Optional. If a sender is given, it will be used to filter emails. | sender@frends.com |
| EmailSubjectFilter | string | Optional. If a subject is given, it will be used to filter emails (match as substring). | Payments |
| ThrowErrorIfNoMessagesFound | bool | If true, error will be thrown if no attachments are found | false |
| IgnoreAttachments | bool | If true, attachement handling will be skipped | |
| GetOnlyEmailsWithAttachments | bool | If true, gets only emails with attachements | |
| AttachmentSaveDirectory | string | Directory where attachments will be saved to. | C:\WorkDir| |
| OverwriteAttachment | bool | If true, files in the save directory with the sama name as the attachment will be overwritten | false |
ReadEmailFromExchangeServer task returns a list of EmailMessageResult objects. Each object contains following properties:
| Property | Type | Description | Example |
|---|---|---|---|
| Id | string | Email message id | ... |
| To | string | To field from email | agent@frends.com |
| Cc | string | Cc field from email | doubleagent@frends.com |
| From | string | From field from email | sender@frends.com |
| Date | DateTime | Received date | ... |
| Subject | string | Email subject | Important email! |
| BodyHtml | string | Plain text email body | ... |
| AttachmentSaveDirs | List of strings | Full paths to saved attachments | {"C:\WorkDir\attchmnt1.txt","C:\WorkDir\attchmnt2.txt"} |
You can loop resulting objects by giving task result as input to foreach-shape:
#result[ReadEmailFromExchangeServer]You can reference result properties like so:
#result[ReadEmailFromExchangeServer][0].BodyHtmlThis project is licensed under the MIT License - see the LICENSE file for details
Clone a copy of the repo
git clone https://github.com/CommunityHiQ/Frends.Community.Email.git
Rebuild the project
dotnet build
Run Tests
dotnet test
Create a NuGet package
dotnet pack --configuration Release
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull request so that we can review your changes
NOTE: Be sure to merge the latest from "upstream" before making a pull request!
| Version | Changes |
|---|---|
| 1.0.0 | Initial version of SendEmail |
| 1.1.23 | Added FetchExchangeAttachment |
| 1.2.0 | Tasks no longer use Frends.Task.Attributes |
| 1.3.0 | Fixed nuspec and references for build server |
| 1.4.0 | ReadEmail can now read attachments. Removed FetchExchangeAttachment |
| 2.0.0 | Split ReadEmail to ReadEmailWithIMAP and ReadEmailFromExchangeServer. Added IgnoreAttachments and Office356 option |
| 2.1.0 | Add support for Cc and Bcc recipients to SendEmail task |
| 2.2.0 | Ported version for linux agent |
| 2.3.0 | Tighter MAilKit dependency rules |