Fortinet black logo

CLI Reference

report mailbox

report mailbox

Note that this command is only available when mailbox-service is enabled under system global.

Use this command to configure mailbox report schedules.

The mailbox service feature is license based. This command is only available with a valid purchased advanced management license from FortiGuard.

Syntax

config report mailbox

edit <report_name>

set domains <domain_str>

set mailbox-list {enable | disable}

set period {last_month | this_month | today | yesterday}

set recipients <email_addr_str>

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

set schedule-hour <hour_int>

set schedule-weekdays {friday | monday | saturday | sunday | thursday | tuesday | wednesday}

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

end

Variable

Description

Default

<report_name>

Enter the name of the mailbox report schedule.

domains <domain_str> List of domains to be reported.

mailbox-list {enable | disable}

Enable to include mailbox lists in reports.

disable

period {last_month | this_month | today | 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, between 0 - 23. 12
schedule-weekdays {friday | monday | saturday | sunday | thursday | tuesday | wednesday}

Note: This option is only available when schedule-frequency is set to weekly.

Days of the week to generate the report.

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

Note: This option is only available when schedule-frequency is set to monthly.

Dates of the month to generate the report.

report mailbox

Note that this command is only available when mailbox-service is enabled under system global.

Use this command to configure mailbox report schedules.

The mailbox service feature is license based. This command is only available with a valid purchased advanced management license from FortiGuard.

Syntax

config report mailbox

edit <report_name>

set domains <domain_str>

set mailbox-list {enable | disable}

set period {last_month | this_month | today | yesterday}

set recipients <email_addr_str>

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

set schedule-hour <hour_int>

set schedule-weekdays {friday | monday | saturday | sunday | thursday | tuesday | wednesday}

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

end

Variable

Description

Default

<report_name>

Enter the name of the mailbox report schedule.

domains <domain_str> List of domains to be reported.

mailbox-list {enable | disable}

Enable to include mailbox lists in reports.

disable

period {last_month | this_month | today | 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, between 0 - 23. 12
schedule-weekdays {friday | monday | saturday | sunday | thursday | tuesday | wednesday}

Note: This option is only available when schedule-frequency is set to weekly.

Days of the week to generate the report.

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

Note: This option is only available when schedule-frequency is set to monthly.

Dates of the month to generate the report.