FTPS Connector Reference | MuleSoft Documentation
# FTPS Connector Reference
FTPS Connector v2.0
Anypoint Connector for FTPS (FTPS Connector) enables you to manipulate files in an FTPS server.
## Configurations
### Default Configuration
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
The name for this configuration. Connectors reference the configuration with this name.  
**Connection** |  FTPS Connection |  The connection types to provide to this configuration.  
**Default write encoding(DEPRECATED)** |  This parameter is deprecated and not taken into account.  
**Time Between Size Check** |  This value specifies the wait time between size checks to determine if a file is ready to be read.  
**Time Between Size Check Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  Specify the time unit to use in the wait time between size checks. |  `MILLISECONDS`  
**Expiration Policy** |  Expiration Policy |  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 the instances when appropriate.  
#### Connection Types
##### FTPS Connection
This configuration corresponds to a specialization of FTP connection provider that supports SSL.
###### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Working Directory** |  The directory to consider the root of every relative path used with this connector  
One of:
  * HTTP Tunnel Proxy
  * HTTPS Tunnel Proxy

|  Enables you to set HTTP or HTTPS tunnel proxy.  
**Transfer Mode** |  Enumeration, one of:
  * BINARY
  * ASCII

|  Transfer mode to use  
Specifies whether to use passive mode. Set to `false` to switch to active mode.  
**Required Libraries** |  One of:
  * Add recommended libraries
  * Use local file
  * Add Maven dependency

|  Ways to add the required Bouncy Castle libraries.  
**Enable Remote Verification** |  Specifies whether or not to verify if the remote host taking part of a data connection is the same as the host to which the control connection is attached.  
**Control Encoding** |  Set the control encoding (for example UTF-8) to use in the control channel with the remote server. This does NOT set the encoding for the content of the files to transfer.  
One of:
  * FtpsExplicitMode
  * FtpsImplicitMode

  
**TLS Configuration**  
**Connection Timeout** |  Connection timeout value  
**Connection Timeout Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  Time unit to use in the Connection Timeout  
**Response Timeout** |  Response timeout value  
**Response Timeout Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  Time unit to use in the Response Timeout  
**Reconnection** |  |  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.  
**Pooling Profile** |  Pooling Profile |  Characteristics of the connection pool  
## Supported Operations
  * Create Directory


## Associated Sources
  * On New or Updated File


## Operations
### Copy
`<ftps:copy>`
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Source Path**  
**Target Path**  
**Create Parent Directories**  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
### For Configurations
  * Default Configuration


#### Throws
  * FTPS:ILLEGAL_PATH
  * FTPS:RETRY_EXHAUSTED
  * FTPS:FILE_ALREADY_EXISTS
  * FTPS:CONNECTIVITY


### Create Directory
`<ftps:create-directory>`
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Directory Path**  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
### For Configurations
  * Default Configuration


#### Throws
  * FTPS:ILLEGAL_PATH
  * FTPS:RETRY_EXHAUSTED
  * FTPS:FILE_ALREADY_EXISTS
  * FTPS:CONNECTIVITY
  * FTPS:ACCESS_DENIED


### Delete
`<ftps:delete>`
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
### For Configurations
  * Default Configuration


#### Throws
  * FTPS:ILLEGAL_PATH
  * FTPS:RETRY_EXHAUSTED
  * FTPS:CONNECTIVITY
  * FTPS:ACCESS_DENIED


### List
`<ftps:list>`
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Directory Path**  
**File Matching Rules** |  Matcher to filter the listed files  
**Time Between Size Check**  
**Time Between Size Check Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

  
**Streaming Strategy** | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

|  Configure to use repeatable streams.  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors  
#### Output
Array of Message of [Any] payload and [Ftp File Attributes] attributes  
---  
### For Configurations
  * Default Configuration


#### Throws
  * FTPS:ILLEGAL_PATH
  * FTPS:ACCESS_DENIED


