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

SendMessage

As2 SendMessage task sends a message to an AS2 server using the provided parameters

Task version: 1.1.0

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Crossplatform

Task Parameters

Name
Description

SenderAs2Id : String

Id of the company that will send the message.

Default: - Example: MyCompany

ReceiverAs2Id : String

Id of the company that will receive the message.

Default: - Example: YourCompany

Subject : String

Subject of the AS2 message.

Default: - Example: Subject of the message

MessageFilePath : String

Path to the file that will be sent in the message.

Default: - Example: C:\Document\message.txt

AdditionalHeaders : Header[]

Optional additional HTTP headers to send with the AS2 message.

Default: - Example: [{ "Name": "X-ApiKey", "Value": "my-api-key" }]

Name
Description

As2EndpointUrl : String

Connection string to AS2 server

Default: - Example: https://as2.example.com/as2

SignMessage : Boolean

Defines whether to sign the message.

Default: False Example: true

EncryptMessage : Boolean

Defines whether to encrypt the message.

Default: False Example: true

🗝SenderCertificatePassword : String

Password for the sender certificate.

Default: - Example: mySecurePassword123

SenderCertificatePath : String

Path to the sender certificate file in .pfx format.

Default: - Example: C:\Document\sender_cert.pfx

ReceiverCertificatePath : String

Path to the receiver certificate file in .pfx format.

Default: - Example: C:\Document\receiver_cert.pfx

MdnReceiver : String

URL or email where to send the MDN (Message Disposition Notification).

Default: - Example: user@example.com

ContentTypeHeader : String

Specify content type header for the message if it's neither encrypted nor signed.

Default: text/plain Example: application/zip

Name
Description

MdnMode : MdnMode

Specifies whether to request synchronous or asynchronous MDN

Possible values:

  • Sync: Synchronous MDN mode. The sender waits for the MDN immediately after sending the message.

  • Async: Asynchronous MDN mode. The sender requests the recipient to post the MDN to a separate endpoint,

allowing the send operation to complete without waiting for the MDN.

Default: Sync Example: Sync

AsyncMdnUrl : String

URL where async MDN should be sent (required when MdnMode is Async)

Default: - Example: https://mycompany.com/api/as2/mdn-receiver

ThrowErrorOnFailure : Boolean

Whether to throw an error on failure.

Default: True Example: false

ErrorMessageOnFailure : String

Overrides the error message on failure.

Default: - Example: Custom error message

Task Result

Name
Description

Success : Boolean

Indicates if the task completed successfully. Example: true

PartnerResponse : String

The transport/MDN response from the AS2 partner: - Sync mode: full multipart/signed MDN content - Async mode: the immediate response from the POST (e.g., "200 OK") Example: 200 OK

MessageId : String

ID of a sent message. Example: 123

MdnStatus : String

Status of the MDN response. Example: ReceivedValid

MdnMessage : String

Human-readable message included in the MDN. Example: The message was successfully received and processed.

MdnIntegrityCheck : String

Message Integrity Check (MIC) value reported in the MDN. Example: "7v7F+fQbH4lD8bKGJTbXzWWcUlI=, sha1"

IsMdnPending : Boolean

Indicates whether the MDN delivery is pending (true for async MDN mode, false for sync MDN mode). When true, the MDN will be delivered separately to the AsyncMdnUrl endpoint. Example: false

Error : Error

Error that occurred during task execution. Example: object { string Message, object { Exception Exception } AdditionalInfo }

Error.Message : String

Summary of the error. Example: Unable to join strings.

Error.AdditionalInfo : Exception

Additional information about the error. Example: object { Exception Exception }

Task Changelog

Changelog for Task Frends.As2.SendMessage.

[1.1.0] - 2026-07-21

Changed

  • Added missing documentation examples to Header properties (Name and Value).

  • Updated copyright field in project file to match compliance requirements.

[1.0.0] - 2025-09-11

Changed

  • Initial implementation

Last updated

Was this helpful?