Client Documentation

Start Page 3. Configuration instructions 3.11. Obsolete options

3.11. Obsolete options

This page contains the list of configuration options which are no longer supported in latest versions of SFTPPlus Client.

3.11.1. HTTP/HTTPS specific options

3.11.1.1. auth

Optional:

No [4]

Default value:

None

Values:
  • ‘–anyauth’ - Tells curl to figure out authentication method itself, and use the most secure one the remote site claims to support. This is done by first doing a request and checking the response-headers, thus possibly inducing an extra network round-trip.
  • ‘–basic’
  • ‘–digest’
  • ‘–ntlm’
  • ‘–negotiate’
From version:

1.5.1

To version:

1.5.2

Description:

HTTP authentication method.

3.11.2. SMTP transfer specific options

3.11.2.1. user

Optional:

No

Default value:

None

Values:
  • Username as text.
From version:

1.5.1

To version:

1.5.2

Description:

Email address where files are sent

3.11.2.2. customemail

Optional:

No

Default value:

None

Values:
  • Path to custom email template.
From version:

1.5.1

To version:

1.5.2

Description:

The following placeholders are available :

  • %DATE% - replaced with transfer date
  • %TIME% - replaced with transfer time
  • %FILE% - replaced with transfer filename
  • %MD5SUM - replaced with transfer MD5 checksum
  • %SIZE% - replaced with file size

3.11.2.3. emailsubject

Optional:

No

Default value:

None

Values:
  • Subject of the email message.
From version:

1.5.1

To version:

1.5.2

Description:

The following placeholders are available:

  • %MSG% - log message text
  • %HELP% - log message id

3.11.2.4. emailbody

Optional:

No

Default value:

None

Values:
  • Body of the email message.
From version:

1.5.1

To version:

1.5.2

Description:

The following placeholders are available:

  • %MSG% - log message text
  • %HELP% - log message id

3.11.3. Email notification options

3.11.3.1. notifysuccess

Optional:

Yes

Default value:

‘n’

Values:
  • ‘n’
  • ‘y’
From version:

1.5.1

To version:

1.5.2

Description:

Set to ‘y’ to configure SFTPPlus Client to send emails on successful transfers.

3.11.3.2. smtpaddress

Optional:

No [2]

Default value:

None

Values:
  • Email address as text.
From version:

1.5.1

To version:

1.5.2

Description:

Email address for notifications to be sent to.

3.11.4. Response file options

3.11.4.1. response

Optional:

Yes

Default value:

‘n’

Values:
  • ‘n’
  • ‘y’
From version:

1.5.1

To version:

1.5.2

Description:

To enable a response file to be collected.

3.11.4.2. responseroot

Optional:No
Default value:n/a
Values:Path to folder on the remote server.
From version:1.5.1
To version:1.5.2
Description:Response file inbox folder.

3.11.4.3. responsein

Optional:No
Default value:None
Values:Path to file on the remote server.
From version:1.5.1
To version:1.5.2
Description:Filename of the file to be retrieved.

3.11.4.4. responsedir

Optional:

No

Default value:

None

Values:
  • Path to folder on remote server.
From version:

1.5.1

To version:

1.5.2

Description:

Directory file will be retrieved from.

3.11.4.5. responsetimestamp

Optional:

Yes

Default value:

‘y’

Values:
  • ‘n’
  • ‘y’
From version:

1.5.1

To version:

1.5.2

Description:

Include timestamps in response.

3.11.4.6. postprocessresponsesuccess

Optional:

Yes

Default value:

None

Values:
  • Path to a executable or script.
From version:

1.5.1

To version:

None

Description:

Command to run if a response ‘get’ succeeds.

3.11.4.7. postprocessresponsefail

Optional:

Yes

Default value:

None

Values:
  • Path to a executable or script.
From version:

1.5.1

To version:

None

Description:

Command to run if a responde ‘get’ fails.

3.11.4.8. initialwait

Optional:

Yes

Default value:

‘30’

Values:
  • Number of seconds.
From version:

1.5.1

To version:

None

Description:

Seconds to wait before checking for response file

[2]Required if notifysuccess = ‘y’.
[4]Mandatory for HTTP and HTTPS transfers that do require authentication.