Fortinet black logo

CLI Reference

archive policy

archive policy

Use this command to configure email archiving policies.

This command applies only if email archiving is enabled.

Syntax

config archive policy

edit <policy_id>

set account <account_name>

set pattern <string>

set status {enable | disable}

set type {attachment | body | deferral | recipient | sender | subject}

set deferral-reason {spam-outbreak virus-outbreak sandbox}

end

Variable

Description

Default

<policy_id>

Enter the index number of the policy.

To view a list of existing entries, enter a question mark ( ? ).

account <account_name>

Enter the name of the email archive account where you want to archive email.

pattern <string>

Enter a pattern, such as user*@example.com, that matches the attachment file name, text in the email body, text in the email subject, sender or recipient email addresses to which this policy will apply.

*

status {enable | disable}

Enable to activate the email archiving policy.

enable

type {attachment | body | deferral | recipient | sender | subject}

Enter one of the following match types:

  • attachment: The attachment file name will be evaluated for matches with pattern.

  • body: The body text will be evaluated for matches with pattern.

  • deferral: The archive policy will be evaluated for matches with deferral-reason.

  • recipient: The recipient email address will be evaluated for matches with pattern.

  • sender: The sender email address will be evaluated for matches with pattern.

  • subject: The email subject will be evaluated for matches with pattern.

sender

deferral-reason {spam-outbreak virus-outbreak sandbox}

Note that this option is only available when type is set to deferral.

Enter one or more of the following reasons for deferring emails for analysis:

  • fortisandbox: Defer email for sandbox scanning.

  • spam-outbreak: Defer email for spam outbreak.

  • virus-outbreak: Defer email for virus outbreak.

Related topics

archive exempt-policy

antispam url-fgas-exempt-list

archive policy

Use this command to configure email archiving policies.

This command applies only if email archiving is enabled.

Syntax

config archive policy

edit <policy_id>

set account <account_name>

set pattern <string>

set status {enable | disable}

set type {attachment | body | deferral | recipient | sender | subject}

set deferral-reason {spam-outbreak virus-outbreak sandbox}

end

Variable

Description

Default

<policy_id>

Enter the index number of the policy.

To view a list of existing entries, enter a question mark ( ? ).

account <account_name>

Enter the name of the email archive account where you want to archive email.

pattern <string>

Enter a pattern, such as user*@example.com, that matches the attachment file name, text in the email body, text in the email subject, sender or recipient email addresses to which this policy will apply.

*

status {enable | disable}

Enable to activate the email archiving policy.

enable

type {attachment | body | deferral | recipient | sender | subject}

Enter one of the following match types:

  • attachment: The attachment file name will be evaluated for matches with pattern.

  • body: The body text will be evaluated for matches with pattern.

  • deferral: The archive policy will be evaluated for matches with deferral-reason.

  • recipient: The recipient email address will be evaluated for matches with pattern.

  • sender: The sender email address will be evaluated for matches with pattern.

  • subject: The email subject will be evaluated for matches with pattern.

sender

deferral-reason {spam-outbreak virus-outbreak sandbox}

Note that this option is only available when type is set to deferral.

Enter one or more of the following reasons for deferring emails for analysis:

  • fortisandbox: Defer email for sandbox scanning.

  • spam-outbreak: Defer email for spam outbreak.

  • virus-outbreak: Defer email for virus outbreak.

Related topics

archive exempt-policy

antispam url-fgas-exempt-list