Fortinet white logo
Fortinet white logo

CLI Reference

cloud-api setting

cloud-api setting

Use this command to configure real-time scan settings.

Syntax

config cloud-api setting

set hide-email-on-arrival {enable | disable}

set notify-method {api | smtp}

set push-notification-url-base <url_str>

set realtime-scan-log {all | on-policy-match}

set realtime-scan-status {enable | disable}

set service-endpoint {china | germany | global | us-dod | us-gov}

set system-quarantine-release-original {enable | disable}

end

Variable

Description

Default

hide-email-on-arrival {enable | disable}

Enable or disable moving email to hidden folder on arrival for real-time scan.

When enabled, this feature helps to avoid users opening potentially dangerous email before the FortiMail unit has had the opportunity to scan the email, especially if the email contains large attachments. After the email is scanned and deemed safe, it is then removed from the hidden folder and placed into the user's mailbox.

Note: This option is only available for Microsoft 365.

disable

notify-method {api | smtp}

When FortiMail runs in Microsoft & Google API mode, customization of the header From: field in the notification email templates is not supported by default.

Use the following CLI command to change the behavior:

config cloud-api setting

set notify-method {api | smtp}

end

  • api: Default setting. Notifications will be sent by MS365 API. The customized email Subject will be applied but the header From: will be kept.

  • smtp: Notifications will be sent by FortiMail MTA (SMTP). Both the customized email Subject and header From: will be applied.

push-notification-url-base <url_str> Define the base URL to receive notifications.

realtime-scan-log {all | on-policy-match}

Enter a real-time scan log option. When set to on-policy-match, Microsoft 365 and Google Workspace History, Mail Event, Antivirus, and Antispam log entries will only be logged upon policy match.

on-policy-match

realtime-scan-status {enable | disable} Enable or disable real-time scans.

disable

service-endpoint {china | germany | global | us-dod | us-gov}

Enter the appropriate geographical Microsoft 365 or Google Workspace service endpoint.

global

system-quarantine-release-original {enable | disable}

Enable to release quarantined email in its original format from Microsoft 365 to the end user. If disabled, or if the email is released to other recipients, Microsoft 365 emails are released as notification emails with the original email attached as an EML file.

All the tenant, user, and message GUIDs are stored in the FortiMail system quarantine.

Note: This option is only available for Microsoft 365.

enable

Related topics

system disk-clear

cloud-api setting

cloud-api setting

Use this command to configure real-time scan settings.

Syntax

config cloud-api setting

set hide-email-on-arrival {enable | disable}

set notify-method {api | smtp}

set push-notification-url-base <url_str>

set realtime-scan-log {all | on-policy-match}

set realtime-scan-status {enable | disable}

set service-endpoint {china | germany | global | us-dod | us-gov}

set system-quarantine-release-original {enable | disable}

end

Variable

Description

Default

hide-email-on-arrival {enable | disable}

Enable or disable moving email to hidden folder on arrival for real-time scan.

When enabled, this feature helps to avoid users opening potentially dangerous email before the FortiMail unit has had the opportunity to scan the email, especially if the email contains large attachments. After the email is scanned and deemed safe, it is then removed from the hidden folder and placed into the user's mailbox.

Note: This option is only available for Microsoft 365.

disable

notify-method {api | smtp}

When FortiMail runs in Microsoft & Google API mode, customization of the header From: field in the notification email templates is not supported by default.

Use the following CLI command to change the behavior:

config cloud-api setting

set notify-method {api | smtp}

end

  • api: Default setting. Notifications will be sent by MS365 API. The customized email Subject will be applied but the header From: will be kept.

  • smtp: Notifications will be sent by FortiMail MTA (SMTP). Both the customized email Subject and header From: will be applied.

push-notification-url-base <url_str> Define the base URL to receive notifications.

realtime-scan-log {all | on-policy-match}

Enter a real-time scan log option. When set to on-policy-match, Microsoft 365 and Google Workspace History, Mail Event, Antivirus, and Antispam log entries will only be logged upon policy match.

on-policy-match

realtime-scan-status {enable | disable} Enable or disable real-time scans.

disable

service-endpoint {china | germany | global | us-dod | us-gov}

Enter the appropriate geographical Microsoft 365 or Google Workspace service endpoint.

global

system-quarantine-release-original {enable | disable}

Enable to release quarantined email in its original format from Microsoft 365 to the end user. If disabled, or if the email is released to other recipients, Microsoft 365 emails are released as notification emails with the original email attached as an EML file.

All the tenant, user, and message GUIDs are stored in the FortiMail system quarantine.

Note: This option is only available for Microsoft 365.

enable

Related topics

system disk-clear