---
schema_version: "1"
id: 38914ed4ce0174d18d63d1e2ef82a9b261d2e95a00fdde768d56f422352c8d6f
title: SFTP Connector 2.5 Reference
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/sftp-connector/2.5/sftp-documentation.md
canonical_url: https://docs.mulesoft.com/sftp-connector/2.5/sftp-documentation
source_site: docs.mulesoft.com
content_type: documentation
content_hash: af876c1bc0eb22bbaa6d394adf3186d141802935d0bd6dfb4bc7d034234a1518
description: MuleSoft Documentation Site
release: "2.5"
latest: false
---
---
product: SFTP Connector
version: 2.5
---

# SFTP Connector 2.5 Reference

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

Anypoint Connector for SFTP (SFTP Connector) provides access to files and folders on a SFTP server.

Release Notes: [SFTP Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/connector-sftp)

> [!NOTE] PPK (Private Key) file does not support identity file for SFTP Connector.

## Configurations

---

### Default 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><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name for this configuration. Connectors reference the configuration with this name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p><a href="#config_connection">SFTP Connection</a></p></div></div></td><td><div><div><p>The connection types to provide to this configuration.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Time Between Size Check</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Wait time between size checks to determine if a file is ready to read. This allows a file write to complete before processing. If no value is provided, the check will not be performed. When enabled, Mule waits the specified time between calls and performs two size checks. If both checks return the same value, the file is ready to read. This attribute works in tandem with <strong>Time Between Size Check Unit</strong>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Between Size Check Unit</strong></p></td><td><div><div><p>Enumeration, is 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><div><div><p>A TimeUnit that qualifies the <strong>Time Between Size Check</strong> attribute.</p></div></div></td><td><div><div><p><code>MILLISECONDS</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Expiration Policy</strong></p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><div><div><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 will expire the instance at the exact moment that it becomes eligible. Mule runtime engine purges the instances when it sees it fit.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Connection Types

##### SFTP Connection

A file system provider that provides instances of SFTP file system from instances of SFTP Connector.

###### 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><strong>Working Directory</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The directory designated as the root of every relative path used with this connector. If not provided, it defaults to the remote server default. Define a working directory because some SFTP servers do not return output for the present working directory command. While the behavior of the SFTP server side cannot be controlled, setting this value mitigates such scenario.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Preferred Authentication Methods</strong></p></td><td><div><div><p>Array of enumeration is one of:</p></div><div><ul><li><p>GSSAPI_WITH_MIC</p></li><li><p>PUBLIC_KEY</p></li><li><p>KEYBOARD_INTERACTIVE</p></li><li><p>PASSWORD</p></li></ul></div></div></td><td><div><div><p>Set of authentication methods used by the SFTP client. Valid values are: <code>GSSAPI_WITH_MIC</code>, <code>PUBLIC_KEY</code>, <code>KEYBOARD_INTERACTIVE</code>, and <code>PASSWORD</code>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Known Hosts File</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>If provided, the client validates the server’s key against the one in the referenced file. If the server key doesn’t match the one in the file, the connection will be aborted.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Sftp Proxy Config</strong></p></td><td><div><div><p><a href="#SftpProxyConfig">SFTP Proxy Config</a></p></div></div></td><td><div><div><p>If provided, a proxy will be used for the connection.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>A scalar value representing the amount of time to wait before a connection attempt times out. This attribute works in tandem with <strong>Connection Timeout Unit</strong>.</p></div></div></td><td><div><div><p><code>10</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout Unit</strong></p></td><td><div><div><p>Enumeration is 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><div><div><p>A time unit that qualifies the <strong>Connection Timeout</strong> attribute.</p></div></div></td><td><div><div><p><code>SECONDS</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Response Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>A scalar value representing the amount of time to wait before an SFTP request times out. This corresponds to the internal <code>sftp-client-cmd-timeout</code> property on the <code>org.apache.sshd.sftp.client.impl.AbstractSftpClient</code> AbstractSftpClient, which is applied by <code>DefaultSftpClient</code> when sending SFTP commands. Defaults to 30 seconds (the default of the SFTP client), but can be overridden here. This attribute works in tandem with <strong>Response Timeout Unit</strong>.</p></div></div></td><td><div><div><p><code>30</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Response Timeout Unit</strong></p></td><td><div><div><p>Enumeration is 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><div><div><p>A TimeUnit that qualifies the <strong>Response Timeout Unit</strong> attribute.</p></div></div></td><td><div><div><p><code>SECONDS</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The SFTP server host, such as <code>www.mulesoft.com</code>, <code>localhost</code>, or <code>192.168.0.1</code>, and so on.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The port number of the SFTP server to connect on.</p></div></div></td><td><div><div><p><code>22</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Username for the SFTP Server. Required if the server is authenticated.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password for the SFTP Server. Required if the server is authenticated.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Passphrase</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The passphrase (password) for the identity file if required. This parameter is ignored if identity file is not provided.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Identity File</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An identity file location for a PKI private key.<br>ssh-keygen’s OpenSSH PKI format is not accepted. You can use argument "-m PEM".</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>PRNG Algorithm</strong></p></td><td><div><div><p>Enumeration is one of:</p></div><div><ul><li><p>AUTOSELECT</p></li><li><p>NativePRNG</p></li><li><p>SHA1PRNG</p></li><li><p>NativePRNGBlocking</p></li><li><p>NativePRNGNonBlocking</p></li></ul></div></div></td><td><div><div><p>The Pseudo Random Number Generator Algorithm to use.</p></div></div></td><td><div><div><p>AUTOSELECT</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Security Configuration</strong></p></td><td><div><div><p><a href="#SecurityConfiguration">Security Configuration</a></p></div></div></td><td><div><div><p>Provides support to override security related configurations like Ciphers, MACs, Kex Algorithms, etc.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Pooling Profile</strong></p></td><td><div><div><p><a href="#PoolingProfile">Pooling Profile</a></p></div></div></td><td><div><div><p>Characteristics of the connection pool.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Supported Operations