### Move
`<ftps:move>`
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Source Path**  
**Target Path**  
**Create Parent Directories**  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
### For Configurations
  * Default Configuration


#### Throws
  * FTPS:ILLEGAL_PATH
  * FTPS:RETRY_EXHAUSTED
  * FTPS:FILE_ALREADY_EXISTS
  * FTPS:CONNECTIVITY


### Read
`<ftps:read>`
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Time Between Size Check**  
**Time Between Size Check Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

  
**Output Mime Type** |  The MIME type of the payload that this operation outputs.  
**Output Encoding** |  The encoding of the payload that this operation outputs.  
**Streaming Strategy** | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

|  Configure to use repeatable streams.  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Attributes Type |  Ftp File Attributes  
---|---  
### For Configurations
  * Default Configuration


#### Throws
  * FTPS:ILLEGAL_PATH
  * FTPS:FILE_LOCK
  * FTPS:RETRY_EXHAUSTED
  * FTPS:CONNECTIVITY
  * FTPS:ACCESS_DENIED


### Rename
`<ftps:rename>`
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
### For Configurations
  * Default Configuration
**Output Mime Type** |  The MIME type of the payload that this operation outputs.  
**Output Encoding** |  The encoding of the payload that this operation outputs.  
**Streaming Strategy** | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

|  Configure to use repeatable streams.  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Attributes Type |  Ftp File Attributes  
---|---  
### For Configurations
  * Default Configuration


#### Throws
  * FTPS:ILLEGAL_PATH
  * FTPS:FILE_LOCK
  * FTPS:RETRY_EXHAUSTED
  * FTPS:CONNECTIVITY
  * FTPS:ACCESS_DENIED


### Rename
`<ftps:rename>`
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
### For Configurations
  * Default Configuration


#### Throws
  * FTPS:ILLEGAL_PATH
  * FTPS:RETRY_EXHAUSTED
  * FTPS:FILE_ALREADY_EXISTS
  * FTPS:CONNECTIVITY
  * FTPS:ACCESS_DENIED


### Write
`<ftps:write>`
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
Content to be written into the file  
**Encoding (DEPRECATED)** |  This parameter is deprecated and not taken into account for the operation execution.  
**Create Parent Directories**  
**Write Mode** |  Enumeration, one of:
  * OVERWRITE
  * APPEND
  * CREATE_NEW

|  How to write the file  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors  
### For Configurations
  * Default Configuration


#### Throws
  * FTPS:ILLEGAL_PATH
  * FTPS:FILE_LOCK
  * FTPS:RETRY_EXHAUSTED
  * FTPS:FILE_ALREADY_EXISTS
  * FTPS:CONNECTIVITY
  * FTPS:ACCESS_DENIED
  * FTPS:ILLEGAL_CONTENT


## Sources
### On New or Updated File
`<ftps:listener>`
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use  
Whether or not to also catch files created on sub directories  
**Watermark Enabled**  
**Time Between Size Check** |  Wait time, in milliseconds, between size checks to determine if a file is ready to be read.  
**Time Between Size Check Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  Time unit to use in the wait time between size checks  
**Output Mime Type** |  The MIME type of the payload that this operation outputs.  
**Output Encoding** |  The encoding of the payload that this operation outputs.  
**Primary Node Only** |  Whether to execute this source only on the primary node when running in a cluster  
**Scheduling Strategy** |  scheduling-strategy |  Configures the scheduler that triggers the polling  
**Streaming Strategy** | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

|  Configure to use repeatable streams  
**Redelivery Policy** |  Redelivery Policy |  Defines a policy for processing the redelivery of the same message  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors  
**Auto Delete**  
**Move To Directory**  
**Apply Post Action When Failed**  
#### Output
Attributes Type |  Ftp File Attributes  
---|---  
### For Configurations
  * Default Configuration


## Types
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Enabled Protocols | A comma separated list of protocols enabled for this context.  
Enabled Cipher Suites | A comma separated list of cipher suites enabled for this context.  
Trust Store  
Key Store  
Revocation Check | 
  * Standard Revocation Check
  * Custom Ocsp Responder

  
