# Read Required Frends version: 5.5+ Required .NET version: 6.0 Compatible Agents: Crossplatform Source code: {% tabs %} {% tab title="Parameter: Connection" %} | Name | Description | | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ReadMessageCount : `Int32` |

Maximum number of messages to read.


Default: 1
Example: 1

| | AckType : `AckType` |

Set the acknowledgement type.

Possible values:

Set the acknowledgement type.

Set the acknowledgement type.

Set the acknowledgement type.

Set the acknowledgement type.

Set the acknowledgement type.

Set the acknowledgement type.


Default: 1
Example: AutoAck

| | AuthenticationMethod : `AuthenticationMethod` |

Authentication method: URI, hostname with username/password, or certificate.

Possible values:

Authentication method: URI, hostname with username/password, or certificate.

Authentication method: URI, hostname with username/password, or certificate.

Authentication method: URI, hostname with username/password, or certificate.

Authentication method: URI, hostname with username/password, or certificate.


Default: -
Example: URI

| | đź—ťHost : `String` |

URI or hostname to connect to, depending on authentication method.


Default: -
Example: RabbitHost, amqp\://foo:bar\@localhost:1234

| | Username : `String` |

Username to use when authenticating to the server.


Default: -
Example: foo

| | đź—ťPassword : `String` |

Password to use when authenticating to the server.


Default: -
Example: bar

| | Port : `Int32` |

The port to connect on. Value 0 indicates that the default port for the protocol should be used.


Default: -
Example: 0

| | SslProtocol : `SslProtocol` |

Specifies the SSL protocol used for the RabbitMQ connection. Use SslProtocol.None to allow the operating system to negotiate the most secure protocol available.

Possible values:

Specifies the SSL protocol used for the RabbitMQ connection. Use SslProtocol.None to allow the operating system to negotiate the most secure protocol available.

Specifies the SSL protocol used for the RabbitMQ connection. Use SslProtocol.None to allow the operating system to negotiate the most secure protocol available.

Specifies the SSL protocol used for the RabbitMQ connection. Use SslProtocol.None to allow the operating system to negotiate the most secure protocol available.


Default: -
Example: SslProtocol.None

| | CertificateSource : `CertificateSource` |

Specifies the source from which the client certificate should be loaded.

Possible values:

Specifies the source from which the client certificate should be loaded.

Specifies the source from which the client certificate should be loaded.

Specifies the source from which the client certificate should be loaded.

Specifies the source from which the client certificate should be loaded.


Default: -
Example: CertificateSource.File

| | ClientCertificatePath : `String` |

Full file system path to a client certificate file (.pfx or .p12) used for TLS client‑certificate authentication.


Default: -
Example: C:\certs\client-auth.pfx

| | đź—ťClientCertificatePassword : `String` |

Password required to decrypt the certificate file. Needed for password‑protected .pfx/.p12 certificates.


Default: -
Example: MyStrongPassword123!

| | đź—ťCertificateBase64 : `String` |

Base64‑encoded representation of a client certificate (.pfx or .p12).


Default: -
Example: MIIF2wIBAzCCB...

| | đź—ťCertificateBytes : `Byte[]` |

Raw byte array containing a client certificate (.pfx or .p12).


Default: -
Example: byte\[] { 1, 2, 3, 4, 5 }

| | StoreThumbprint : `String` |

Thumbprint of a certificate stored in the Windows certificate store.


Default: -
Example: ab12cd34ef56ab78cd90ef12ab34cd56ef7890ab

| | CertificateStoreLocation : `CertificateStoreLocation` |

Windows certificate store location to search when loading a certificate by thumbprint.

Possible values:

Windows certificate store location to search when loading a certificate by thumbprint.

Windows certificate store location to search when loading a certificate by thumbprint.


Default: -
Example: CertificateStoreLocation.CurrentUser

| | QueueName : `String` |

The name of the queue. Leave empty to make the server generate a name.


Default: -
Example: SampleQueue

| | ExchangeName : `String` |

Exchange's name.


Default: -
Example: SampleExchange

| | RoutingKey : `String` |

Routing key's name.


Default: -
Example: route

| | VirtualHost : `String` |

RabbitMQ virtual host to connect to.


Default: /
Example: /

| | Timeout : `Int32` |

Timeout setting for connection attempts. Value 0 indicates that the default value for the attempts should be used. Set value in seconds.


Default: -
Example: 60

| | {% endtab %} | | {% tab title="Result: Result" %} | Name | Description | | -------------------------------- | -------------------------------------------------------------------------------------------------------- | | Success : `Boolean` | Read status. There was no messages to read if MessageUTF8 and MessagesBase64 are empty but Success=true. | | MessagesBase64 : `List` |

Message in Base64 format.
Example: VGVzdCBtZXNzYWdl, {foo, bar}, 1, 1

| | MessageUTF8 : `List` |

Message in UTF8 format.
Example: Test message, {foo, bar}, 1, 1

| | {% endtab %} | | {% tab title="Changelog" %} ## Changelog ### \[2.1.0] - 2026-03-17 #### Added * Added CertificateWithCredentials authentication method that requires both a valid client certificate and username/password credentials to connect. * Added Certificate authentication method for TLS client-certificate authentication with new enums (`CertificateSource`, `SslProtocol`, `CertificateStoreLocation`) and connection properties (`ClientCertificatePath`, `ClientCertificatePassword`, `CertificateBase64`, `CertificateBytes`, `StoreThumbprint`, `CertificateStoreLocation`, `SslProtocol`, `CertificateSource`). * Added VirtualHost field to Connection parameters to allow specifying a RabbitMQ virtual host. Defaults to "/". ### \[2.0.0] - 2026-02-23 #### Changed * Acknowledgement of messages logic was simplified. * Types of acknowledge actions were clarified. * **\[Breaking Change]** Rename ManualAck to NoAck as it's more descriptive (ack is not set with this option and can't be sent manually within this task) * **\[Breaking Change]** Rename `Connection.AutoAck` property to `Connection.AckType` ### \[1.1.0] - 2025-02-14 #### Fixed * Update RabbitMQ.Client from 6.4.0 to 7.1.2 ### \[1.0.2] - 2023-03-14 #### Fixed * Fixed issue with connections and channels were left open by implementing IDisposable class in ConnectionHelper class. #### Added * Added support for reading messages from quorum queues. ### \[1.0.1] - 2022-10-12 #### Added * New property: Result.Success to indicate that the Read task was successfully completed. ### \[1.0.0] - 2022-08-22 #### Added * Initial implementation {% endtab %} {% endtabs %}