- [Copy](#copy)

- [Create Directory](#createDirectory)

- [Delete](#delete)

- [List](#list)

- [Move](#move)

- [Read](#read)

- [Rename](#rename)

- [Write](#write)

### Associated Sources

- [On New or Updated File](#listener)

## Operations

### Copy

`<sftp:copy>`

Copies the file or directory specified in **Source Path** into the **Target Path**. The source path
can be either a file or a directory. If it points to a directory, then it is copied recursively.

If the target path doesn’t exist, and neither does its parent, then a parent folder is created if
**Create parent directories** is set to `true`. If **Create parent directories** is set to `false`,
then an `SFTP:ILLEGAL_PATH` error is thrown.

If **Overwrite** is set to `true` and the target file already exists, then the target file is
overwritten. Otherwise, an `SFTP:FILE_ALREADY_EXISTS` error is thrown.

#### 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><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Source Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The path to the file to copy.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The target directory for where to copy the file.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Create Parent Directories</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether or not to attempt to create parent directories if they don’t exist.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Overwrite</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether or not to overwrite the file if the target destination already exists.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Rename To</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Rename the copied file. If this value is not provided, the original file name is kept.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### For Configurations

- [Default Configuration](#config)

#### Throws

- SFTP:RETRY\_EXHAUSTED

- SFTP:ILLEGAL\_PATH

- SFTP:FILE\_ALREADY\_EXISTS

- SFTP:CONNECTIVITY

### Create Directory

`<sftp:create-directory>`

Creates a new directory using the value in the **Directory Path** field.

#### 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><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Directory Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The new directory’s name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### For Configurations

- [Default Configuration](#config)

#### Throws

- SFTP:RETRY\_EXHAUSTED

- SFTP:ILLEGAL\_PATH

- SFTP:ACCESS\_DENIED

- SFTP:FILE\_ALREADY\_EXISTS

- SFTP:CONNECTIVITY

### Delete

`<sftp:delete>`

Deletes the file that the path field points to, provided that the file is not locked.

#### 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><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The path to the file to delete.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### For Configurations

- [Default Configuration](#config)

#### Throws

- SFTP:RETRY\_EXHAUSTED

- SFTP:ILLEGAL\_PATH

- SFTP:ACCESS\_DENIED

- SFTP:CONNECTIVITY

### List

`<sftp:list>`

Lists all the files in the **Directory Path** depending on the rules in the File Matching Rules
field.

If the listing encounters a directory, the output list will include its contents, depending on the
value of the **Recursive** field.

If **Recursive** is set to the `true` value, but a found directory is rejected by the rules in the
**File Matching Rules** field, then recursion does not occur in the directory.

#### 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><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Directory Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The directory path to list.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Recursive</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether to include the contents of subdirectories. Defaults to <code>false</code>.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>File Matching Rules</strong></p></td><td><div><div><p><a href="#matcher">Matcher</a></p></div></div></td><td><div><div><p>A matcher used to filter the output list.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Between Size Check</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Wait time between size checks to determine if a file is ready to read.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Between Size Check Unit</strong></p></td><td><div><div><p>Enumeration is 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><div><div><p>Time unit to use in the wait time between size checks.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of Message of [String] payload and [<a href="#SftpFileAttributes">SFTP File Attributes</a>] attributes. The payload contains the element path.</p></div></div></td></tr></tbody></table>

### For Configurations

- [Default Configuration](#config)

#### Throws

- SFTP:ILLEGAL\_PATH

- SFTP:ACCESS\_DENIED

### Move

`<sftp:move>`

Moves the file or directory from the **Source Path** into the **Target Path**. The source path can
be either a file or a directory. If it points to a directory, then it will be moved recursively.

If the target path doesn’t exist, and neither does its parent, then a parent folder is created if
**Create parent directories** is set to `true`. If **Create parent directories** is set to `false`,
then an `SFTP:ILLEGAL_PATH` error is thrown.

If the target file already exists, then it will be overwritten if **Overwrite** is set to `true`. If
**Overwrite** is set to `false`, an `SFTP:FILE_ALREADY_EXISTS` error will be thrown.

#### 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><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Source Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The path to the file to copy.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The target directory.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Create Parent Directories</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether or not to attempt to create any parent directories that don’t exist.</p></div></div></td><td><div><div><p><code>true</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Overwrite</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether or not to overwrite the file if the target destination already exists.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Rename To</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the moved file. If a value is not provided, the original file name is kept.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### For Configurations.

- [Default Configuration](#config)

#### Throws

- SFTP:RETRY\_EXHAUSTED

- SFTP:ILLEGAL\_PATH

- SFTP:FILE\_ALREADY\_EXISTS

- SFTP:CONNECTIVITY

### Read

`<sftp:read>`

Obtains the content and metadata of a file at a given path. The operation itself returns a message
whose payload is an input stream with the file’s content, and the metadata is represented as an
`SftpFileAttributes` object that’s placed as the message `Message#getAttributes()` attributes.

If the lock parameter is set to `true`, then a file system level lock is placed on the file until
the input stream this operation returns is closed or fully consumed. Because the lock is provided by
the host file system, its behavior might change depending on the SFTP server or its file system.
Take that into consideration before relying on this lock.

This method also makes a best effort to determine the MIME type of the file being read by using the
file’s extension to make an educated guess. You can also use the output **Encoding** and output
**MIME Type** optional parameters to force the encoding and MIME 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><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>File Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The path to the file to read.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Lock</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether or not to lock the file. Defaults to <code>false</code>.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Between Size Check</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Wait time between size checks to determine if a file is ready to read.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Between Size Check Unit</strong></p></td><td><div><div><p>Enumeration is 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><div><div><p>Time unit to use in the wait time between size checks.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Output Mime Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The MIME type of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Output Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The encoding of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configure whether to use repeatable streams.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a variable to store the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#SftpFileAttributes">SFTP File Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Default Configuration](#config)

#### Throws

- SFTP:FILE\_LOCK

- SFTP:RETRY\_EXHAUSTED

- SFTP:ILLEGAL\_PATH

- SFTP:ACCESS\_DENIED

- SFTP:CONNECTIVITY

### Rename

`<sftp:rename>`

Renames the file to which the path points to the value provided in the **New Name** parameter. This
argument should not contain any path separator, or an `SFTP:ILLEGAL_PATH` error will be thrown.

#### 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><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The path to the file to rename.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>New Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The file’s new name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Overwrite</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether or not to overwrite the file if the target destination already exists.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### For Configurations

- [Default Configuration](#config)

#### Throws

- SFTP:RETRY\_EXHAUSTED

- SFTP:ILLEGAL\_PATH

- SFTP:ACCESS\_DENIED

- SFTP:FILE\_ALREADY\_EXISTS

- SFTP:CONNECTIVITY

### Write

`<sftp:write>`

Writes the content into the file the path points to.

If the directory to which the file is attempting to be written doesn’t exist, then the operation
will either throw an `SFTP:ILLEGAL_PATH` error, or create a new folder, depending on the value of
**Create parent directories**. If the file already exists, then the behavior depends on the supplied
mode.

This operation also supports locking depending on the value of the lock argument, and follows the
same rules and considerations as described in the read operation.

> [!NOTE] An additional check is performed if the file already exists, thus the FTP `STAT` command
> is executed before writing the file.

#### 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><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The path of the file to write.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Content</strong></p></td><td><div><div><p>Binary</p></div></div></td><td><div><div><p>The content to write into the file. Defaults to the current Message payload.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Create Parent Directories</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether or not to attempt to create any parent directories that don’t exist.</p></div></div></td><td><div><div><p><code>true</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Lock</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether or not to lock the file. Defaults to <code>false</code>.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Write Mode</strong></p></td><td><div><div><p>Enumeration is one of:</p></div><div><ul><li><p>OVERWRITE</p></li><li><p>APPEND</p></li><li><p>CUSTOM_APPEND</p></li><li><p>CREATE_NEW</p></li></ul></div></div></td><td><div><div><p>A <code>FileWriteMode</code>.</p></div><div><ul><li><p>OVERWRITE</p><div><p>If the file to be written exists, then overwrite it.</p></div></li><li><p>APPEND</p><div><p>If the file to be written exists, then append the content to that file.</p></div></li><li><p>CUSTOM_APPEND</p><div><p>If the file to be written using the <code>CUSTOM</code> write strategy exists, then append the content to that file.</p></div></li><li><p>CREATE_NEW</p><div><p>Create a file and raise an error if the file exists.</p></div></li></ul></div></div></td><td><div><div><p><code>OVERWRITE</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Write Strategy</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>STANDARD</p></li><li><p>CUSTOM</p></li></ul></div></div></td><td><div><div><p>Strategy to write the file.</p></div><div><ul><li><p>STANDARD</p><div><p>The standard write function is used where the file write mode is honored.</p></div></li><li><p>CUSTOM</p><div><p>A custom write function is used to write to files where offset is manually calculated.</p></div></li></ul></div></div></td><td><div><div><p><code>STANDARD</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size For Write Strategy</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BUFFER_SIZE_1KB</p></li><li><p>BUFFER_SIZE_2KB</p></li><li><p>BUFFER_SIZE_4KB</p></li><li><p>BUFFER_SIZE_8KB</p></li><li><p>BUFFER_SIZE_16KB</p></li></ul></div></div></td><td><div><div><p>Buffer size for the custom write.</p></div></div></td><td><div><div><p><code>BUFFER_SIZE_8KB</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Configuration name to execute the write strategy.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### For Configurations

- [Default Configuration](#config)

#### Throws

- SFTP:FILE\_LOCK

- SFTP:RETRY\_EXHAUSTED

- SFTP:ILLEGAL\_PATH

- SFTP:ACCESS\_DENIED

- SFTP:ILLEGAL\_CONTENT

- SFTP:FILE\_ALREADY\_EXISTS

- SFTP:CONNECTIVITY

- SFTP:FILE\_DOESNT\_EXIST

## Sources

### On New or Updated File

`<sftp:listener>`

Polls a directory and looks for files that have been created in it. One message is generated for
each file that is found.

The key part of this functionality is how to determine that a file is actually new. There are three
strategies for that:

- Set the **Auto delete** parameter to `true` to delete each file after it is processed, which
  causes all files obtained in the next poll to be necessarily new.

- Set the **Move to directory** parameter to move each file to a different directory after it is
  processed, which achieves the same effect as **Auto delete** but without losing the file.

- Use **Watermark enabled** to pick only files that have been created or updated after the last poll
  was executed.

You can also use a matcher for additional filtering of files.

The **On New Or Updated File** source ignores files that return with an empty attributes list. The
list can be empty if the modification time (MDTM) is not enabled by the SFTP server or if the server
returns an error when listing the attributes.

#### 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><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Directory</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The directory in which polled files are contained.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Recursive</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether or not to also poll files contained in sub directories.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Matcher</strong></p></td><td><div><div><p><a href="#matcher">Matcher</a></p></div></div></td><td><div><div><p>A matcher used to filter events on files that do not meet the file matching criteria.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Watermark Enabled</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Controls whether or not to do watermarking, and if so, if the watermark should consider the file’s modification or creation timestamps. Enable this field to have the connector pick only files that were created or updated after the completion of the latest poll.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Between Size Check</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Wait time (in milliseconds) between size checks to determine if a file is ready to read. This allows a file write to complete before processing. When enabled, Mule performs two size checks, waiting the specified time between calls. If both checks return the same value, the file is ready to read.<br>You can disable this feature by omitting a value.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Between Size Check Unit</strong></p></td><td><div><div><p>Enumeration is 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><div><div><p>A TimeUnit which qualifies the <strong>Time between size check</strong> attribute.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Output Mime Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The MIME type of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Output Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The encoding of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Primary Node Only</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether this source should be executed only on the primary node when running in a cluster.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Scheduling Strategy</strong></p></td><td><div><div><p>scheduling-strategy</p></div></div></td><td><div><div><p>Configures the scheduler that triggers the polling.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configure whether to use repeatable streams.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Redelivery Policy</strong></p></td><td><div><div><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></div></div></td><td><div><div><p>Defines a policy for processing the redelivery of the same message.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors. The source stops polling if the <a href="#reconnect">Reconnect</a> strategy fails. Use the <a href="#reconnect-forever">Reconnect Forever</a> strategy to run the source indefinitely.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Delete</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether to delete each file after processing.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Move To Directory</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>If provided, each processed file will be moved to a directory that is pointed to by this path.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Rename To</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>This parameter works in tandem with <strong>Move to directory</strong>. Use this parameter to enter the name of the directory under which to move the file. Do not set this parameter if <strong>Move to directory</strong> hasn’t also been set.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Apply Post Action When Failed</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether any of the post actions (<strong>Auto delete</strong> and <strong>Move to directory</strong>) should also be applied in case the file fails to be processed. If set to <code>false</code>, no failed files will be moved or deleted.</p></div></div></td><td><div><div><p><code>true</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Overwrite</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Enables you to overwrite the target file when the destination file has the same name.</p></div></div></td><td><div><div><p><code>false</code></p></div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#SftpFileAttributes">SFTP File Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Default Configuration](#config)

## Types

### SFTP Proxy Config

<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>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Protocol</strong></p></td><td><div><div><p>Enumeration is of:</p></div><div><ul><li><p>HTTP</p></li><li><p>SOCKS5</p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Security Configuration

Configuring security settings using the SSH Config Override File means you accept the
[shared responsibilities](https://docs.mulesoft.com/connectors/introduction/connectors-shared-responsibilities)
documentation.

<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>SSH Config Override File</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the file with the SSH override configurations. It supports the following configs:</p></div><div><ul><li><p><code>KexAlgorithms</code><br>Specifies the comma separated list of key exchange algorithms.</p></li><li><p><code>Ciphers</code><br>Specifies the comma separated list of symmetric ciphers.</p></li><li><p><code>HostKeyAlgorithms</code><br>Specifies the comma separated list of host key signature algorithms.</p></li><li><p><code>MACs</code><br>Specifies the comma separated list of message authentication codes.</p></li></ul></div><div><p>You define the keys in the file you need to override, defaults are taken for the remaining keys.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>The reconnection strategy to use. It overrides the <code>Fails Deployment</code> field. So if the reconnection strategy is set to <code>reconnect-forever</code>, the deployment never fails.</p></div></div></td><td><div></div></td><td><div></div></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>Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>How often (in milliseconds) to reconnect.</p></td><td></td><td></td></tr><tr><td><p>Count</p></td><td><div><div><p>Number</p></div></div></td><td><p>How many reconnection attempts to make.</p></td><td></td><td></td></tr><tr><td><p>blocking</p></td><td><p>Boolean</p></td><td><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></td><td><p><code>true</code></p></td><td></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>Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>How often (in milliseconds) to reconnect.</p></td><td></td><td></td></tr><tr><td><p>blocking</p></td><td><p>Boolean</p></td><td><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></td><td><p><code>true</code></p></td><td></td></tr></tbody></table>

### Pooling Profile

<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>Max Active</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Controls the maximum number of connections that can be active at one time. When set to a negative value, there is no limit to the number of components that can be active at one time. When <strong>Max active</strong> is exceeded, the pool is exhausted.</p></div></div></td><td><div><div><p>5</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Idle</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Controls the maximum number of connections that can sit idle in the pool at any one time. When set to a negative value, there is no limit to the number of connections that can be idle at one time.</p></div></div></td><td><div><div><p>5</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Wait</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Specifies the number of milliseconds to wait for a pooled component to become available when the pool is exhausted and the <strong>Exhausted action</strong> is set to <code>WHEN_EXHAUSTED_WAIT</code>.</p></div></div></td><td><div><div><p>5</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Min Eviction Millis</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Determines the minimum amount of time an object can sit idle in the pool before it is eligible for eviction. When non-positive, no objects will be evicted from the pool due to idle time alone.</p></div></div></td><td><div><div><p>1800000</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Eviction Check Interval Millis</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Specifies the number of milliseconds between runs of the object evictor. When non-positive, no object evictor is executed.</p></div></div></td><td><div><div><p>-1</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Exhausted Action</strong></p></td><td><div><div><p>Enumeration is one of:</p></div><div><ul><li><p>WHEN_EXHAUSTED_GROW</p></li><li><p>WHEN_EXHAUSTED_WAIT</p></li><li><p>WHEN_EXHAUSTED_FAIL</p></li></ul></div></div></td><td><div><div><p>Specifies the behavior of the Mule component pool when the pool is exhausted. Possible values are:</p></div><div><ul><li><p><code>WHEN_EXHAUSTED_FAIL</code>, which will throw a <code>NoSuchElementException</code>. * <code>WHEN_EXHAUSTED_WAIT</code>, which will block by invoking <code>Object.wait(long)</code> until a new or idle object is available.</p></li><li><p><code>WHEN_EXHAUSTED_GROW</code>, which will create a new Mule instance and return it, essentially making <code>maxActive</code> meaningless. If a positive <code>maxWait</code> value is supplied, it will block for, at most, the specified number of milliseconds, after which a <code>NoSuchElementException</code> will be thrown. If <code>maxThreadWait</code> is a negative value, it will block indefinitely.</p></li></ul></div></div></td><td><div><div><p>WHEN_EXHAUSTED_GROW</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Initialisation Policy</strong></p></td><td><div><div><p>Enumeration is one of:</p></div><div><ul><li><p>INITIALISE_NONE</p></li><li><p>INITIALISE_ONE</p></li><li><p>INITIALISE_ALL</p></li></ul></div></div></td><td><div><div><p>Determines how components in a pool should be initialized. The possible values are:</p></div><div><ul><li><p>INITIALISE_NONE, which means no components will be loaded into the pool at startup.</p></li><li><p>INITIALISE_ONE, which will load one initial component into the pool at startup.</p></li><li><p>INITIALISE_ALL, which will load all components in the pool at startup.</p></li></ul></div></div></td><td><div><div><p>INITIALISE_NONE</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><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></p></td><td><div><div><p>Enumeration is 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><div><div><p>A time unit that qualifies the <strong>Max idle time</strong> attribute.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### SFTP File Attributes

<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>Timestamp</strong></p></td><td><div><div><p>DateTime</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Regular File</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Directory</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Symbolic Link</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Permissions</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>File Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Matcher

<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>Timestamp Since</strong></p></td><td><div><div><p>DateTime</p></div></div></td><td><div><div><p>Files created before this date are rejected. Any timezone specification in this value is ignored and the Mule server’s time zone is used instead.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Timestamp Until</strong></p></td><td><div><div><p>DateTime</p></div></div></td><td><div><div><p>Files created after this date are rejected. Any timezone specification in this value is ignored and the Mule server’s time zone is used instead.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Not Updated In The Last</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Minimum time that should pass since a file was last updated to not be rejected. This attribute works in tandem with <strong>Time unit</strong>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Updated In The Last</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum time that should pass from when a file was last updated to not be rejected. This attribute works in tandem with <strong>Time unit</strong>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></p></td><td><div><div><p>Enumeration is 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><div><div><p>A <strong>Not updated in the last</strong> attributes.</p></div></div></td><td><div><div><p>MILLISECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Case Sensitive</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Enables you to configure an external file system matcher as case sensitive or insensitive.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Filename Pattern</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A matching pattern to apply on the file name. Supports glob expressions (default) and regex expressions. To use any of the expressions set a prefix, for example, <code>glob:*.{java, js}</code> or <code>regex:[0-9]test.csv</code>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Path Pattern</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A matching pattern to apply on the file path</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Directories</strong></p></td><td><div><div><p>Enumeration is one of:</p></div><div><ul><li><p>REQUIRE</p></li><li><p>INCLUDE</p></li><li><p>EXCLUDE</p></li></ul></div></div></td><td><div><div><p>Match only if the file is a directory</p></div></div></td><td><div><div><p>INCLUDE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Regular Files</strong></p></td><td><div><div><p>Enumeration is one of:</p></div><div><ul><li><p>REQUIRE</p></li><li><p>INCLUDE</p></li><li><p>EXCLUDE</p></li></ul></div></div></td><td><div><div><p>Match only if the file is a regular file</p></div></div></td><td><div><div><p>INCLUDE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Sym Links</strong></p></td><td><div><div><p>Enumeration is one of:</p></div><div><ul><li><p>REQUIRE</p></li><li><p>INCLUDE</p></li><li><p>EXCLUDE</p></li></ul></div></div></td><td><div><div><p>Match only if the file is a symbolic link</p></div></div></td><td><div><div><p>INCLUDE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Min Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The minimum file size in bytes. Files smaller than the specified value are rejected.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum file size in bytes. Files larger than the specified value are rejected.</p></div></div></td><td><div></div></td><td><div></div></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><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>This is the amount of memory to allocate to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then it will be expanded according to the <strong>Buffer size increment</strong> attribute, with an upper limit of <strong>Max in memory size</strong>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>This is by how much the buffer size will be expanded if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, and that a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error will be raised when the buffer gets full.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>This is the maximum amount of memory to use. If more than the specified maximum is used, then a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error will be raised. A value lower or equal to zero means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration is 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><div><div><p>The unit in which all these attributes are expressed.</p></div></div></td><td><div></div></td><td><div></div></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><strong>Max In Memory Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then content is buffered on the disk.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></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><div><div><p>The unit in which maxInMemorySize is expressed</p></div></div></td><td><div></div></td><td><div></div></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><strong>Max Redelivery Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Use Secure Hash</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether to use a secure hash algorithm to identify a redelivered message</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message Digest Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The secure hashing algorithm to use. If not set, the default is <code>SHA-256</code>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Id Expression</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><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></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Object Store</strong></p></td><td><div><div><p>ObjectStore</p></div></div></td><td><div><div><p>The object store where the redelivery counter for each message will be stored.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable In Memory Iterable

<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>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>This is the number of instances initially allowed to be kept in memory in order to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then it will be expanded according to the <strong>Buffer size increment</strong> attribute, with an upper limit of <strong>Max in memory size</strong>. Default value is 100 instances.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How much the buffer size will expand if it exceeds its initial specified size. Setting a value of zero or lower means that the buffer should not expand, and that a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error will be raised when the buffer gets full. Default value is 100 instances.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max in Memory Instances</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>This is the maximum amount of memory to use. If more than the maximum amount is used, then a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error will be raised. A value lower or equal to zero means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable File Store Iterable

<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>In Memory Objects</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum number of instances to keep in memory. If more than the maximum is required, content starts to buffer to the disk.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## See Also

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