Fortinet Document Library

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

CLI Reference

archive account

Use this command to configure email archiving accounts.

This command applies only if email archiving is enabled.

Syntax

config archive account

edit <account_name>

set destination {local | remote}

set forward-address <recipient_email>

set imap-access {enable | disable}

set index-type {full | header |none}

set local-quota <quota_int>

set local-quota-cache <cache_int>

set password <password_str>

set quota-full {overwrite | noarchive}

set remote-directory <path_str>

set remote-ip <ftp_ipv4>

set remote-password <password_Str>

set remote-protocol {ftp | sftp}

set remote-username <user_str>

set retention-period <time_int>

set rotation-hour <hour_int>

set rotation-size <size_int>

set rotation-time <time_int>

set status {enable | disable}

end

Variable

Description

Default

<account_name>

Enter the email archiving account name.

archive

destination {local | remote}

Select whether to archive to the local disk or remote server.

local

forward-address <recipient_email>

Enter the email address to which all archived messages will also be forwarded.

If no forwarding address exists, the FortiMail unit will not forward email when it archives it.

imap-access {enable | disable}

Enable/disable IMAP access to the archive account.

disable

index-type {full | header |none}

Type full to index email by the whole email (header and body), and header by the email header only.

none

local-quota <quota_int>

Enter the local disk quota for email archiving in gigabytes (GB).

The valid range depends on the amount of free disk space.

5

local-quota-cache <cache_int>

Enter the local disk quota for caching in gigabytes (GB).

The valid range depends on the amount of free disk space.

5

password <password_str>

Enter the archiving account’s password.

forti12356net

quota-full {overwrite | noarchive}

Enter either:

noarchive: Discard the email message if the hard disk space is consumed and a new email message arrives.

overwrite: Replace the oldest email message if the hard disk space is consumed and a new email message arrives.

overwrite

remote-directory <path_str>

Enter the directory path on the remote server where email archives will be stored.

remote-ip <ftp_ipv4>

Enter the IP address of the remote server that will store email archives.

0.0.0.0

remote-password <password_Str>

Enter the password of the user account on the remote server.

 

remote-protocol {ftp | sftp}

Enter either ftp or sftp to use that protocol when transferring email archives to the remote server.

sftp

remote-username <user_str>

Enter the name of a user account on the remote server.

retention-period <time_int>

Enter the maximum age in days that rotated archive folders are kept before they are removed.

The valid range is from 0 to 3650 days. The default value of 0 means no archive folders will be removed.

0

rotation-hour <hour_int>

Enter the hour of the day to start the mailbox rotation. See rotation-time <time_int>.

0

rotation-size <size_int>

Enter the maximum size of the current email archiving mailbox in megabytes (MB).

When the email archiving mailbox reaches either the maximum size or age, the email archiving mailbox is rolled (that is, the current email archiving mailbox is saved to a file with a new name, and a new email archiving mailbox is started).

The valid range is from 10 to 200 MB.

100

rotation-time <time_int>

Enter the maximum age of the current email archiving mailbox in days.

When the email archiving mailbox reaches either the maximum size or age, the email archiving mailbox is rolled (that is, the current email archiving mailbox is saved to a file with a new name, and a new email archiving mailbox is started).

The valid range is from 1 to 365 days.

See rotation-hour <hour_int>

7

status {enable | disable}

Enable to activate email archiving.

disable

Related topics

archive exempt-policy

archive journal

archive account

Use this command to configure email archiving accounts.

This command applies only if email archiving is enabled.

Syntax

config archive account

edit <account_name>

set destination {local | remote}

set forward-address <recipient_email>

set imap-access {enable | disable}

set index-type {full | header |none}

set local-quota <quota_int>

set local-quota-cache <cache_int>

set password <password_str>

set quota-full {overwrite | noarchive}

set remote-directory <path_str>

set remote-ip <ftp_ipv4>

set remote-password <password_Str>

set remote-protocol {ftp | sftp}

set remote-username <user_str>

set retention-period <time_int>

set rotation-hour <hour_int>

set rotation-size <size_int>

set rotation-time <time_int>

set status {enable | disable}

end

Variable

Description

Default

<account_name>

Enter the email archiving account name.

archive

destination {local | remote}

Select whether to archive to the local disk or remote server.

local

forward-address <recipient_email>

Enter the email address to which all archived messages will also be forwarded.

If no forwarding address exists, the FortiMail unit will not forward email when it archives it.

imap-access {enable | disable}

Enable/disable IMAP access to the archive account.

disable

index-type {full | header |none}

Type full to index email by the whole email (header and body), and header by the email header only.

none

local-quota <quota_int>

Enter the local disk quota for email archiving in gigabytes (GB).

The valid range depends on the amount of free disk space.

5

local-quota-cache <cache_int>

Enter the local disk quota for caching in gigabytes (GB).

The valid range depends on the amount of free disk space.

5

password <password_str>

Enter the archiving account’s password.

forti12356net

quota-full {overwrite | noarchive}

Enter either:

noarchive: Discard the email message if the hard disk space is consumed and a new email message arrives.

overwrite: Replace the oldest email message if the hard disk space is consumed and a new email message arrives.

overwrite

remote-directory <path_str>

Enter the directory path on the remote server where email archives will be stored.

remote-ip <ftp_ipv4>

Enter the IP address of the remote server that will store email archives.

0.0.0.0

remote-password <password_Str>

Enter the password of the user account on the remote server.

 

remote-protocol {ftp | sftp}

Enter either ftp or sftp to use that protocol when transferring email archives to the remote server.

sftp

remote-username <user_str>

Enter the name of a user account on the remote server.

retention-period <time_int>

Enter the maximum age in days that rotated archive folders are kept before they are removed.

The valid range is from 0 to 3650 days. The default value of 0 means no archive folders will be removed.

0

rotation-hour <hour_int>

Enter the hour of the day to start the mailbox rotation. See rotation-time <time_int>.

0

rotation-size <size_int>

Enter the maximum size of the current email archiving mailbox in megabytes (MB).

When the email archiving mailbox reaches either the maximum size or age, the email archiving mailbox is rolled (that is, the current email archiving mailbox is saved to a file with a new name, and a new email archiving mailbox is started).

The valid range is from 10 to 200 MB.

100

rotation-time <time_int>

Enter the maximum age of the current email archiving mailbox in days.

When the email archiving mailbox reaches either the maximum size or age, the email archiving mailbox is rolled (that is, the current email archiving mailbox is saved to a file with a new name, and a new email archiving mailbox is started).

The valid range is from 1 to 365 days.

See rotation-hour <hour_int>

7

status {enable | disable}

Enable to activate email archiving.

disable

Related topics

archive exempt-policy

archive journal