report mail
Use this command to configure report profiles that define what information will appear in generated reports.
In addition to log files, FortiMail units require a report profile to be able to generate a report. A report profile is a group of settings that contains the report name, file format, subject matter, and other aspects that the FortiMail unit considers when generating the report.
Syntax
config report mail
edit <profile_name>
[set comment "<comment_str>"]
set scope {cloud-api | default}
set period-relative-value <n_int>
set period-absolute-from <start_str>
set period-absolute-to <end_str>
set direction {all | incoming | outgoing | unknown}
set dest-ip-type {ip-group | ip-mask}
set dest-ip-mask <destination_ipv4/mask>
set dest-ip-group <group_name>
set sender-domains {<domain_str>...}
set schedule {daily | dates | none | weekdays}
set schedule-dates {1 2 ... 30 31}
set schedule-weekdays {Monday Tuesday Wednesday Thursday Friday Saturday Sunday}
set recipients <recipient_email>
end
|
Variable |
Description |
Default |
|
Enter a name for the profile. Do not include spaces. |
|
|
|
Enter a description or comment. |
|
|
|
Select which IP group to use. |
|
|
|
Enter the destination IP address and network mask of SMTP sessions that will be included in the report. |
0.0.0.0/0 |
|
|
Select how you want to define the destination address of SMTP sessions that will be included in the report. Then also configure dest-ip-mask <destination_ipv4/mask> or dest-ip-group <group_name>. |
ip-mask |
|
|
Select the direction of email to include in the report, relative to protected domains:
|
all |
|
|
Enter a list of zero or more recipient domains. An empty list matches all recipient domains. |
all |
|
|
Select the file format of the generated report. |
|
|
|
Enter the beginning of the time range in the format For example, entering |
|
|
|
Enter the end of the time range in the format For example, entering |
|
|
|
period-relative {last-N-days | last-N-hours | last-N-weeks | last-month | last-quarter | last-week | this-month | this-quarter | this-week | this-year | today | yesterday} |
Select the time range of log messages to use. Days are 24 hours. Weeks are 7 days. Months are 30 days. Quarters are 3 months. Time periods adjust, however, due to leap year, shorter or longer months, and daylight saving time (DST). Time is relative to the current FortiMail system clock. See system time ntp. Enter the time span of log messages from which to generate the report. If you entered |
yesterday |
|
If you entered Note: Because days are defined as 24 hours, If you want only 7 dates, then instead select |
0 |
|
|
Enter the name of a query whose result you want to include in the report, such as To display a list of available query names, enter a question mark ( Endpoint queries are available only if |
|
|
|
Enter a list of email addresses, if any, that will receive a copy of the generated report. Separate each recipient with a comma ( , ). |
|
|
|
Select when to automatically generate the report:
|
none |
|
|
Select which dates of the month to generate the report. |
|
|
|
Select which hour of the day, according to a 24-hour clock, to generate the report. For example, to generate reports at 5 PM, you would enter |
1 |
|
|
schedule-weekdays {Monday Tuesday Wednesday Thursday Friday Saturday Sunday} |
Select which days to generate the reports. |
|
|
Select whether or not to use data from the Google or Microsoft API. |
default |
|
|
Enter a list of zero or more sender domains. An empty list matches all sender domains. |
|