Email Notification Service Command Line

From cqwiki
Jump to navigationJump to search

Email Notification Package Delivery Service Command Line

Usage: cqemail [options] command

Command Description
once Query databases for eligible email messages, attempt delivery, and exit. It was a default behavior of the Email Delivery Script.
run Run delivery attempts on defined schedule. Default schedule is to make delivery attempt every five minutes with 0 second offset from the beginning on the hour. It can be overridden by setting "interval" and "offset" parameters in the configuration file, or by correspondent command line options.
save-options Save options given as command line parameters in the configuration file.
encrypt-passwords Encrypt clear text password in the configuration file. All passwords in the configuration file must be in clear-text before running this command. It does not check if the password already encrypted or not.
configure Run configuration graphical user interface.

Option Description
-h, --help Print help message.
-V, --version Print version information.
-C, --config <file> Use an alternative configuration file given as <file>. Default configuration file name is config/config.xml.
-u, --login <login> ClearQuest login name. Overrides login name provided in the configuration file.
-p, --password <password> ClearQuest password. Overrides user password specified in the configuration file.
-db, --database <database> ClearQuest database name. Overrides dbset options set in the configuration file.
-dbs, --dbset <dbset> ClearQuest connection name (dbset). Overrides dbset set in the configuration file
--localconfig Use local configuration file for the email notification settings. When set in command line or in the configuration file, SMTP server name, port, authentication credential and connection settings retrieved from the configuration file. When is not set (or set to "false" in the configuration file), ClearQuest user database properties are queried first. It was a default behavior for the email notification package delivery script.
-L, --logfile <file> Use alternative log file name (default is log/notification.log)
--loglevel <LEVEL> Specify desirable log level. (one of the following: ALL SEVERE WARNING INFO FINE FINER FINEST).
--debug Turn on debug output.
-v, --verbose Turn on console output
--interval <seconds> Specify scheduled run interval in seconds. Default is 300 – every 5 minutes.
--offset <seconds> Specify desirable offset of the scheduled execution from the beginning of the hour. Default is 0. It can be used to schedule email delivery from multiple hosts for redundancy and avoid racing conditions. For instance, you can run delivery every 5 minutes on host1 and host2, and use offset 150 (2.5 minutes) on one of them. In this case host1 runs delivery at hh:00:00, hh:05:00, hh:10:00, hh:15:00 ... and host2 at hh:02:30, hh:07:30, hh:12:30, hh:17:30 ...