# mulesoft Microsoft MSMQ Connector - Full Documentation

<!-- document id=e1e341f5ba60137ef76009cba1e6a6335259c50b43c989d817b695caf1251c15 url=/mulesoft/current/en-us/msmq-connector/latest/index.md -->

---
product: Microsoft MSMQ Connector
version: 2.1
is-latest-version: true
---

# Microsoft MSMQ Connector Overview

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for Microsoft Message Queuing (MSMQ) (MSMQ Connector) uses a typical
client-server architecture with two tiers, the connector or client running in the Mule Runtime, and
the Windows Gateway running on the server side. The latter exposes an HTTP Web API for sending or
receiving messages from MSMQ.

## Before You Begin

To use this connector, you must be familiar with:

- Microsoft MSMQ

- Mule runtime engine (Mule), Mule concepts, elements in a Mule flow, and Global Elements

- Anypoint Connectors

- Anypoint Studio

Before creating an app, you must have:

- Microsoft login credentials to test your connection to your target resource

- Anypoint Windows Gateway Service installed

For software requirements and compatibility information, see the Connector Release Notes.

## Architecture

The following is a high-level diagram of the solution architecture:

![Windows Gateway Service architecture](/mulesoft/current/en-us/msmq-connector/latest/_images/msmq-windows-gateway.png)

## POM File Information

```xml
<dependency>
  <groupId>com.mulesoft.connectors</groupId>
  <artifactId>mule-microsoft-mq-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

Replace `x.x.x` with the version that corresponds to the connector you are using.

To obtain the most up-to-date `pom.xml` file information, access the connector in
[Anypoint Exchange](https://www.mulesoft.com/exchange/) and click **Dependency Snippets**.

## About Use Cases

The MSMQ connector supports two primary use cases:

- Sends (HTTP POST) a single message to MSMQ

- Receives (HTTP GET) one or more messages from MSMQ

## Use Case: HTTP POST

In the POST scenario, Mule Runtime uses the connector to send a raw representation of the Mule
Message in the current flow to MSMQ using HTTP to the Windows Gateway. The message is sent as an
HTTP POST. The payload of the HTTP request is the serialized payload of the Mule message (binary or
text). The Web API runs on the Windows Gateway and forwards the message to a queue using MSMQ.

The following messages show the structure of the HTTP POST request.

### POST Request Message

```text
POST: https://localhost:9333/msmq
Authorization: mule test-token
Mule-Msmq-Queue-Name: .\private$\qout
Mule-Api-Version: 1
Body: THIS IS A SAMPLE MESSAGE
```

POST Response Message

Http /1.1 201 Created

## Use Case: HTTP GET

In the GET scenario, Mule Runtime uses the connector to receive one or more messages from MSMQ. This
is done as an HTTP GET to the Windows Gateway. The Web API runs in the gateway and returns the
available messages in a MSMQ queue. The messages are returned in a single HTTP response using a MIME
`multipart/mixed` content type.

The following messages illustrate the structure of the HTTP GET request.

### GET Request Message

```text
GET: https://localhost:9333/msmq?count=50
Authorization: mule test-token
Mule-Msmq-Queue-Name: .\private$\out
Mule-Api-Version: 1
```

### GET Response Message

```text
Transfer-Encoding: chunked
Content-Type: multipart/mixed; boundary="42c5468b-f831-900d-d099-a123ef456dcc7"

28
--42c5468b-f831-900d-d099-a123ef456dcc7

218
Content-Type: application/octet-stream
mule-msmq-acknowledgment-type: None
mule-msmq-acknowledgment: None
mule-msmq-attach-sender-id: True
mule-msmq-body-type: 0
mule-msmq-connector-type: 0
mule-msmq-correlation-id: 00000000-0000-0000-0000-000000000000\0
mule-msmq-id: 12ab345c-6d7e-900d-d099-89f012a345bc\6789
mule-msmq-label:
mule-msmq-lookup-id: 288230376151717889
mule-msmq-message-type: Normal
mule-msmq-priority: Normal
mule-msmq-source-machine: win-dt3v2pm5d7l
mule-msmq-extension:
mule-msmq-app-specific: 0

