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

Frends.SFTP.ListFiles / 3.0.0

Source code

Summary

Lists what is on an SFTP server, optionally recursing, and can distinguish files from directories.

Typical use — checking whether a partner has delivered anything before committing to a transfer

Details

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

Source transfer options

Name Type Default Example Description
Directory String / /directory/test/

Directory on the server.

FileMask String – *.txt

Pattern to match (Optional).

IncludeType IncludeType File IncludeType.File

Types to include in the directory listing.

Possible values:

  • File: Types to include in the directory listing.

  • Directory: Types to include in the directory listing.

  • Both: Types to include in the directory listing.

IncludeSubdirectories Boolean – true

Include subdirectories?

FileEncoding FileEncoding ANSI FileEncoding.ANSI

Encoding for the file names. By selecting 'Other' you can use any encoding.

Possible values:

  • UTF8: Encoding for the file names. By selecting 'Other' you can use any encoding.

  • ANSI: Encoding for the file names. By selecting 'Other' you can use any encoding.

  • ASCII: Encoding for the file names. By selecting 'Other' you can use any encoding.

  • WINDOWS1252: Encoding for the 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 🗙