> For the complete documentation index, see [llms.txt](https://docs.frends.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.frends.com/tasks/tasks/ftp/writefile.md). # WriteFile Task version: 1.0.0 Required Frends version: 5.1+ Required .NET version: 6.0, standard2.0 Compatible Agents: Crossplatform, Legacy Source code: ## Task Parameters {% tabs %} {% tab title="Connection" %} | Name | Description | | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Address : `String` |

FTP(S) host address


Default: -
Example: my.ftp.server.com

| | Port : `Int32` |

Port number to use in the connection to the server.


Default: 21
Example: 21

| | UserName : `String` |

Username to use for authentication to the server. Note that the file endpoint only supports

username for remote shares and the username must be in the format DOMAIN\Username.


Default: -
Example: myUsername

| | 🗝Password : `String` |

Password to use in the authentication to the server.


Default: -
Example: myPassword

| | TransportType : `FtpTransportType` |

Type of transfer: 'Ascii' sends files as text and must only be used for sending ASCII text files. 'Binary' (default) sends files as raw data and should be used for sending e.g. UTF-encoded text files

Possible values:


Default: 0
Example: FtpTransportType.Binary

| | Mode : `FtpMode` |

Connection mode to use to connect to the FTP server

Possible values:


Default: 0
Example: FtpMode.Passive

| | KeepConnectionAliveInterval : `Int32` |

Sends NOOP command to keep connection alive at specified time-interval in seconds. If set to 0 the connection is not kept alive. Default value is 0


Default: 0
Example: 60

| | ConnectionTimeout : `Int32` |

The length of time, in seconds, until the connection times out. You can use value 0 to indicate that the connection does not time out. Default value is 60 seconds


Default: 60
Example: 60

| | Encoding : `String` |

If set, this encoding will be used to encode and decode command parameters and server responses, such as file names. Example values: utf-8, utf-16, windows-1252


Default: -
Example: utf-8

| | BufferSize : `Int32` |

Integer value of used buffer size as bytes.

Default value is 4 KB.


Default: 4096
Example: 4096

| | UseFTPS : `Boolean` |

Whether to use FTPS or not.


Default: False
Example: false

| | SecureDataChannel : `Boolean` |

Whether the data channel is secured or not.


Default: True
Example: true

| | SslMode : `FtpsSslMode` |

Specifies whether to use Explicit or Implicit SSL

Possible values:


Default: 0
Example: FtpsSslMode.None

| | EnableClientAuth : `Boolean` |

If enabled the client certificate is searched from user's certificate store


Default: False
Example: false

| | ValidateAnyCertificate : `Boolean` |

If enabled the any certificate will be considered valid.


Default: False
Example: false

| | ClientCertificatePath : `String` |

Path to client certificate (X509).


Default: -
Example: c:\example.cer

| | CertificateHashStringSHA1 : `String` |

Certificate SHA1 hash string to validate against.


Default: -
Example: D911262984DE9CC32A3518A1094CD24249EA5C49

| | {% endtab %} | | {% tab title="Input" %} | Name | Description | | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Path : `String` |

Full path for the file to be written.


Default: -
Example: / , /SubDir/test.txt

| | Content : `String` |

Text content to be written.


Default: -
Example: This is test file

| | CreateDestinationDirectories : `Boolean` |

Enables Task to create destination directories if they don't exist.


Default: False
Example: true

| | FileEncoding : `FileEncoding` |

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:

parameters and server responses, such as file names.

By selecting 'Other' you can use any encoding.

parameters and server responses, such as file names.

By selecting 'Other' you can use any encoding.

parameters and server responses, such as file names.

By selecting 'Other' you can use any encoding.

parameters and server responses, such as file names.

By selecting 'Other' you can use any encoding.

parameters and server responses, such as file names.

By selecting 'Other' you can use any encoding.


Default: 1
Example: FileEncoding.ANSI

| | EnableBom : `Boolean` |

Additional option for UTF-8 encoding to enable bom.


Default: False
Example: true

| | EncodingInString : `String` |

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: .


Default: -
Example: iso-8859-1

| | WriteBehaviour : `WriteOperation` |

How the file write should work if a file with the new name already exists.

Possible values:


Default: -
Example: WriteOperation.Append

| | AddNewLine : `Boolean` |

If enabled new line is added to the existing file before appending the content.


Default: False
Example: true

| | {% endtab %} | | | {% endtabs %} | | ## Task Result | Name | Description | | -------------------------- | --------------------------------------------------------------------------------------- | | Path : `String` |

Full path to the written file.
Example: /destination/newfile.txt

| | SizeInMegaBytes : `Double` |

Size of the new file in destination.
Example: 3.2

| ## Task Changelog Changelog for Task Frends.FTP.WriteFile. ### \[1.1.0] - 2024-08-23 #### Changed * Updated the Newtonsoft.Json package to version 13.0.3. ### \[1.0.0] - 2023-08-03 #### Added * Initial implementation --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.frends.com/tasks/tasks/ftp/writefile.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.