11
THIS IS A MESSAGE
2C

--42c5468b-f831-900d-d099-a123ef456dcc7--

0
```

The HTTP headers used for sending and receiving messages to and from the Gateway service are
discussed more in detail later in this document.

## About Message Delivery

The MSMQ connector can use a two-phase protocol to ensure zero-message-loss communication with the
gateway, or it can be set to use a no-acknowledgment protocol when you want to achieve high
throughput and do not need to ensure receiving each message at least once.

Message delivery can be chosen from two different options. The Message delivery configuration
setting establishes the message delivering working mode. Details on each available option are
described below.

### About No Acknowledgment

In a traditional scenario, after a message is read in the gateway, it is deleted from the queue. If
there is a connection failure or another issue in the ESB that prevents the message from being read,
that message is lost (this message delivery mode can be set by choosing the NoAcknowledgment value
at the corresponding configuration setting). Nevertheless, this delivery mode is the fastest one and
you should select it if you don’t need each message to be delivered at least once.

### About At Least Once (Default)

In a scenario with a two-phase commit protocol, the messages read from the main queue are kept in a
subordinate queue as backup. After the connector receives a copy of the message, it sends an
additional request to the gateway to remove the message from the sub-queue. When this commit action
is not completed, the message remains in the sub-queue. After a period of time, messages in the
subordinate queue, considered as orphans, are moved back to their parent queue where they are
retried. To be clear, this mechanism should not be affected by external exceptions happening in the
flow unless the flow is interrupted before the commit phase is completed (this message delivery mode
can be set by choosing the AtLeastOnce value at the corresponding configuration setting).

As said, message delivery mode depends on the Message delivery configuration setting, which should
be set to `AtLeastOnce` (default) if you want to ensure two phase commit protocol to be used. If you
set this parameter to `NoAcknowledgment` then each message is delivered to mule with no
acknowledgment of reception from it.

## Add the Connector to a Studio Project

Anypoint Studio provides two ways to add the connector to your Studio project: from the Exchange
button in the Studio taskbar or from the Mule Palette view.

### Add the Connector Using Exchange

1.  In Studio, create a Mule project.

2.  Click the Exchange icon **(X)** in the upper-left of the Studio task bar.

3.  In Exchange, click **Login** and supply your Anypoint Platform username and password.

4.  In Exchange, search for "msmq".

5.  Select the connector and click **Add to project**.

6.  Follow the prompts to install the connector.

### Add the Connector in Studio

1.  In Studio, create a Mule project.

2.  In the Mule Palette view, click **(X) Search in Exchange**.

3.  In **Add Modules to Project**, type "msmq" in the search field.

4.  Click this connector’s name in **Available modules**.

5.  Click **Add**.

6.  Click **Finish**.

### To Configure in Studio

1.  Drag the HTTP Listener to the Studio Canvas.

    ![MSMQ flow with Listener dragged to canvas in Studio](/mulesoft/current/en-us/msmq-connector/latest/_images/msmq-any-listener.png)

2.  Set the Path.

3.  Click the green plus sign to configure the listener.

4.  Drag an MSMQ connector operation to the Studio Canvas.

5.  Click the green plus sign to add a configuration for the connector.

6.  Complete these fields:

    ![Global Element Properties window for Sender config](/mulesoft/current/en-us/msmq-connector/latest/_images/msmq-any-config.png)

    - Gateway Service Address: The URL to the Windows Gateway.

    - Gateway Access Token: The access token for the Windows Gateway.

    - Queue Name: The queue you are intending to send the message to.

    - Message Formatter: The required message format.

7.  Click OK

8.  Configure these fields:

    ![MSMQ properties screen](/mulesoft/current/en-us/msmq-connector/latest/_images/msmq-any-send.png)

    - Message Formatter (if not set): the required message format

    - Payload: the content of the message

    - Time To Reach Queue: The maximum number of seconds a message can take to reach the MSMQ server
      after it’s received in the gateway. The default is to not time out (InfiniteTimeout).

    - Time To Be Received: The number of seconds a message can stay in the queue before it dequeues
      for a third party application. The default is to not time out (InfiniteTimeout).

## Use Case: Studio

![Studio flow with Listener, Logger, Send, and Transform Message](/mulesoft/current/en-us/msmq-connector/latest/_images/msmq-flow-example.png)

## USe Case: XML

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:file="http://www.mulesoft.org/schema/mule/file"
xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
xmlns:msmq="http://www.mulesoft.org/schema/mule/msmq"
xmlns:http="http://www.mulesoft.org/schema/mule/http"
xmlns="http://www.mulesoft.org/schema/mule/core"
xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/http
http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/msmq
http://www.mulesoft.org/schema/mule/msmq/current/mule-msmq.xsd
http://www.mulesoft.org/schema/mule/ee/core
http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/file
http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd">

<http:listener-config name="HTTP_Listener_config"
doc:name="HTTP Listener config" basePath="/">
    <http:listener-connection host="0.0.0.0" port="8081" />
</http:listener-config>

<configuration-properties file="gateway-connection.properties" />

<http:request-config name="HTTP_Request_configuration"
doc:name="HTTP Request configuration"/>
<msmq:msmq-sender-config name="MSMQ_Connector_Msmq_sender_config"
messageFormatter="None" doc:name="MSMQ Connector Msmq sender config">
    <msmq:msmq-connection serviceAddress="${msmqConfig.serviceAddress}"
     accessToken="${msmqConfig.accessToken}"
     queueName="${msmqConfig.rootQueueName}"
     ignoreSSLWarnings="true" />
</msmq:msmq-sender-config>
<msmq:msmq-receiver-config name="MSMQ_Connector_Msmq_receiver_config"
messageCount="1" pollingFrequency="1" messageFormatter="None"
doc:name="MSMQ Connector Msmq receiver config"
messageDelivery="AtLeastOnce" >
    <msmq:msmq-connection serviceAddress="${msmqConfig.serviceAddress}"
     accessToken="${msmqConfig.accessToken}"
     queueName="${msmqConfig.rootQueueName}"
     ignoreSSLWarnings="true" />
</msmq:msmq-receiver-config>
<flow name ="Parse-template">
    <http:listener doc:name="Listener"
    config-ref="HTTP_Listener_config" path="/"/>
    <parse-template doc:name="Parse Template"
    location="form.html"/>

</flow>
<flow name="msmq-demo-send-operation">
<http:listener doc:name="Listener"
config-ref="HTTP_Listener_config" path="/send"/>
<logger level="INFO" doc:name="Logger"
message="#[payload]"/>
<msmq:send doc:name="Send"
 config-ref="MSMQ_Connector_Msmq_sender_config"
 messageFormatter="None" queueName="${msmqConfig.rootQueueName}">
    <msmq:payload ><![CDATA[#[attributes.queryParams.message]]]></msmq:payload>
</msmq:send>
<ee:transform doc:name="Transform Message" >
    <ee:message >
                <ee:set-payload ><![CDATA[%dw 2.0
output text/plain
---
"Message sent successfully"]]></ee:set-payload>
            </ee:message>
        </ee:transform>
    </flow>
    <flow name="msmq-demo-receive-source" >
    <msmq:msmq doc:name="Msmq" config-ref="MSMQ_Connector_Msmq_receiver_config" />
        <logger level="INFO" doc:name="Logger" message="#[payload]"/>
    </flow>
</mule>
```

