[![Build Status](https://travis-ci.org/azumakuniyuki/Sisimai.svg?branch=master)](https://travis-ci.org/azumakuniyuki/Sisimai) [![Coverage Status](https://img.shields.io/coveralls/azumakuniyuki/Sisimai.svg)](https://coveralls.io/r/azumakuniyuki/Sisimai) ____ _ _ _ / ___|(_)___(_)_ __ ___ __ _(_) \___ \| / __| | '_ ` _ \ / _` | | ___) | \__ \ | | | | | | (_| | | |____/|_|___/_|_| |_| |_|\__,_|_| What is Sisimai ? | シシマイ? ============================= Sisimai is a core module of bounceHammer version 4, is a Perl module for analyzing email bounce. "Sisimai" is a coined word: Sisi (the number 4 is pronounced "Si" in Japanese) and MAI (acronym of "Mail Analyzing Interface"). "シシマイ"ã¯bounceHammer version 4ã®ä¸æ ¸ã¨ãªã‚‹ã‚¨ãƒ©ãƒ¼ãƒ¡ãƒ¼ãƒ«è§£æžãƒ¢ã‚¸ãƒ¥ãƒ¼ãƒ«ã§ã™ã€‚ Version 4ãªã®ã§"ã‚·"ã‹ã‚‰å§‹ã¾ã‚Šãƒžã‚¤(MAI: Mail Analyzing Interface)ã‚’å«ã‚€åå‰ã«ãªã‚Šã¾ã—ãŸã€‚ System requirements | 動作環境 ------------------------------ * [Perl 5.10.1 or later](http://www.perl.org/) Dependencies | ä¾å˜ãƒ¢ã‚¸ãƒ¥ãƒ¼ãƒ« ----------------------------- Sisimai relies on: * [__Class::Accessor::Lite__](https://metacpan.org/pod/Class::Accessor::Lite) * [__JSON__](https://metacpan.org/pod/JSON) Sisimaiã¯ä¸Šè¨˜ã®ãƒ¢ã‚¸ãƒ¥ãƒ¼ãƒ«ã«ä¾å˜ã—ã¦ã„ã¾ã™ã€‚ Install | インストール ---------------------- % sudo cpanm Sisimai --> Working on Sisimai Fetching http://www.cpan.org/authors/id/A/AK/AKXLIX/Sisimai-4.1.8.tar.gz ... OK ... 1 distribution installed % perldoc -l Sisimai /usr/local/lib/perl5/site_perl/5.20.0/Sisimai.pm OR % cd /usr/local/src % git clone https://github.com/azumakuniyuki/Sisimai.git % cd ./Sisimai % sudo cpanm . --> Working on . Configuring Sisimai-4.1.8 ... OK 1 distribution installed Basic usage | 基本的ãªä½¿ã„æ–¹ ---------------------------- make() method provides feature for getting parsed data from bounced email messages like following. ```perl use Sisimai; my $v = Sisimai->make( '/path/to/mbox' ); # or Path to Maildir if( defined $v ) { for my $e ( @$v ) { print ref $e; # Sisimai::Data print $e->recipient->address; # kijitora@example.jp print $e->reason; # userunknown my $h = $e->damn(); # Convert to HASH reference my $j = $e->dump('json'); # Convert to JSON string print $e->dump('json'); # JSON formatted bounce data } } ``` 上記ã®ã‚ˆã†ã«Sisimaiã®make()メソッドをmboxã‹Maildirã®PATHを引数ã«ã—ã¦å®Ÿè¡Œã™ã‚‹ã¨ 解æžçµæžœãŒé…列リファレンスã§è¿”ã£ã¦ãã¾ã™ã€‚ Differences between ver.2 and ver.4 | æ–°æ—§ã®é•ã„ ------------------------------------------------ The followings are the differences between version 2 (bounceHammer 2.7.13) and version 4 (Sisimai). | Features | ver 2.7.13 | Sisimai | |------------------------------------------------|---------------|--------------| | Command line tools | OK | N/A | | Modules for Commercial MTAs | N/A(1) | Included | | WebUI/API | OK | N/A | | Database schema for storing parsed bounce data | Available | N/A(2) | | Analysis accuracy ratio(3) | 0.77 | 1.00 | | Parse 2 or more bounces in a single email | Only 1st rcpt | ALL | | Parse FeedBack Loop Message/ARF format mail | N/A | OK | | Classification based on recipient domain | Available | N/A | | Output format of parsed data | YAML,JSON,CSV | JSON only(4) | | The speed of parsing email(1048 files) | 5.00s | 3.73s | | Easy to install | No | Yes | | Install using cpan or cpanm command | N/A | OK | | Dependencies | 24 modules | 2 modules | | License | GPLv2 or Perl | 2 clause BSD | | Support Contract provided by Developer | Available | Coming soon | 1. bounceHammer-nails 2. Implement yourself with using DBI or any O/R Mapper you like 3. See ./ANALYSIS-ACCURACY 4. YAML format is available if "YAML" module has been installed 公開ä¸ã®bouncehammer version 2.7.13ã¨version 4(シシマイ)ã¯ä¸‹è¨˜ã®ã‚ˆã†ãªé•ã„ãŒã‚ã‚Šã¾ã™ã€‚ | 機能 | ver 2.7.13 | Sisimai | |------------------------------------------------|---------------|--------------| | コマンドラインツール | ã‚ã‚Š | ç„¡ã— | | 商用MTA対応解æžãƒ¢ã‚¸ãƒ¥ãƒ¼ãƒ« | ç„¡ã—(商用版,1)| ã‚ã‚Š(標準) | | WebUIã¨API | ã‚ã‚Š | ç„¡ã— | | 解æžæ¸ˆãƒã‚¦ãƒ³ã‚¹ãƒ‡ãƒ¼ã‚¿ã‚’ä¿å˜ã™ã‚‹DBスã‚ーマ | ã‚ã‚Š | ç„¡ã—(2) | | 解æžç²¾åº¦ã®å‰²åˆ(3) | 0.77 | 1.00 | | 2件以上ã®ãƒã‚¦ãƒ³ã‚¹ãŒã‚るメールã®è§£æž | 1件目ã ã‘ | 全件対応 | | FeedBack Loop/ARFå½¢å¼ã®ãƒ¡ãƒ¼ãƒ«è§£æž | éžå¯¾å¿œ | 対応済 | | 宛先ドメインã«ã‚ˆã‚‹åˆ†é¡žé …ç›® | ã‚ã‚Š | ç„¡ã— | | 解æžçµæžœã®å‡ºåŠ›å½¢å¼ | YAML,JSON,CSV | JSONã®ã¿(4) | | メール解æžã®é€Ÿåº¦(1048通) | 5.00秒 | 3.73秒 | | インストール作æ¥ãŒç°¡å˜ã‹ã©ã†ã‹ | ã‚„ã‚„é¢å€’ | ç°¡å˜ã§æ¥½ | | cpanã¾ãŸã¯cpanmコマンドã§ã®ã‚¤ãƒ³ã‚¹ãƒˆãƒ¼ãƒ« | éžå¯¾å¿œ | 対応済 | | ä¾å˜ãƒ¢ã‚¸ãƒ¥ãƒ¼ãƒ«æ•° | 24モジュール | 2モジュール | | ライセンス | GPLv2ã‹Perl | 二æ¡é …BSD | | 開発会社ã«ã‚ˆã‚‹ã‚µãƒãƒ¼ãƒˆå¥‘ç´„ | æä¾›ä¸ | æº–å‚™ä¸ | 1. bounceHammer-nails 2. DBIã¾ãŸã¯å¥½ããªORMを使ã£ã¦è‡ªç”±ã«å®Ÿè£…ã—ã¦ãã ã•ã„ 3. ./ANALYSIS-ACCURACY ã‚’å‚ç…§ 4. "YAML"モジュールãŒå…¥ã£ã¦ã„ã‚Œã°YAMLã§ã®å‡ºåŠ›ã‚‚å¯èƒ½ Commercial MTA Modules | 商用MTAモジュール ------------------------------------------ The following commercial MTA modules are included in Sisimai by default. | Sisimai:: | Description | |---------------------------|---------------------------------------------------| | MTA::Activehunter | TransWARE Active!hunter | | MTA::Domino | IBM Domino Server | | MTA::Exchange | Microsoft Exchange Server | | MTA::IMailServer | IPSWITCH IMail Server | | MTA::InterScanMSS | Trend Micro InterScan Messaging Security Suite | | MTA::MXLogic | McAfee SaaS | | MTA::MailFoundry | MailFoundry | | MTA::MailMarshalSMTP | Trustwave Secure Email Gateway | | MTA::McAfee | McAfee Email Appliance | | MTA::MessagingServer | Oracle Communications Messaging Server | | MTA::Notes | Lotus Notes | | MTA::SurfControl | WebSense SurfControl | | MTA::mFILTER | Digital Arts m-FILTER | | MSP::US::AmazonSES | AmazonSES: http://aws.amazon.com/ses/ | | MSP::US::SendGrid | SendGrid: http://sendgrid.com/ | 上記ã®å•†ç”¨MTAモジュールã¯Sisimaiã«æœ€åˆã‹ã‚‰å«ã¾ã‚Œã¦ã„ã¾ã™ã€‚ REPOSITORY | リãƒã‚¸ãƒˆãƒª ----------------------- [github.com/azumakuniyuki/Sisimai](https://github.com/azumakuniyuki/Sisimai) WEB SITE | サイト ----------------- [bounceHammer | an open source software for handling email bounces](http://bouncehammer.jp/) AUTHOR | 作者 ------------- [@azumakuniyuki](https://twitter.com/azumakuniyuki) COPYRIGHT | 著作権 ------------------ Copyright (C) 2014-2015 azumakuniyuki <perl.org@azumakuniyuki.org>, All Rights Reserved. LICENSE | ライセンス -------------------- This software is distributed under The BSD 2-Clause License.