4.7. Resources¶

SFTPPlus can interact with various external resources in order to execute related operations, such as sending emails on errors.

The same resource can be shared for different server operations. For example you can use the same email client to send email for both critical errors or to inform about a normal operation.

When a component inside the SFTPPlus requires a resource, and the resource is not already started, that resource is automatically started.

4.7.1. Adding a new resource¶

Adding a new resource configuration is done by creating a new section inside the configuration file. The name of the section should be prefixed with resources/ and followed by the resource’s UUID.

The resource’s UUID can be any unique string used to identify the resource. Once defined, the UUID should not be changed.

For more information about UUIDs see the dedicated UUID documentation.

For example, to add a new resource configuration for an SMTP client called Client for staging SMTP server

[resource/a904e3a6-a59b-4bbf-8abd-edcae4d3324f]
name = Client for staging SMTP server
description = Send email using the staging SMTP server.
type = email-client
address = 10.0.4.35
port = 25

4.7.2. Generic resource options¶

While additional options are available (depending on the resource type), each resource configuration section has the following standard configuration options:

4.7.2.1. name¶

Default value:	‘’
Optional:	No
From version:	3.4.0
Values:	Any text.
Description:	Human-readable short string used to identify this resource.

4.7.2.2. description¶

Default value:	‘’
Optional:	Yes
From version:	3.4.0
Values:	Any text.
Description:	Human-readable text that describes the purpose of this resource.

4.7.2.3. type¶

Default value:	‘’
Optional:	No
From version:	3.4.0
Values:	email-client - Email client configuration.
Description:	This option specifies the type of the resource.

4.7.3. Email Client¶

An email-client is configured to allow SFTPPlus to send emails as an SMTP client via a remote SMTP server.

You will need to specify the address or the fully qualified domain name of the SMTP server to use and the value to be used by this client for the From field.

4.7.3.1. address¶

Default value:	127.0.0.1
Optional:	No
From version:	3.4.0
Values:	An IP address or a host name.
Description:	This option specifies the IP address or the host name of the remote server.

4.7.3.2. port¶

Default value:	25
Optional:	No
From version:	3.4.0
Values:	A port number for the server.
Description:	This option specifies the IP port of the remote server.

4.7.3.3. username¶

Optional:	Yes
Default value:	‘’
Values:	User name.
From version:	3.4.0
Description:	User name used to connect to the server.

4.7.3.4. password¶

Optional:	Yes
Default value:	‘’
Values:	Plain text password.
From version:	3.4.0
Description:	Password used to connect to the server.

4.7.3.5. email_from_address¶

Optional:	No
Default value:	'no-reply@sftpplus.example.com‘
Values:	email address
From version:	3.4.0
Description:	Email address used in the From field of messages sent from this server.

SFTPPlus Documentation