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

6. Directory Structure

 

Directory tree after building bounceHammer

This page explains and lists the directory structure of bounceHammer after installing. make install command make these directories and set permissions.

bin/

The bin/ directory contain command line tools of bounceHammer. all of the commands in this directory are perl script and all users on the system can execute these commands.

databasectl*
This command read parsed data from a YAML file and write bounce records into the database. More information and usage of this command are available at databasectl.
datadumper*
This command dump/output bounce records in the database as a YAML/JSON/CSV format. More information and usage of this command are available at datadumper.
logger*
This command merge/concatenate log files which include parsed data (created by bin/mailboxparser command) by date. More information and usage of this command are available at logger.
mailboxparser*
This command read and parse bounce emails and output parsed data as a YAML/JSON format. More information and usage of this command are available at mailboxparser.
messagetoken*
This command prints a message token string. More information and usage of of this command are available at messagetoken.
summarizer*
This command prints a message token string. More information and usage of this command are available at summarizer.
tablectl*
This command is an administration tool for database table (we call it Mastertable). More information and usage of this command are available at tablectl.

etc/

The etc/ directory contain configuration files and sample configuration files of bounceHammer.

aliases-example
Example configuration file of /etc/mail/aliases
available-countries-example
Example configuration file for available-countries If you use this configuration file, save the file as the file name which does not include -example at the end of the file name. bounceHammer works properly if this file does not exist in the etc/ directory.
bouncehammer.cf-example
Example file of bouncehammer's main configuration file. bounceHammer does NOT work properly if this configuration file does not exist. More information about this file is available at bouncehammer.cf, Main configuration file.
crontab-example
Example configuration file for /etc/crontab. To run bouncehammer periodically, see Periodically run by crontab page.
httpd.conf-example
Example configuration file of Apache's httpd.conf for running bounceHammer's WebUI (Browser based control panel) and for running HTTP-based API with mod_perl2 on Apache 2.
neighbor-domains-example
Example configuration file for neighbor-domains for defining custom classification. If you use this file, save the file as the file name which does not include -example at the end of the file name. bounceHammer works properly if this file does not exist.
prove.cf
This file is a configuration file of bounceHammer for the command make test at build time. You can remove this file after installation.
test-run.cf
This file is a configuration file of bounceHammer in Test Mode (running with -T, --test option) of commands in the bin/ directory.
webui.cf-example
Example configuration file of WebUI and HTTP-based API. WebUI and HTTP-API require this file. If you use this file, save the file as the file name which does not include -example at the end of the file name.

lib/

The lib/ Directory contain all libraries and modules of bounceHammer. This directory contain all modules and source code files except command line tools.

Kanadzuchi/
All modules of bounceHammerare in this directory.
perl5/
If you have installed required perl modules by cpanm command, the modules are in this directory.

libexec/

The libexec/ Directory currently contains a script file for mod_perl2.

mp-startup.pl*
This is a script file for mod_perl2 which is called from httpd.conf .

share/script/

The share/script Directory contain SQL scripts, and CGI scripts.

MySQL*.sql
SQL Script file to build tables of bounceHammer for MySQL 4 or 5.
PostgreSQL*.sql
SQL Script file to build tables of bounceHammer for PostgreSQL.
SQLite*.sql
SQL Script file to build tables of bounceHammer for SQLite3.
api.cgi
CGI Script for HTTP-API.
bouncehammer.cgi
CGI Script for WebUI.
mastertable-*.sql
SQL Script file to insert records into master table for all DBs.
more-example-senderdomains.sql
More example domains for t_senderdomains for all DBs.
records-example.sql
SQL Script of example bounce records.
*-dailyupdates.sql
SQL script file for WebUI/Daily Updates, which is implemented at beginning with bounceHammer 2.5.0.

share/template/l10n/

This directory contain language files for WebUI template. As of present, files for Japanese and English are in this directory.

en/
Language files of WebUI template(English)
ja/
Language files of WebUI template(Japanese)

share/template/standard/

Template files for WebUI, style sheet files, and Javascipt files are in this directory.

element/
Partial HTML files of WebUI template for PC.
javascript/
Javascript files of WebUI template for PC.
page/
HTML page files of WebUI template for PC.
stylesheet/
Style sheets of WebUI template for PC.

var/

The var/ Directory contain miscellaneous files.

cache/
This directory will contain cache files for downloading which are created at WebUI.
db/
By default, a database file for SQLite3 will be here. If you use MySQL or PostgreSQL as a database system, this directory will not be used.
incoming/
As of present, this directory is unused. For future release of bounceHammer.
log/
Log files which include merged data created by logger command will be saved in this directory.
mail/
As of present, this directory is unused. For future release of bounceHammer.
run/
Each pid file of command line tool in the bin/ direcotry will be saved in this directory.
spool/
This directory hold YAML files which include parsed data created by mailboxparser command. And logger command read files in this directory and merge.
tmp/
Generic temporary directory.