For the complete documentation index, see llms.txt. This page is also available as Markdown.

SendEmail

Send a Microsoft Exchange email.

Task version: 1.1.0

Required Frends version: 5.5+

Required .NET version: 6.0

Compatible Agents: Crossplatform

Task Parameters

Name
Description

AuthenticationProvider : AuthenticationProviders

Specifies the authentication provider to use.

Possible values:

  • ClientCredentialsCertificate: Specifies the authentication provider to use.

  • ClientCredentialsSecret: Specifies the authentication provider to use.

  • UsernamePassword: Specifies the authentication provider to use.

Default: 2 Example: -

X509CertificateFilePath : String

The path to a file that contains both the client certificate and private key.

Default: - Example: c:\temp\mycert.pfx

ClientSecret : String

The secret key of the client application.

Default: - Example: Y2lzY29zeXN0ZW1zOmMxc2Nv

Username : String

The username of the user.

Default: - Example: username@example.com

🗝Password : String

The password of the user.

Default: - Example: password123

ClientId : String

The app ID for fetching an access token.

This is the unique identifier for your application.

Default: - Example: 4a1aa1d9-c16a-40a2-bd7d-2bd40babe4ff

TenantId : String

The tenant ID for fetching an access token.

This is the unique identifier of your Azure AD tenant.

Default: - Example: 9188040d-6c67-4c5b-b112-36a304b66dad

Name
Description

From : String

Sender email address.

This is the email address that will appear in the "From" field of the email.

Default: - Example: sender@example.com

To : String

Recipient addresses separated by ',' or ';'.

These are the main recipients of the email.

Default: - Example: recipient1@example.com, recipient2@example.com

Cc : String

Cc recipient addresses separated by ',' or ';'.

These recipients will receive a copy of the email.

Default: - Example: cc1@example.com, cc2@example.com

Bcc : String

Bcc recipient addresses separated by ',' or ';'.

These recipients will receive a copy of the email, but other recipients will not see their email addresses.

Default: - Example: bcc1@example.com, bcc2@example.com

Subject : String

Email message's subject.

This is the main topic or title of the email.

Default: - Example: Meeting Reminder

Message : String

Body of the message.

This is the main content of the email.

Default: - Example: Don't forget about our meeting tomorrow at 10am.

IsMessageHtml : Boolean

Set this true if the message is HTML.

This allows you to send emails with HTML formatting.

Default: False Example: false

Importance : ImportanceLevels

Importance level.

This sets the importance level of the email (e.g., Low, Normal, High).

Possible values:

  • Low: Importance level.

This sets the importance level of the email (e.g., Low, Normal, High).

  • Normal: Importance level.

This sets the importance level of the email (e.g., Low, Normal, High).

  • High: Importance level.

This sets the importance level of the email (e.g., Low, Normal, High).

Default: 1 Example: ImportanceLevels.Normal

SaveToSentItems : Boolean

Indicates whether to save the message in Sent Items.

Default: True Example: true

Attachments : Attachments[]

Email attachments.

Default: - Example: { AttachmentTypes.FileAttachment, C:\temp\temp.txt, . }, { AttachmentTypes.AttachmentFromString, temp.txt, "This is temp file." }

Name
Description

ThrowExceptionOnFailure : Boolean

Gets or sets a value indicating whether an error should stop the task and throw an exception.

Default: True Example: true

ThrowExceptionIfAttachmentNotFound : Boolean

Gets or sets a value indicating whether an exception should be thrown if no files match the given path.

Default: - Example: true

Task Result

Name
Description

Success : Boolean

Gets a value indicating whether the task was executed successfully. Example: true

Data : String

Gets the result of the task. Contains exception message if exception was thrown and Options.ThrowExceptionOnFailure = false. Example: Email sent successfully.

Task Changelog

Changelog for Task Frends.Exchange.SendEmail.

[1.1.0] - 2024-08-22

Changed

  • Updated the MimeKit and Azure.Identity libraries to their latest versions.

[1.0.0] - 2023-11-29

Added

  • Initial implementation

Last updated

Was this helpful?