### Truststore
Configures the TLS truststore.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Path to the truststore. Mule resolves the path relative to the current classpath and file system.  
Password | Password used to protect the truststore.  
Type of truststore.  
Algorithm | Encryption algorithm that the truststore uses.  
Insecure | If `true`, Mule stops performing certificate validations. Setting this to `true` can make connections vulnerable to attacks.  
### Key Store
Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Path to the keystore. Mule resolves the path relative to the current classpath and file system, if possible.  
Type of keystore used.  
Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.  
Key Password | Password used to protect the private key.  
Password | Password used to protect the key store.  
Algorithm | Encryption algorithm that the keystore uses.  
### Standard Revocation Check
Configures standard revocation checks for TLS certificates.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Only End Entities | Verify the last element of the certificate chain only.  
Prefer Crls | Try CRL instead of OCSP first.  
No Fallback | Do not use the secondary checking method, which is the method not specified in the Prefer Crls field.  
Soft Fail | Avoid verification failure when the revocation server cannot be reached or is busy.  
### Custom Ocsp Responder
Configures a custom OCSP responder for certification revocation checks.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
URL of the OCSP responder.  
Cert Alias | Alias of the signing certicate for the OCSP response. If specified, the alias must be in the truststore.  
### Crl File
Specifies the location of the certification revocation list (CRL) file.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Path to the CRL file.  
### Reconnection
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Fails Deployment** |  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.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  The reconnection strategy to use.  
### Reconnect
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Frequency | How often in milliseconds to reconnect.  
How many reconnection attempts to make.  
blocking | If false, the reconnection strategy runs in a separate, non-blocking thread.  
### Reconnect Forever
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Frequency | How often in milliseconds to reconnect.  
blocking | If false, the reconnection strategy runs in a separate, non-blocking thread.  
### Pooling Profile
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Max Active** |  Controls the maximum number of connections that can be borrowed from a session at one time. When set to a negative value, there is no limit to the number of components that may be active at one time. When maxActive is exceeded, the pool is said to be exhausted.  
Controls the maximum number of connections that can sit idle in the pool at any time. When set to a negative value, there is no limit to the number of connections that may be idle at one time.  
Specifies the number of milliseconds to wait for a pooled component to become available when the pool is exhausted and the exhaustedAction is set to `WHEN_EXHAUSTED_WAIT`.  
**Min Eviction Millis** |  Determines the minimum amount of time an object may 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.  
**Eviction Check Interval Millis** |  Specifies the number of milliseconds between runs of the object evictor. When non-positive, no object evictor is executed.  
**Exhausted Action** |  Enumeration, one of:
  * WHEN_EXHAUSTED_GROW
  * WHEN_EXHAUSTED_WAIT
  * WHEN_EXHAUSTED_FAIL
|  Specifies the behavior of the Mule component pool when the pool is exhausted. Possible values are:
  * `WHEN_EXHAUSTED_FAIL` Will throw a NoSuchElementException
  * `WHEN_EXHAUSTED_WAIT` Will block by invoking Object.wait(long) until a new or idle object is available
  * `WHEN_EXHAUSTED_GROW` Will create a new Mule instance and return it, essentially making maxActive meaningless. If a positive maxWait value is supplied, it will block for, at most, that many milliseconds, after which a `NoSuchElementException` is thrown. If maxThreadWait is a negative value, it is blocked indefinitely.

  
**Initialisation Policy** |  Enumeration, one of:
  * INITIALISE_NONE
  * INITIALISE_ONE
  * INITIALISE_ALL

|  Determines how components in a pool should be initialized. The possible values are:
  * `INITIALISE_NONE` Will not load any components into the pool on startup
  * `INITIALISE_ONE` Will load one initial component into the pool on startup
  * `INITIALISE_ALL` Will load all components in the pool on startup

  
