6.14.1. Introduction¶

This page covers the SFTPPlus configuration options for connecting to an Exchange Online mailbox.

In order for SFTPPlus to be able to connect to Exchange Online, SFTPPlus needs to be registered as an application on Entra ID and given permissions to read or write emails.

Check the registering SFTPPlus application for Exchange Online documentation, to find out more about how to configure Entra ID.

6.14.2. name¶

Default value:

Empty

Optional:

No

From version:

2.8.0

Values:

• Any text.

Description:

Human-readable short text used to identify this location.

6.14.3. description¶

Default value:

Empty

Optional:

Yes

From version:

2.8.0

Values:

• Any text.

Description:

Human-readable text that describes the purpose of this location.

6.14.4. type¶

Default value:

''

Optional:

No

From version:

2.6.0

Values:

• filesystem - Local file system.

• sftp - SFTP protocol v3 over SSH v2.

• ftp - FTP protocol without any encryption.

• ftpse - Explicit FTPS protocol.

• ftpsi - Implicit FTPS protocol.

• webdavs - WebDAV over HTTPS.

• as2 - AS2 over HTTP or HTTPS

• azure-file - Azure File Service.

• smb - SMB / Windows Share

Description:

This option specifies the type of the location. Each type has a set of specific configuration options

6.14.5. idle_connection_timeout¶

Default value:

300

Optional:

Yes

From version:

3.0.0

Values:

• Number of seconds

• 0

Description:

This controls the automatic disconnection from the remote server after the location has not received any file transfer operation requests for the configured number of seconds.

Keep-alive command requests are not counted as file transfer operations. The connection gets automatically disconnected if keep-alive is the only command requested in the configured interval.

Disconnected locations automatically reconnect when a new file transfer operation request is made. For example, when a new file needs to be transferred to the remote server.

If the remote peer closes the connection before the configured timeout, the connection is left closed. It gets automatically reconnected when a new file transfer operation is requested.

Set to 0 to always keep the connection active, by forcing re-connection when the remote server closes the connection.

Note

The idle_connection_timeout is the maximum number of seconds before closing an idle connection to the server. If the remote server decides that the connection is idle and closes the connection, SFTPPlus doesn't try to "challenge" the server, leaving the connection closed. The connection is automatically reopened next time a file needs to be transferred.

6.14.6. idle_connection_keepalive_interval¶

Default value:

0

Optional:

Yes

From version:

3.0.0

Values:

• Number of seconds

Description:

Send a keep-alive command every N seconds to avoid having the connection disconnected by the other peer due to inactivity.

Set to 0 to disable keep-alive commands.

The keep-alive command does not reset the idle connection timeout,

6.14.7. connection_retry_count¶

Default value:

12

Optional:

Yes

From version:

3.9.0

Values:

• Number of retries

Description:

Number of times to retry connection to the location, when the initial connection fails.

Set to 0 to not retry.

6.14.8. connection_retry_interval¶

Default value:

300

Optional:

Yes

From version:

3.9.0

Values:

• Number of seconds

Description:

Number of seconds to wait between connection attempts.

Set to 0 to retry right away without any delay.

6.14.9. username¶

Default value:

Empty

Optional:

No

From version:

5.4.0

Values:

• Text.

Description:

Email address or account for which to check the emails on the remote server.

6.14.10. password¶

Default value:

Empty

Optional:

No

From version:

5.4.0

Values:

• OAuth2 client secret

Description:

This option specifies the OAuth2 client secret used to authenticate on the remote server. The client secret is created from the Entra ID portal, using the App Registration page.

6.14.11. directory_id¶

Default value:

Empty

Optional:

No

Values:

• Text

From version:

5.4.0

Description:

Directory (tenant) ID of the SFTPPlus inside the Entra ID. This value can be viewed after registering SFTPPlus in Entra ID via the App registrations page.

6.14.12. application_id¶

Default value:

Empty

Optional:

No

Values:

• Text

From version:

5.4.0

Description:

Application (client) ID of the SFTPPlus inside the Entra ID. This value is obtained after registering SFTPPlus in Entra ID via the App registrations page.