Fortinet white logo
Fortinet white logo

CLI Reference

cloud-api profile action

cloud-api profile action

Use this command to apply specific actions the unit takes when encountering an infected email. The actions applied on Microsoft 365 and Google Workspace are different from those applied on the FortiMail unit itself.

Syntax

config cloud-api profile action

edit <profile_name>

set final-action {discard | move | none | quarantine | quarantine-review}

set move-to-folder-name <string>

set notification-profile <profile-name>

set notification-status {enable | disable}

set replace-message <string>

set replace-status {enable | disable}

end

Variable

Description

Default

<name>

Enter the name of the action profile or create a new one.

final-action {discard | move | none | quarantine | quarantine-review}

Enter one of the following final actions to perform on infected emails:

  • discard: Move the email message from the user’s inbox to the Junk folder on Microsoft 365 or Google Workspace.
  • move: Move the email message from the user's inbox to a specified folder on Microsoft 365 or Google Workspace. See move-to-folder-name <string> .
  • none: No action is taken.
  • quarantine: Create a bulk folder for the user on Microsoft 365 or Google Workspace and move the email message from the user’s inbox to their Bulk folder.
  • quarantine: Send a copy to the FortiMail system quarantine folder and move the email message from the user’s inbox to the Deleted items folder in Microsoft 365 or Google Workspace.

move-to-folder-name <string>

Enter the name of the folder that the email messages should be moved to. Only applicable when final-action is set to move.

notification-profile <profile-name>

Enter to send out notifications to the recipients specified in the notification profile.

notification-status {enable | disable}

Enable or disable the notification.

disable

replace-message <string>

Enter the name of the custom message for content replacement.

default

replace-status {enable | disable}

Enable or disable the content replacement.

disable

cloud-api profile action

cloud-api profile action

Use this command to apply specific actions the unit takes when encountering an infected email. The actions applied on Microsoft 365 and Google Workspace are different from those applied on the FortiMail unit itself.

Syntax

config cloud-api profile action

edit <profile_name>

set final-action {discard | move | none | quarantine | quarantine-review}

set move-to-folder-name <string>

set notification-profile <profile-name>

set notification-status {enable | disable}

set replace-message <string>

set replace-status {enable | disable}

end

Variable

Description

Default

<name>

Enter the name of the action profile or create a new one.

final-action {discard | move | none | quarantine | quarantine-review}

Enter one of the following final actions to perform on infected emails:

  • discard: Move the email message from the user’s inbox to the Junk folder on Microsoft 365 or Google Workspace.
  • move: Move the email message from the user's inbox to a specified folder on Microsoft 365 or Google Workspace. See move-to-folder-name <string> .
  • none: No action is taken.
  • quarantine: Create a bulk folder for the user on Microsoft 365 or Google Workspace and move the email message from the user’s inbox to their Bulk folder.
  • quarantine: Send a copy to the FortiMail system quarantine folder and move the email message from the user’s inbox to the Deleted items folder in Microsoft 365 or Google Workspace.

move-to-folder-name <string>

Enter the name of the folder that the email messages should be moved to. Only applicable when final-action is set to move.

notification-profile <profile-name>

Enter to send out notifications to the recipients specified in the notification profile.

notification-status {enable | disable}

Enable or disable the notification.

disable

replace-message <string>

Enter the name of the custom message for content replacement.

default

replace-status {enable | disable}

Enable or disable the content replacement.

disable