## See Also

- [Microsoft MSMQ Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/msmq-connector-release-notes-mule-4)

- [Windows Gateway Services Configuration Guide](https://docs.mulesoft.com/connectors/windows-gateway-services/windows-gateway-services-guide-mule4)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=4f0a944e554701143fad33479af8d3ad0f3168f6b81824b13688f577623da3d2 url=/mulesoft/current/en-us/msmq-connector/latest/msmq-connector-reference.md -->

---
product: Microsoft MSMQ Connector
version: 2.1
is-latest-version: true
---

# Microsoft MSMQ Connector Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for Microsoft Message Queuing (MSMQ) (MSMQ Connector) uses a typical
client-server architecture with two tiers, the connector or client running in the Mule Runtime, and
the Windows Gateway running on the server side. The latter exposes an HTTP Web API for sending or
receiving messages from MSMQ.

## MSMQ Receiver Configuration

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>The name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Connection</p></td><td><div><div><p>Msmq</p></div></div></td><td><p>The connection Types that can be provided to this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Message Count</p></td><td><div><div><p>Number</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Polling Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>The polling frequency in milliseconds to pull messages out of the gateway.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Message Formatter</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>None</p></li><li><p>ActiveXMessageFormatter</p></li></ul></div></div></td><td><p>The MSMQ message formatter to use to encode or decode messages.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Message Delivery</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NoAcknowledgement</p></li><li><p>AtLeastOnce</p></li></ul></div></div></td><td><p>The message delivery mode when receiving messages from the Gateway.</p></td><td></td><td></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p>ExpirationPolicy</p></div></div></td><td><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges instances as it sees fit.</p></td><td></td><td></td></tr></tbody></table>

### MSMQ Connection Type

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Gateway Service Address</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Gateway Access Token</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Queue Name (optional)</p></td><td><div><div><p>String</p></div></div></td><td><p>Queue name in UNC Path or FormatName notation, for example <code>.\private$\myqueue</code></p></td><td></td><td></td></tr><tr><td><p>Impersonation Username (optional)</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Impersonation Password (optional)</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Ignore SSL Warnings</p></td><td><div><div><p>Boolean</p></div></div></td><td></td><td><p>false</p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p>Reconnection</p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

#### Associated Sources

- msmq

## MSMQ Sender Configuration

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>The name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Connection</p></td><td><div><div><p>Msmq</p></div></div></td><td><p>The connection Types that can be provided to this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Message Formatter</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>None</p></li><li><p>ActiveXMessageFormatter</p></li></ul></div></div></td><td><p>The MSMQ message formatter to use to encode or decode messages.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p>ExpirationPolicy</p></div></div></td><td><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges instances as it sees fit.</p></td><td></td><td></td></tr></tbody></table>

### MSMQ Connection Type

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Gateway Service Address</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Gateway Access Token</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Queue Name (optional)</p></td><td><div><div><p>String</p></div></div></td><td><p>Queue name in UNC Path or FormatName notation, for example <code>.\private$\myqueue</code></p></td><td></td><td></td></tr><tr><td><p>Impersonation Username (optional)</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Impersonation Password (optional)</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Ignore SSL Warnings</p></td><td><div><div><p>Boolean</p></div></div></td><td></td><td><p>false</p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p>Reconnection</p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

#### Associated Operations

- send

## Send Operation

`<msmq:send>`

Sends the specified message to the queue.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Queue Name</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Message Formatter</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>None</p></li><li><p>ActiveXMessageFormatter</p></li></ul></div></div></td><td><p>The message formatter.</p></td><td></td><td></td></tr><tr><td><p>Payload</p></td><td><div><div><p>Binary</p></div></div></td><td><p>The message to be sent.</p></td><td><p><code>#[payload</code>]</p></td><td></td></tr><tr><td><p>Impersonation Username</p></td><td><div><div><p>String</p></div></div></td><td><p>(Optional) If entered, the user name of the user to impersonate when accessing the MSMQ. The userName should be in the formats: local computer user: <code>[username]</code> or domain user: <code>[DOMAIN]\[username]</code>.</p></td><td></td><td></td></tr><tr><td><p>Impersonation Password</p></td><td><div><div><p>String</p></div></div></td><td><p>(Optional) If entered, the password of the user to impersonate when accessing the MSMQ.</p></td><td></td><td></td></tr><tr><td><p>Time to be received</p></td><td><div><div><p>Number</p></div></div></td><td><p>(Optional) Message lifetime in seconds. 0 means the message does not expire.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Time to reach queue</p></td><td><div><div><p>Number</p></div></div></td><td><p>(Optional) Interval in seconds that represents the time a message can take to reach the destination queue from the gateway. 0 means the message does not expire.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Additional Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Additional HTTP headers.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p>reconnect</p></li><li><p>reconnect-forever</p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### For Configurations

- msmq-sender-config

### Throws

- MSMQ:CONNECTIVITY

- MSMQ:RETRY\_EXHAUSTED

## Sources

### Msmq

`<msmq:msmq>`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Redelivery Policy</p></td><td><div><div><p>RedeliveryPolicy</p></div></div></td><td><p>Defines a policy for processing the redelivery of the same message.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p>repeatable-in-memory-stream</p></li><li><p>repeatable-file-store-stream</p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure to use repeatable streams and their behavior.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p>reconnect</p></li><li><p>reconnect-forever</p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- msmq-receiver-config

## Types

### Reconnection

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Fails Deployment</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p>reconnect</p></li><li><p>reconnect-forever</p></li></ul></div></div></td><td><p>The reconnection strategy to use.</p></td><td></td><td></td></tr></tbody></table>

### Reconnect

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to reconnect (in milliseconds)</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of reconnection attempts to make</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If false, the reconnection strategy runs in a separate, non-blocking thread</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect Forever

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often in milliseconds to reconnect</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If false, the reconnection strategy runs in a separate, non-blocking thread</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

### Expiration Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Max Idle Time</p></td><td><div><div><p>Number</p></div></div></td><td><p>A scalar time value for the maximum amount of time to allow a dynamic configuration instance to be idle before being eligible to expire.</p></td><td></td><td></td></tr><tr><td><p>Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the maxIdleTime attribute.</p></td><td></td><td></td></tr></tbody></table>

### Redelivery Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Max Redelivery Count</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message.</p></td><td></td><td></td></tr><tr><td><p>Use Secure Hash</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether to use a secure hash algorithm to identify a redelivered message.</p></td><td></td><td></td></tr><tr><td><p>Message Digest Algorithm</p></td><td><div><div><p>String</p></div></div></td><td><p>The secure hashing algorithm to use. If not set, the default is SHA-256.</p></td><td></td><td></td></tr><tr><td><p>Id Expression</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.</p></td><td></td><td></td></tr><tr><td><p>Object Store</p></td><td><div><div><p>ObjectStore</p></div></div></td><td><p>The object store where the redelivery counter for each message is going to be stored.</p></td><td></td><td></td></tr></tbody></table>

### Repeatable In Memory Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Initial Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The amount of memory to allocate to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.</p></td><td></td><td></td></tr><tr><td><p>Buffer Size Increment</p></td><td><div><div><p>Number</p></div></div></td><td><p>This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, which means that a STREAM_MAXIMUM_SIZE_EXCEEDED error occurs when the buffer is full.</p></td><td></td><td></td></tr><tr><td><p>Max Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>This is the maximum amount of memory to use. If more memory is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error occurs. A value lower or equal to zero means no limit.</p></td><td></td><td></td></tr><tr><td><p>Buffer Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><p>The unit in which all these attributes are expressed.</p></td><td></td><td></td></tr></tbody></table>

### Repeatable File Store Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Max In Memory Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it starts to buffer the content on disk.</p></td><td></td><td></td></tr><tr><td><p>Buffer Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><p>The unit in which maxInMemorySize is expressed.</p></td><td></td><td></td></tr></tbody></table>

## See Also

- [MSMQ Connector Overview](https://docs.mulesoft.com/msmq-connector/latest/)

- [Windows Gateway Services Configuration Guide](https://docs.mulesoft.com/connectors/windows-gateway-services/windows-gateway-services-guide-mule4)

- [Salesforce Help](https://help.salesforce.com)