Whether pooling should be disabled  
### Expiration Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Max Idle Time** |  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  
Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  A time unit that qualifies the maxIdleTime attribute  
### Ftp File Attributes
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Regular File**  
**Symbolic Link**  
### Matcher
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Timestamp Since**  
**Timestamp Until**  
**Not Updated In The Last**  
**Updated In The Last**  
Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

  
**Case Sensitive** |  Enables you to configure an external file system matcher as case sensitive or insensitive  
**Filename Pattern**  
**Path Pattern**  
**Directories** |  Enumeration, one of:
  * REQUIRE
  * INCLUDE
  * EXCLUDE

  
**Regular Files** |  Enumeration, one of:
  * REQUIRE
  * INCLUDE
  * EXCLUDE

  
Enumeration, one of:
  * REQUIRE
  * INCLUDE
  * EXCLUDE

  
### Repeatable In Memory Stream
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Initial Buffer Size** |  The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.  
**Buffer Size Increment** |  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, meaning that a `STREAM_MAXIMUM_SIZE_EXCEEDED` error is raised when the buffer gets full.  
**Max Buffer Size** |  The maximum amount of memory to use. If more than that is used then a `STREAM_MAXIMUM_SIZE_EXCEEDED` error is raised. A value lower than or equal to zero means no limit.  
**Buffer Unit** |  Enumeration, one of: |  The unit in which all these attributes are expressed  
### Repeatable File Store Stream
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**In Memory Size** |  Defines the maximum memory the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.  
**Buffer Unit** |  Enumeration, one of: |  The unit in which maxInMemorySize is expressed  
### Redelivery Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Max Redelivery Count** |  The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message  
**Use Secure Hash** |  Whether to use a secure hash algorithm to identify a redelivered message.  
**Message Digest Algorithm** |  The secure hashing algorithm to use. If not set, the default is `SHA-256`.  
**Id Expression** |  Defines one or more expressions to use to determine when a message has been redelivered. This property can be set only if useSecureHash is `false`.  
**Object Store** |  Object Store |  The object store where the redelivery counter for each message is stored.  
### Repeatable In Memory Iterable
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Initial Buffer Size** |  The amount of instances that is initially be allowed to be kept in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.  
**Buffer Size Increment** |  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, meaning that a `STREAM_MAXIMUM_SIZE_EXCEEDED` error is raised when the buffer gets full. Default value is 100 instances.  
**Max Buffer Size** |  The maximum amount of memory to use. If more than that is used then a `STREAM_MAXIMUM_SIZE_EXCEEDED` error is raised. A value lower than or equal to zero means no limit.  
### Repeatable File Store Iterable
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**In Memory Objects** |  The maximum amount of instances to keep in memory. If more than this is required, then content starts to buffer on the disk.  
**Buffer Unit** |  Enumeration, one of: |  The unit in which maxInMemorySize is expressed  
### FTPS Explicit Mode
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Prot Setting** |  Enumeration, one of:
  * CLEAR
  * PRIVATE

  
### Prot Setting Exporter Sub Type
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Prot Setting** |  Enumeration, one of:
  * CLEAR
  * PRIVATE

  
### HTTP Tunnel Proxy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The FTP proxy server host, such as www.mulesoft.com, localhost, or 192.168.0.1, etc.  
Port number of the FTP proxy server to connect.  
Username | Username for the FTP proxy server. Required if the proxy server is authenticated.  
Password | Password for the FTP proxy server. Required if the proxy server is authenticated.  
### HTTPS Tunnel Proxy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Tls Context Factory  
The FTP proxy server host, such as www.mulesoft.com, localhost, or 192.168.0.1, etc.  
Port number of the FTP proxy server to connect.  
Username | Username for the FTP proxy server. Required if the proxy server is authenticated.  
Password | Password for the FTP proxy server. Required if the Proxy server is authenticated.  
## See Also
  * FTPS Connector Release Notes
  * MuleSoft Help Center