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

bounceHammer Manual and Documents

Manual and Documents of bounceHammer

Environment for running bounceHammer

bounceHammer can run on *BSD UNIX (such as OpenBSD, FreeBSD, and FreeBSD) and Linux. More information about an environment for runnning bounceHammer available at the following pages:

  1. Perl Version
  2. Required Perl Modules
  3. Web Server for running WebUI
  4. System requirements
  5. Supported Database softwares

Installing bounceHammer

You can build bounceHammer with the configure script and the make(1) program like compiling Apache, PostgreSQL, and generic GNU software. Visit the following links to build, install, and configure bounceHammer.

  1. Get the tarball of bounceHammer | Download and expand it.
  2. Required Perl modules | Install perl modules which are required by bounceHammer
  3. ./configure | Preparation before building(make)
  4. make && make install | Build and install
  5. Setting up database | Setting Up database for storing parsed data
  6. Directory structure | Check directory structure created by the installer

Creating configuration files of bounceHammer

After you have installed bounceHammer successfully, please create and edit configuration files of bounceHammer with referring the following pages.

  1. bouncehammer.cf | Create a main configuration file
  2. webui.cf | Create a configuration file for WebUI
  3. neighbor-domains | Create a configuration file for your own classification
  4. available-countries | Create a configuration file to define your MTA

Configuration and Operation

After you have created the configuration files of bounceHammer, Visit the following pages.

  1. Prepare WebUI(Browser based control panel)
  2. Prepare HTTP-API
  3. Register email domain names which are under your control
  4. Periodically run bounceHammer by /etc/crontab
  5. Uninstall bounceHammer

Features of bounceHammer

Following pages explain features of bounceHammer, data structure, and internal flow. We provide command line tools for server administrators, WebUI (browser based control panel) for webmasters, and HTTP-API for developers.

  • Command line tools | About commands which are installed under bin/ directory
  • WebUI | Browser based control panel
  • HTTP-API | Get parsed data with JSON via HTTP-API
  • Internal flow | Internal flow of bounceHammer
  • Data structure | Data structure generated by bounceHammer
  • Benchmark | Benchmark results of bounceHammer's command line tools

Command line tools of bounceHammer

Following pages explain command line tools of bounceHammer which are installed undef bin/ directory by the installer.

  • mailboxparser | Parse bounce emails and output results as a YAML/JSON format
  • logger | Integrate parsed data by date
  • databasectl | Insert or update parsed data into your database
  • datadumper | Dump parsed data from your database as a YAML/JSON
  • summarizer | Print simple statistics of parsed data
  • tablectl | Register, update, and delete a record in the master table.
  • messagetoken | Generate a message token by a sender address and a recipient addresss

Classification of parsed data generated by bounceHammer

Following pages describe about classifications of parsed data in bounceHammer. Classifications are good for putting in order parsed data, for using search conditions.

  • Host Group(6) | Classification by a domain name of a recipient(PC,Webmail,and so on)
  • Provider(14+) | Classification by a provider name or service name(Gmail, Yahoo!, and so on)
  • Reason(19) | Reasons of email bounce

WebUI on bounceHammer

Following pages explain about WebUI: Browser based control panel for webmasters. You can search a recipient address, register a your email domain on WebUI.

  • Dashboard | First page of WebUI, It display email bounce status of today and yesterday
  • Search form | Finding details of email bounce searching by an email address and so on.
  • Search results | Check details of email bounce on WebUI
  • Data summary | Show the number of email bounces with ratio and some graph
  • Aggregation | Show aggregated data on your database
  • Edit master table | Edit master table to manage your email domains
  • Daily updates | Daily updates of email bounces
  • Online parser | Upload a bounce email in your PC to WebUI and parse it

bounceHammer/HTTP-API

bounceHammer provide HTTP-API for developers. HTTP-API have 2 methods for searching parsed data and they return results as a JSON format. It is good for implement a feature that verifying email bounce into your site.

  • SELECT | Get a parsed record by a message token or ID (on DB)
  • SEARCH | Get some parsed records by some fields