bouncehandler.php

#!/usr/bin/php -q
<?php
 /*
 *
 * bouncehandler.php | MailWizz / PowerMTA / Webhook bounce handler
 * Copyright (c) 2016-2017 Gerd Naschenweng / bidorbuy.co.za
 *
 * The MIT License (MIT)
 *
 * @author Gerd Naschenweng <gerd@naschenweng.info>
 * @link https://www.naschenweng.info/
 * @copyright 2016-2017 Gerd Naschenweng  https://github.com/magicdude4eva
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 */

/**
 * Notes:
 * - Configure your API keys in setup.php
 *
 * - For MailWizz
 *   = download MailWizz SDK from https://github.com/twisted1919/mailwizz-php-sdk/tree/master/MailWizzApi
 *   = copy the MailWizzAPI directory into the same providers directory
 *
 * - In Port25 add the following accounting record:
   <acct-file | /usr/bin/php /opt/pmta/bouncehandler/bouncehandler.php>
      records b
      type,timeQueued,bounceCat,vmta,orig,rcpt,srcMta,dlvSourceIp,jobId,dsnStatus,dsnMta,dsnDiag
    </acct-file>

    Within code we will refer to the record as follows:
    type          = bounceRecord[0]   = type - always b
    timeQueued    = bounceRecord[1]   = Time message was queued to disk
    bounceCat     = bounceRecord[2]   = likely category of the bounce (see Section 1.5), following the recipient which it refers
    vmta          = bounceRecord[3]   = VirtualMTA selected for this message, if any
    orig          = bounceRecord[4]   = originator (from MAIL FROM:<x>)
    rcpt          = bounceRecord[5]   = recipient (RCPT TO:<x>) being reported
    srcMta        = bounceRecord[6]   = source from which the message was received. the MTA name (from the HELO/EHLO command) for messages received through SMTP
    dlvSourceIp   = bounceRecord[7]   = local IP address PowerMTA used for delivery
    jobId         = bounceRecord[8]   = job ID for the message, if any
    dsnStatus     = bounceRecord[9]   = DSN status for the recipient to which it refers
    dsnMta        = bounceRecord[10]  = DSN remote MTA for the recipient to which it refers
    dsnDiag       = bounceRecord[11]  = DSN diagnostic string for the recpient to which it refers

 *
 *  USAGE - Port25 PowerMTA
 *  - Simply create the directory /opt/pmta/bouncehandler and make sure that PMTA has execute permissions
 *  - Configure the the acct-file as per instructions above
 *
 *  USAGE - Standalone processing
 *  - Provide a simple CSV with an email address per line and call via "cat bounce.csv | /usr/bin/php /opt/pmta/bouncehandler/bouncehandler.php"
 *  - NOTE: The email-address will be unsubscribed from all configured providers
 *
 *  LOGGING
 *  - If you set 'LOG_CONSOLE_MODE' to '1' all output goes to console.
 *  - If 'LOG_CONSOLE_MODE' is set to '0' logging goes to /var/log/pmta/pmta-bounce-handler.log (or the current directory if the file can not be written)
 */

// Bounce-Record offsets: Only adjust the offsets below if you create a different accounting file

define("PORT25_OFFSET_BOUNCE_BOUNCE_CAT",         2); // bounceCat
define("PORT25_OFFSET_BOUNCE_VMTA",               3); // vmta
define("PORT25_OFFSET_BOUNCE_SOURCE_EMAIL",       4); // orig
define("PORT25_OFFSET_BOUNCE_RECIPIENT",          5); // rcpt
define("PORT25_OFFSET_BOUNCE_JOBID",              8); // jobId
define("PORT25_OFFSET_BOUNCE_DSNSTATUS",          9); // dsnStatus

// Feedback Loop Record offsets: Only adjust the offsets below if you create a different accounting file
define("PORT25_OFFSET_FEEDBACK_USER_AGENT",       5); // user agent
define("PORT25_OFFSET_FEEDBACK_SOURCE_EMAIL",     7); // orig
define("PORT25_OFFSET_FEEDBACK_RECIPIENT",        8); // rcp
define("PORT25_OFFSET_FEEDBACK_REPORTDOMAIN",    11); // reporter domain
define("PORT25_OFFSET_FEEDBACK_LISTUNSUBSCRIBE", 19); // List-Unsubscribe


// Initialise Setup and configuration
// Adjust the setup.php accordingly
require_once dirname(__FILE__) . '/setup.php';

