NAME

pmx-reports-mailer-v2 - Runs scheduled reports and emails them to the specified email address


SYNOPSIS

 pmx-reports-mailer-v2 --report --custom --direction --subject --mailto


DESCRIPTION

The pmx-reports-mailer-v2 program generates reports and emails them to the specified email address. Run this as a scheduled job if you want to receive certain reports on a regular basis.


OPTIONS

--list|-l
Prints a list of available reports that can be emailed or run from the command line. Use the syntax displayed in this list when specifying a report with the --report or --custom option.

--mailto|-m
The email address the report(s) will be mailed to. You must specify at least one recipient.

--report|-r
The report to run and mail. A list of all report names can be generated with the --list option. You can specify multiple reports if you want to mail more than one. If no report is specified, the default MessageCategories is used. For example, to email the ``Top Spam Senders'' report to me@example.com, enter the following at the command line:
    pmx-reports-mailer-v2 --report TopSpamSenders --mailto me@example.com

--custom|-c
The custom report to run and mail. You can generate a list of all custom report titles with the --list option. You can specify multiple titles if you want to mail more than one. For example, to email the ``Custom Report Foo'' report to me@example.com, enter the following at the command line:
    pmx-reports-mailer-v2 --custom "Custom Report Foo"  --mailto me@example.com

--direction|-d
Specify the direction (inbound,outbound,or both) for the report data. By default, the data is given for both directions.

--start|-s
The start of the time frame that is reported on. This should be used along with the --end option described below. An end date must be specified if a start date is specified. You can also use the --time-frame option (described below) as an alternative to start and end. The command must include one of these two methods.

--end|-e
The end of the time frame being reported on. This must be used along with the option --start described above. A start date must be specified if an end date is specified. You can also use the --time-frame option (described below) as an alternative to start and/or end. The command must include one of these two methods.

--time-frame|-t
The time frame that is reported on. Values can be specified as any number of hours or days (e.g. 24h, 3d). The default is 24h. As an alternative method, use the --start and --end options described above. The command must include one of these two methods.

--subject|-j
The subject of the report. For example:
    Subject: Top Spam Senders

By default, the subject is pmx-reports-mailer-v2 $hostname, where $hostname is the name of the server from which the report originates.

--help/-h
Shows a summary of options.


COPYRIGHT

Copyright (C) 2000-2010 Sophos Group. All rights reserved. Sophos and PureMessage are trademarks of Sophos Plc and Sophos Group.