Tasks Templates Frends Portal
Task Changelog Feedback & Roadmap Schedule a demo Help
SFTP

Frends.SFTP.DeleteFiles / 3.0.0

Source code

Summary

Deletes files from an SFTP server, chosen by pattern within a directory or by explicit paths, and reports what went.

Typical use — cleaning up a partner's drop directory after collecting from it

Details

Frends version
5.5 and newer
Agent
Crossplatform
Target framework
net6.0

Input parameters.

Name Type Default Example Description
Directory String / /destination

Full path of the target file to be deleted.

FileMask String – *.txt

Pattern to match (Optional).

FilePaths Object – #trigger.data.filePaths

The paths to the files to be deleted, mainly meant to be used with the file trigger with the syntax: #trigger.data.filePaths

FileEncoding FileEncoding ANSI FileEncoding.ANSI

If set, this ecoding will be used to encode and decode command parameters and server responses, such as file names. By selecting 'Other' you can use any encoding.

Possible values:

  • UTF8: If set, this ecoding will be used to encode and decode command parameters and server responses, such as file names. By selecting 'Other' you can use any encoding.

  • ANSI: If set, this ecoding will be used to encode and decode command parameters and server responses, such as file names. By selecting 'Other' you can use any encoding.

  • ASCII: If set, this ecoding will be used to encode and decode command parameters and server responses, such as file names. By selecting 'Other' you can use any encoding.

  • WINDOWS1252: If set, this ecoding will be used to encode and decode command parameters and server responses, such as file names. By selecting 'Other' you can use any encoding.

  • Unicode: If set, this ecoding will be used to encode and decode command parameters and server responses, such as file names. By selecting 'Other' you can use any encoding.

  • Other: Other enables users to add other encoding options as string.

EnableBom Boolean False true

Additional option for UTF-8 encoding to enable bom.

EncodingInString String – utf-8

File encoding to be used. Encoding don't support any unicode encoding. It only support the code page encodings. A partial list of possible encodings: https://en.wikipedia.org/wiki/Windows_code_page#List.

An unhandled error has occurred. Reload 🗙