// ------------------------------------------------------------------------------------------------------
// Main programme
$log->lwrite('------------------------------------------------------------------');
$log->lwrite('Port25 PowerMTA bounce-handler');
$log->lwrite('(C) 2016-2017 Gerd Naschenweng  https://github.com/magicdude4eva');
$log->lwrite('------------------------------------------------------------------');
$log->lwrite('Handling bounce categories=' . (is_null($bounceCategories) || empty($bounceCategories) ? 'all records' : implode(',', $bounceCategories)));
$log->lwrite('Soft-bounce categories=' . (is_null($softbounceCategories) || empty($softbounceCategories) ? 'all records' : implode(',', $softbounceCategories)));

// ------------------------------------------------------------------------------------------------------
// Initialise bounce providers
require_once dirname(__FILE__) . '/providers/bounce-provider-interspire.php';
require_once dirname(__FILE__) . '/providers/bounce-provider-mailwizz.php';
require_once dirname(__FILE__) . '/providers/feedback-loop-processor.php';

// ------------------------------------------------------------------------------------------------------
// Initialise reporting class
if (defined('RRD_FILE') && RRD_FILE) {
  $reportingInterface = new BounceReporting(RRD_FILE);
}

// ------------------------------------------------------------------------------------------------------
$totalRecords = 0;
$totalRecordsSkipped = 0;
$totalRecordsProcessed = 0;
// We read from standard in and expect a CSV
$log->lwrite('Starting bounce processing');

