Command line tools

After you have installed bounceHammer, you can use some command line tools in INSTALL-DESTINATION/bin directory. All the command are a perl script. Each command of the directory can be executed by anybody.

First, parse bounced emails

The first step of start to use bounceHammer is that parse bounced emails by using mailboxparser command. bounceHammer parses an email as a text data, parses a mailbox saved on your server, parse emails saved on Maildir/. Old emails on your computer or old mailbox (such as /var/mail/root) on your server can be parsed by bounceHammer.

mailboxparser - Parsing

bounceHammer parse bounced emails and then find a reason (such as userunknown, mailboxfull, rejected, and so on) why the email bounced, classify recipient into a hostgroup (such as webmail, pc, smartphone ).
mailboxparser command will do this and save results as a file in INSTALL-DESTINATION/var/spool directory.

logger - Accumulating

Parsed data which are created by mailboxparser command are sorted by time, accumulated and saved by each date in INSTALL-DESTINATION/var/log directory.
logger command will do this.

databasectl - Inserting and Updating

Accumulated data which are created by logger command, are saved as a YAML file will be inserted/updated into a database.
databasectl command will do this.

datadumper - Dump the data

Stored data which are inserted/updated by databsectl command can be searched with conditions, and can be dumped as a YAML/JSON format.
datadumper command and WebUI will do this.

summarizer - Aggregation

Stored data (created by databsectl command) in a database or the accumulated data (created by logger command) in a log file can be aggregated, and you can get aggregated data and descriptive statistics.
summarizer command and WebUI will do this.

tablectl, messagetoken - Other Administration

You can edit and refer each mastertable (SenderDomains, Destinations, HostGroups, Providers, and Reasons) of BounceHammer by using tablectl command. This operation can be do with WebUI.

And messagetoken command generates a unique string which is created by the combination of an Addresser(From: address) and a Recipient(To: address). The unique string is named as "Message Token" in bounceHammer.