Fortinet white logo
Fortinet white logo

CLI Reference

report mailbox

report mailbox

Use this command to configure mailbox report schedules and other settings.

Once a report is generated, you can view the mailbox report in the FortiMail GUI. Alternatively, you can use diagnose system mailbox.

This command is available only if an advanced management feature license is installed on the FortiMail unit, and if mailbox-accounting-status {enable | disable} is enable.

Syntax

config report mailbox

edit <report_name>

set domains {<domain_name> ...}

set mailbox-list {enable | disable}

set period {last_month | this_month | yesterday}

set recipients <email_addr_str>

set schedule-frequency {daily | monthly | none | weekly}

set schedule-hour <hour_int>

set schedule-weekdays {Monday Tuesday Wednesday Thursday Friday Saturday Sunday}

set schedule-dates {1 2 ... 30 31}

end

Variable

Description

Default

<report_name>

Enter the name of the mailbox report schedule.

domains {<domain_name> ...} List of protected domains to include in the report.

mailbox-list {enable | disable}

Enable to include mailbox lists in reports.

disable

period {last_month | this_month | yesterday} Period of report coverage. today
recipients <email_addr_str> List of email recipients of the report.
schedule-frequency {daily | monthly | none | weekly} Frequency of the scheduled report. none
schedule-hour <hour_int> Hour of the day to generate the report. Valid range is 0 - 23. 12
schedule-weekdays {Monday Tuesday Wednesday Thursday Friday Saturday Sunday}

Days of the week to generate the report.

Note: This option is only available when schedule-frequency {daily | monthly | none | weekly} is weekly.

schedule-dates {1 2 ... 30 31}

Dates of the month to generate the report.

Note: This option is only available when schedule-frequency {daily | monthly | none | weekly} is monthly.

Related topics

system mailbox

system advanced-management

report mailbox

report mailbox

Use this command to configure mailbox report schedules and other settings.

Once a report is generated, you can view the mailbox report in the FortiMail GUI. Alternatively, you can use diagnose system mailbox.

This command is available only if an advanced management feature license is installed on the FortiMail unit, and if mailbox-accounting-status {enable | disable} is enable.

Syntax

config report mailbox

edit <report_name>

set domains {<domain_name> ...}

set mailbox-list {enable | disable}

set period {last_month | this_month | yesterday}

set recipients <email_addr_str>

set schedule-frequency {daily | monthly | none | weekly}

set schedule-hour <hour_int>

set schedule-weekdays {Monday Tuesday Wednesday Thursday Friday Saturday Sunday}

set schedule-dates {1 2 ... 30 31}

end

Variable

Description

Default

<report_name>

Enter the name of the mailbox report schedule.

domains {<domain_name> ...} List of protected domains to include in the report.

mailbox-list {enable | disable}

Enable to include mailbox lists in reports.

disable

period {last_month | this_month | yesterday} Period of report coverage. today
recipients <email_addr_str> List of email recipients of the report.
schedule-frequency {daily | monthly | none | weekly} Frequency of the scheduled report. none
schedule-hour <hour_int> Hour of the day to generate the report. Valid range is 0 - 23. 12
schedule-weekdays {Monday Tuesday Wednesday Thursday Friday Saturday Sunday}

Days of the week to generate the report.

Note: This option is only available when schedule-frequency {daily | monthly | none | weekly} is weekly.

schedule-dates {1 2 ... 30 31}

Dates of the month to generate the report.

Note: This option is only available when schedule-frequency {daily | monthly | none | weekly} is monthly.

Related topics

system mailbox

system advanced-management