while(( $bounceRecord = fgetcsv(STDIN,4096)) !== FALSE ) {

  ++$totalRecords;

  // If the line is empty or it is the header line, we skip
  if (!$bounceRecord || $bounceRecord[0]=="type") {
    ++$totalRecordsSkipped;
    continue;
  }

  $STANDALONE_MODE = false;$BOUNCE_MODE = false;$FEEDBACK_LOOP_MODE = false;
  $recipient = null;

  // Let's check if this is standalone mode - i.e. we get a CSV and the first column is the email address to handle as the bounce
  // If the first record is not an email we assume it is a bounce record
  if (filter_var($bounceRecord[0], FILTER_VALIDATE_EMAIL)) {
    $STANDALONE_MODE = true;$BOUNCE_MODE = true;
    $recipient = $bounceRecord[0];
  }

  // This is a bounce record
  if ($STANDALONE_MODE == false && $bounceRecord[0]=="b" && filter_var($bounceRecord[PORT25_OFFSET_BOUNCE_RECIPIENT], FILTER_VALIDATE_EMAIL)) {
    $recipient = $bounceRecord[PORT25_OFFSET_BOUNCE_RECIPIENT];
    $BOUNCE_MODE = true;
  }

  // This is a feedback loop record
  if ($STANDALONE_MODE == false && $bounceRecord[0]=="f") {
    // For bounce records we sometimes get RFC emails (i.e. "<name@outlook.com>") and need to just strip out the email
    if (!is_null($bounceRecord[PORT25_OFFSET_FEEDBACK_RECIPIENT]) && !empty($bounceRecord[PORT25_OFFSET_FEEDBACK_RECIPIENT])) {
      preg_match('/[\\w\\.\\-+=*_]*@[\\w\\.\\-+=*_]*/', $bounceRecord[PORT25_OFFSET_FEEDBACK_RECIPIENT], $regs);
      $recipient = $regs[0];
    } else if (!is_null($bounceRecord[PORT25_OFFSET_FEEDBACK_LISTUNSUBSCRIBE]) && !empty($bounceRecord[PORT25_OFFSET_FEEDBACK_LISTUNSUBSCRIBE])) {
       // mail.ru does not send the from address, we just set a dummy, as we are able to pick the recipient from the List-Unsubscribe
       // AOL does not send a reporting domain either
      if (preg_match("/^(mail|bk).ru/", $bounceRecord[PORT25_OFFSET_FEEDBACK_REPORTDOMAIN], $matches) ||
          preg_match("/^(AOL\ SComp)/", $bounceRecord[PORT25_OFFSET_FEEDBACK_USER_AGENT], $matches)) {

         // We get the to-address as:
         // [SUBSCRIBERID].[LIST_UID].[CAMPAIGN_UID]@fbl-unsub.bidorbuy.co.za
         preg_match('/^<mailto:(.*)\.(.*)\.(.*)@fbl-unsub\.bidorbuy\.co\.za/', $bounceRecord[PORT25_OFFSET_FEEDBACK_LISTUNSUBSCRIBE], $regs);

         if (!is_null($regs) && !empty($regs) && sizeof($regs) == 4) {
           $getSubscriber = MailWizz_getSubscriber($regs[2], $regs[1]);

           if ($getSubscriber[0] == true) {
             $recipient = $getSubscriber[1];
           }
         }
      }
    }

    if (!filter_var($recipient, FILTER_VALIDATE_EMAIL)) {
      continue;
    }

    $FEEDBACK_LOOP_MODE = true;
  }

  // Only handle valid bounce categories. We skip any bounce-category which does not match
  if ($STANDALONE_MODE == false && $BOUNCE_MODE == true && !in_array($bounceRecord[PORT25_OFFSET_BOUNCE_BOUNCE_CAT], $bounceCategories)) {
    ++$totalRecordsSkipped;
    continue;
  }

  // Invalid/skipped record
  if (is_null($recipient) || empty($recipient) || !filter_var($recipient, FILTER_VALIDATE_EMAIL)) {
    ++$totalRecordsSkipped;
    continue;
  }

  // In Standalone mode, we unsubscribe bounces from all systems
  if ($STANDALONE_MODE == true) {
    // Log the bounce record to RRD
    if (defined('RRD_FILE') && RRD_FILE) {
      $reportingInterface->logReportRecord("bounces", 1);
    }

    MailWizz_unsubscribeRecipient($recipient, null);
    Interspire_unsubscribeRecipient($recipient);
    ++$totalRecordsProcessed;
    continue;
  }

  // In Feedback mode, handle feedback record
  if ($FEEDBACK_LOOP_MODE == true) {
    // Log FBL record to RRD
    if (defined('RRD_FILE') && RRD_FILE) {
      $reportingInterface->logReportRecord("fbl_reports", 1);
    }

    feedbackLoopEvent($recipient,$bounceRecord);
    ++$totalRecordsProcessed;
    continue;
  }

  // The section below is purely for Port25 pipe-processing
  $log->lwrite('Bounce: ' . $bounceRecord[PORT25_OFFSET_BOUNCE_BOUNCE_CAT] . ' from=' . $bounceRecord[PORT25_OFFSET_BOUNCE_SOURCE_EMAIL] . ' via ' . $bounceRecord[PORT25_OFFSET_BOUNCE_VMTA] . '/' . $bounceRecord[PORT25_OFFSET_BOUNCE_RECIPIENT] . " jobId=" . $bounceRecord[PORT25_OFFSET_BOUNCE_JOBID] .
  ', dsnStatus=' . $bounceRecord[PORT25_OFFSET_BOUNCE_DSNSTATUS]);

  // If we have a transactional match, call the transactional webhook
  if (in_array($bounceRecord[PORT25_OFFSET_BOUNCE_SOURCE_EMAIL], $origTransactional)) {
    // Log the bounce record to RRD
    if (defined('RRD_FILE') && RRD_FILE) {
      $reportingInterface->logReportRecord("bounces", 1);
    }
    //Transactional_unsubscribeRecipient($recipient, $bounceRecord); - your own transactional processor
    MailWizz_unsubscribeRecipient($recipient, null);
    Interspire_unsubscribeRecipient($recipient);
    ++$totalRecordsProcessed;
    continue;
  }

  // Handle MailWizz bounces
  if (in_array($bounceRecord[PORT25_OFFSET_BOUNCE_SOURCE_EMAIL], $origMailWizzZA)) {
    // Log the bounce record to RRD
    if (defined('RRD_FILE') && RRD_FILE) {
      $reportingInterface->logReportRecord("bounces", 1);
    }

    // We determine the MailWizz campaign bounce type based on the softbounce filter
    if (in_array($bounceRecord[PORT25_OFFSET_BOUNCE_BOUNCE_CAT], $softbounceCategories)) {
      $MailWizzType_bounceType = "soft";
    } else {
      $MailWizzType_bounceType = "hard";
    }

    $Mailwizz_bounceRecord = array(
      $MailWizzType_bounceType,                     // 1-bounce-type (hard, soft, internal)
      $bounceRecord[PORT25_OFFSET_BOUNCE_JOBID],    // 2- Campaign-UID
      $bounceRecord[PORT25_OFFSET_BOUNCE_DSNSTATUS] // 3- bounce-reason
      );

    MailWizz_unsubscribeRecipient($recipient, $Mailwizz_bounceRecord);
    ++$totalRecordsProcessed;
    continue;
  }

  // Handle Interspire bounces
  if (in_array($bounceRecord[PORT25_OFFSET_BOUNCE_SOURCE_EMAIL], $origInterspire)) {
    // Log the bounce record to RRD
    if (defined('RRD_FILE') && RRD_FILE) {
      $reportingInterface->logReportRecord("bounces", 1);
    }

    Interspire_unsubscribeRecipient($recipient);
    ++$totalRecordsProcessed;
    continue;
  }

}

$log->lwrite('Completed bounce processing! Total records=' . $totalRecords . ', processed=' . $totalRecordsProcessed . ', skipped=' . $totalRecordsSkipped);

// close log file
$log->lclose();

// close stats file
$statsfile->lclose();

die();

?>