FTP Connector
Properties Configuration Settings
The FTP Connector adds SSL-enabled FTP send and receive capabilities to your MuleSoft.
Remarks
The FTP Connector adds a complete FTP client to your Mule Project that enables it with plaintext or SSL-secured file download and upload capability.
FTP Receive Connector
The FTP Receive Connector requires that a single property be set: FTPServer. You may also set an FTPPort if the server is not set to the default protocol port. If your FTP server requires authentication, you should set the User, Password and/or Account properties. If you wish to enable SSL, you can turn it on by setting an appropriate SSLCert and SSLStartMode as well as supplying an SSLAcceptServerCert.
The connector will connect to the FTP server every PollingInterval and list the directory specified by RemotePath. All files that match the FileMask will be downloaded and submitted to the Mule Project as individual messages. In order to guarantee that files are not downloaded multiple times, you may set the DeleteMode. If you wish to do any other PRE- or POST-GET operation, you can specify them as scripts through the BeforeGet and AfterGet properties, respectively.
FTP Send Connector
The FTP Send Connector requires both an FTPServer and a RemoteFile. If your server does not operate on the default FTP port, you will need to specify the correct port via FTPPort. For servers that do not allow anonymous uploads, you may also need to set User, Password, and/or Account. To enable SSL, you should select a client SSLCert and a SSLAcceptServerCert as well as an SSLStartMode.
The connector will connect to the FTP server whenever it has a message to send. The connector will attempt to upload to the specified RemotePath. In order to prevent parallel processing by another application before your upload is complete, you may need to set a temporary extension via TemporaryUploadExtension. If Overwrite is set to True, the connector will delete or overwrite remote files as necessary to complete the operation.
If you wish to do any other PRE- or POST-PUT operation, you can specify them as scripts through the BeforePut and AfterPut properties, respectively.
Receiver Property List
The following is the full list of the properties of the receiver connector with short descriptions. Click on the links for further details.
| Account | The user Account for login. |
| AfterConnect | A set of FTP commands to be executed immediately after connecting to the FTPServer . |
| AfterGet | A set of FTP commands to be executed after the GET. |
| BeforeGet | A set of FTP commands to be executed before the GET. |
| DeleteMode | Controls if and when the remote file is deleted after download. |
| FileMask | Indicates the type of files to download from the FTP server. |
| Firewall | A set of properties related to firewall access. |
| FTPPort | The port for the FTP service (default is 21). |
| FTPServer | The domain name or IP address of the FTP server. |
| LogFile | The file to write logging information to at runtime. |
| LogMode | What information gets logged during connector execution. |
| Other | Defines a set of configuration settings to be used by the connector. |
| Passive | Controls whether to direct the server into passive mode. Recommended if behind a firewall. |
| Password | The password for login. |
| PersistentConnection | Instructs the connector whether to keep the connection to the server open. |
| ReceivedFileDate | The date of the remote file received by the FTP connector. |
| ReceivedFileName | The name of the remote file received by the FTP connector. |
| ReceivedFilePath | The remote path of the file received by the FTP connector. |
| ReceivedFileSize | The size of the remote file received by the FTP connector. |
| ReceivedFileUser | The user name used by the FTP connector when downloading the remote file. |
| RemotePath | The current path in the FTP server. |
| SSLAcceptServerCert | Instructs the connector to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to use for client authentication during the SSL handshake. |
| SSLStartMode | Determines how the connector starts the SSL negotiation. |
| TempPath | A temporary local directory where data can be stored before the connector processes it. |
| Timeout | A timeout for the connector. |
| TransferMode | The transfer mode (ASCII or Binary). If the value is 0 (default), the initial server mode will be used. |
| User | The user id for login. |
| UseSimpleDirList | Instructs the connector to issue the NLST command instead of LIST. |
Sender Property List
The following is the full list of the properties of the sender connector with short descriptions. Click on the links for further details.
| Account | The user Account for login. |
| AfterConnect | A set of FTP commands to be executed immediately after connecting to the FTPServer . |
| AfterPut | A set of FTP commands to be executed after the PUT. |
| Append | Whether or not the connector should append data to the RemoteFile . |
| BeforePut | A set of FTP commands to be executed before the PUT. |
| Firewall | A set of properties related to firewall access. |
| FTPPort | The port for the FTP service (default is 21). |
| FTPServer | The domain name or IP address of the FTP server. |
| LogFile | The file to write logging information to at runtime. |
| LogMode | What information gets logged during connector execution. |
| Other | Defines a set of configuration settings to be used by the connector. |
| Overwrite | Whether or not the connector should overwrite files during transfer. |
| Passive | Controls whether to direct the server into passive mode. Recommended if behind a firewall. |
| Password | The password for login. |
| PersistentConnection | Instructs the connector whether to keep the connection to the server open. |
| RemoteFile | The name of the destination file on the FTP server for uploading. |
| RemotePath | The current path in the FTP server. |
| RemoteTempPath | A temporary directory on the server to store files before moving them to RemotePath . |
| SSLAcceptServerCert | Instructs the connector to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to use for client authentication during the SSL handshake. |
| SSLStartMode | Determines how the connector starts the SSL negotiation. |
| Timeout | A timeout for the connector. |
| TransferMode | The transfer mode (ASCII or Binary). If the value is 0 (default), the initial server mode will be used. |
| User | The user id for login. |
| UseSimpleDirList | Instructs the connector to issue the NLST command instead of LIST. |
Configuration Settings
The following is a list of configuration settings for the connector with short descriptions. Click on the links for further details.
| AutoSelectDataIP | Automatically select the data connection IP. |
| DownloadCacheFile | When set, only new files will be downloaded from the server. |
| DownloadCacheFileDuration | The number of minutes that a file name will remain in the download cache. |
| EnableFileDetailsComparison | Whether the receive connector should consider metadata differences when deciding whether to download a file again. |
| MaxFilesPerPollingInterval | The maximum number of files that will be downloaded from the server during a single poll. |
| CheckFileExists | Whether to check if the remote file exists before uploading. |
| PortRange | Allows the specification of a port range the connector listens to. |
| ReuseSSLSessionInDI | Whether the SSL session will be reused for the DI connection. |
| ReusePISSLSessionInDI | Whether the PI SSL session will be reused for the DI connection. |
| UseClearCommandChannel | Allows for the Clear Command Channel (CCC) command. |
| UseClearDataChannel | Allows for the PROT C command. |
| UseFSwitch | Specifies whether or not the -F parameter is used when listing directory contents. |
| UseMLSD | Uses listings for machine processing. |
| UseProtWhenImplicit | Sends PROT P to the server. |
| UseRemoteHostAddressForPassive | Instructs the connector to use the FTPServer in passive mode. |
| UseModeZ | Allows compression to be used when transferring data. |
| ModeZCompressionLevel | Used to specify the level of compression used. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLSecurityFlags | Flags that control certificate verification. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
| TLSNamedGroups | The supported (EC)DHE groups. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseInternalSecurityAPI | Tells the connector whether or not to use the system security libraries or an internal implementation. |
| PersistedConnectionTimeout | How long to leave a persisted connection alive. |