bounceHammer has been EOL'ed on February 29, 2016

EOL on February 29, 2016

bounceHammer have been downloaded and used by many users and companies since the first release on March 2010 and has been EOL: End Of Life on February 29, 2016. Thanks for using bounceHammer for a long time. We are now providing Sisimai (the successor of bounceHammer, more faster, more higher precision of analysis) as a bounce mail parser library in BSD 2-Clause License.

Sisimai
Commercial Support

  • 1Setting Up Sisimai Your Server
  • 2Support developmenet using Sisimai
  • 3Support via Email
  • 4Support bounce management
  • 5Parsing your bounced emails

datadumper/Dump Data from DB

 

datadumper - Dump records

datadumper is a dumper command for getting records as a YAML/JSON or CSV from bounceHammer database table (BounceLogs). Some simple sufficient conditions can be specified for searching.

This command has been installed in INSTALL-DESTINATION/bin directory.

Usage of this command

datadumper can operate a database like tablectl command, databasectl command without using SQL. And WebUI can do this. but It does not have a full function of databasectl command.

Dump all of the records in the DB
# datadumper --alldata
 
Dump the records which the senderdomain is example.co
# datadumper --senderdomain example.jp
 
Dump the records which the reason is userunknown and
the hostgroup is webmail
# datadumper --reason userunknown --hostgroup cellphone
 
Dump the records which the destination is example.org and within a year
# datadumper --destination example.com --howrecent 1y
 
Show help message
# datadumper --help

Available Options

Options for specifying conditon

-A, --alldata
By default, datadumper with no option displays all the data in a database except records which the value of "disabled" column is 1. When this option is specified, datadumper displays all the data in the database include records which the value of "disabled" column is 1.
-a, --addresser SENDER-ADDRESS
Specify an addresser (a sender's email addrsss). Data which sender address is the specified addresser are displayed.
-r, --recipient RECIPIENT-ADDRESS
Specify a recipient (a recipient email address). Data which recipient address is the specified recipient are displayed.
-s, --senderdomain SENDER-DOMAIN
Specify a senderdomain (a domain part of a sender's email address). Data which senderdomain is the specified sender domain are displayed.
-d, --destinaiton DESTINATION-DOMAIN
Specify a destination (a domain part of a recipient's email address). Data which destination is the specified recipient domain are displayed.
-w, --reason REASON-NAME
Specify a reason (of email bounce). To see a list of available values of this option is the result of tablectl -tw --list See the values of why column.
-g, --hostgroup HOSTGROUP-NAME
Specify a hostgroup (a HostGroup Name). The result of tablectl -th --list will show you the available values of this option, See the values of "name" colummn.
-p, --provider PROVIDER-NAME
Specify a provider (a Provider Name). The result of tablectl -tp --list will show you the available values of this option, See the value of "name" column.
-t, --token MESSAGE-TOKEN
Specify a message token string (a Message Token). The message token can be generated by using messagetoken command. This option is equals to the command with both --addresser and --recipient.
-h, --howrecent Number/Unit
Specify the earliest date of the email bounce. The command display records which date (bounce date) is newer than the specified date.

Available value is a positive integer or a positive float number, and available units are s:seconds, m:minutes, h:hours, d:days, w:weeks, and y:years. If the unit is omitted, d(days) is used as a unit.

e.g.) 2w = 2 weeks、3d = 3 days、 1y = 1 year.
-f, --frequency Minimum value of how many email bounce (Beginning with Ver. 2.6.3)
The minimum value of frequency (The number of how many email bounce). For Example, If you specify --frequency 6, The command display records which ware bounced for 6 times or more.

Options for Output Format

-o, --orderby COLUMN-NAME
Sort, ascending order by a specified column (e.g. addresser, recipient, and so on). If this option is omitted, The records are sorted by ID.
-O, --orderbydesc COLUMN-NAME
Sort, descending order by a specipied column (e.g. addresser, recipient, and so on). If this option is omitted, The records are sorted by ID.
--count
Displays the number of records which are matched with a specified condition (other options of this command). The command with this option will give the same results as the following SQL: SELECT count(*) FROM ... WHERE (...);.
--comment
Date and a program name will be displayed at the head of the results. This option may not be useful, and may be removed from the future release of bounceHammer.

Other Options

-B, --batch (Beginning with ver. 2.3.1)
Runs as a batch mode. Results of the command will be displayed as a YAML format. It useful to send the results to an administrator with an email.
-C, --conf CONFIG-FILE
Use an alternative bounceHammer's configuration file. If this option is omitted, the command will use INSTALL-DESTINATION/etc/bouncehammer.cf.
-T, --test
Runs as test mode. This option is equals to the option -C INSTALL-DESTINATION/etc/test-run.cf.
-F, --format CHAR
Display parsed data as a specified format. If this option is omitted, the results are displayed as a ASCII Table. Available format characters are the followings:
CHAR Notes
y YAML | e.g.) -Fy
j JSON | e.g.) -Fj
c CSV (Beginning with 2.4.0) | -Fc
--silent
Turn silent mode on. This option makes the command quiet in spite of -v, --verbose option (described later). And when the command is called from a daemon (such as sendmail), the command will exit with status 0 in spite of an error. If an MTA process (e.g. /usr/sbin/sendmail) which is called the command without this --silent option stopped by an error, the command will exit with status 75(EX_TEMPFAIL).
-v, --verbose
Turn verbose mode ON.
--help
Display help messages of this command.
--version
Display the version number of this command.

Screenshot of the running command

datadumper --count and other 2 examples

The following screenshot shows that the command with some search conditions display the results as a YAML format.