src/BounceMailHandler/phpmailer-bmh_rules.php ➔ bmhBodyRules()

Complexity

Conditions	52
Paths	540

Size

Total Lines	460
Code Lines	175

Duplication

Lines	180
Ratio	39.13 %

Code Coverage

Tests	86
CRAP Score	337.06

Importance

Changes

0

<?php
function bmhBodyRules($body, /** @noinspection PhpUnusedParameterInspection */ $structure, $debug_mode = false)

The parameter $structure is not used and could be removed.

{
  // initialize the result array
  $result = array(
      'email'           => '',
      'bounce_type'     => false,
      'remove'          => 0,
      'rule_cat'        => 'unrecognized',
      'rule_no'         => '0000',
      'status_code'     => '',
      'action'          => '',
      'diagnostic_code' => '',
  );

  // ======== rules =========

  /* rule: dns_unknown
   * sample:
   *   Technical details of permanent failure:
   *   DNS Error: Domain name not found
   */
  if (preg_match("/domain\s+name\s+not\s+found/i", $body, $match)) {
    $result['rule_cat'] = 'dns_unknown';
    $result['rule_no'] = '0999';
  } /* rule: unknown
   * sample:
   *   xxxxx@yourdomain.com
   *   no such address here
   */
  elseif (preg_match("/no\s+such\s+address\s+here/i", $body, $match)) {
    $result['rule_cat'] = 'unknown';
    $result['rule_no'] = '0237';
  } /* Gmail Bounce Error
   * rule: unknown
   * sample:
   *   Delivery to the following recipient failed permanently:
   *   xxxxx@yourdomain.com
   */
  elseif (
      strpos($body, 'Technical details of permanent failure') === false // if there are technical details, try another test-case
      &&
      preg_match("/Delivery to the following (?:recipient|recipients) failed permanently\X*?(\S+@\S+\w)/i", $body, $match)
  ) {
    $result['rule_cat'] = 'unknown';
    $result['rule_no'] = '0998';
    $result['email'] = $match[1];
  } /*
   * rule: unknown
   * sample:
   * <xxxxx@yourdomain.com>: host mail-host[111.111.111.111]
    said: 550 5.1.1 This user does not exist
   */
  elseif (preg_match("/user.+?not\s+exist/i", $body, $match)) {
    $result['rule_cat'] = 'unknown';
    $result['rule_no'] = '02361';
  } /* rule: unknown
   * sample:
   *   <xxxxx@yourdomain.com>:
   *   111.111.111.111 does not like recipient.
   *   Remote host said: 550 User unknown
   */
  elseif (preg_match("/user\s+unknown/i", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'unknown';
    $result['rule_no'] = '0236';
  } /* rule: unknown
   * sample:
   *
   */
  elseif (preg_match("/unknown\s+user/i", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'unknown';
    $result['rule_no'] = '0249';
  } /* rule: unknown
   * sample:
   *   <xxxxx@yourdomain.com>:
   *   Sorry, no mailbox here by that name. vpopmail (#5.1.1)
   */
  elseif (preg_match("/no\s+mailbox/i", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'unknown';
    $result['rule_no'] = '0157';
  } /* rule: unknown
   * sample:
   *   xxxxx@yourdomain.com<br>
   *   local: Sorry, can't find user's mailbox. (#5.1.1)<br>
   */
  elseif (preg_match("/can't\s+find.*mailbox/i", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'unknown';
    $result['rule_no'] = '0164';
  } /* rule: unknown
   * sample:
   *   ##########################################################
   *   #  This is an automated response from a mail delivery    #
   *   #  program.  Your message could not be delivered to      #
   *   #  the following address:                                #
   *   #                                                        #
   *   #      "|/usr/local/bin/mailfilt -u #dkms"               #
   *   #        (reason: Can't create output)                   #
   *   #        (expanded from: <xxxxx@yourdomain.com>)         #
   *   #                                                        #
   */
  elseif (preg_match("/Can't\s+create\s+output.*<(\S+@\S+\w)>/is", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'unknown';
    $result['rule_no'] = '0169';
    $result['email'] = $match[1];
  } /* rule: unknown

61% of this comment could be valid code. Did you maybe forget this after debugging?

   * sample:
   *   ????????????????:
   *   xxxxx@yourdomain.com : ????, ?????.
   */
  elseif (preg_match('/=D5=CA=BA=C5=B2=BB=B4=E6=D4=DA/i', $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'unknown';
    $result['rule_no'] = '0174';
  } /* rule: unknown
   * sample:
   *   xxxxx@yourdomain.com
   *   Unrouteable address
   */
  elseif (preg_match("/Unrouteable\s+address/i", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'unknown';
    $result['rule_no'] = '0179';
  } /* rule: unknown
   * sample:
   *   Delivery to the following recipients failed.
   *   xxxxx@yourdomain.com
   */
  elseif (preg_match("/delivery[^\n\r]+failed\S*\s+(\S+@\S+\w)\s/i", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'unknown';
    $result['rule_no'] = '0013';
    $result['email'] = $match[1];
  } /* rule: unknown
   * sample:
   *   A message that you sent could not be delivered to one or more of its
   *   recipients. This is a permanent error. The following address(es) failed:
   *
   *   xxxxx@yourdomain.com
   *   unknown local-part "xxxxx" in domain "yourdomain.com"
   */
  elseif (preg_match("/unknown\s+local-part/i", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'unknown';
    $result['rule_no'] = '0232';
  } /* rule: unknown
   * sample:
   *   <xxxxx@yourdomain.com>:
   *   111.111.111.11 does not like recipient.
   *   Remote host said: 550 Invalid recipient: <xxxxx@yourdomain.com>
   */
  elseif (preg_match("/Invalid.*(?:alias|account|recipient|address|email|mailbox|user).*<(\S+@\S+\w)>/is", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'unknown';
    $result['rule_no'] = '0233';
    $result['email'] = $match[1];
  } /* rule: unknown
   * sample:
   *   Sent >>> RCPT TO: <xxxxx@yourdomain.com>
   *   Received <<< 550 xxxxx@yourdomain.com... No such user
   *
   *   Could not deliver mail to this user.
   *   xxxxx@yourdomain.com
   *   *****************     End of message     ***************
   */
  elseif (preg_match("/No\s+such.*(?:alias|account|recipient|address|email|mailbox|user).*<(\S+@\S+\w)>/is", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'unknown';
    $result['rule_no'] = '0234';
    $result['email'] = $match[1];
  } /* rule: unknown
   * sample:
   *   Diagnostic-Code: X-Notes; Recipient user name info (a@b.c) not unique.  Several matches found in Domino Directory.
   */
  elseif (preg_match('/not unique.\s+Several matches found/i', $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'unknown';
    $result['rule_no'] = '0254';
  } /* rule: full
   * sample 1:
   *   <xxxxx@yourdomain.com>:
   *   This account is over quota and unable to receive mail.
   *   sample 2:
   *   <xxxxx@yourdomain.com>:
   *   Warning: undefined mail delivery mode: normal (ignored).
   *   The users mailfolder is over the allowed quota (size). (#5.2.2)
   */
  elseif (preg_match('/over.*quota/i', $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'full';
    $result['rule_no'] = '0182';
  } /* rule: full
   * sample:
   *   ----- Transcript of session follows -----
   *   mail.local: /var/mail/2b/10/kellen.lee: Disc quota exceeded
   *   554 <xxxxx@yourdomain.com>... Service unavailable
   */
  elseif (preg_match("/quota\s+exceeded.*<(\S+@\S+\w)>/is", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'full';
    $result['rule_no'] = '0126';
    $result['email'] = $match[1];
  } /* rule: full
   * sample:
   *   Hi. This is the qmail-send program at 263.domain.com.
   *   <xxxxx@yourdomain.com>:
   *   - User disk quota exceeded. (#4.3.0)
   */
  elseif (preg_match("/quota\s+exceeded/i", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'full';
    $result['rule_no'] = '0158';
  } /* rule: full
   * sample:
   *   xxxxx@yourdomain.com
   *   mailbox is full (MTA-imposed quota exceeded while writing to file /mbx201/mbx011/A100/09/35/A1000935772/mail/.inbox):
   */
  elseif (preg_match('/mailbox.*full/i', $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'full';
    $result['rule_no'] = '0166';
  } /* rule: full
   * sample:
   *   The message to xxxxx@yourdomain.com is bounced because : Quota exceed the hard limit
   */
  elseif (preg_match("/The message to (\S+@\S+\w)\s.*bounce.*Quota exceed/i", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'full';
    $result['rule_no'] = '0168';
    $result['email'] = $match[1];
  } /* rule: full
   * sample:
   *   Message rejected. Not enough storage space in user's mailbox to accept message.
   */
  elseif (preg_match("/not\s+enough\s+storage\s+space/i", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'full';
    $result['rule_no'] = '0253';
  } /* rule: inactive
   * sample:
   *   xxxxx@yourdomain.com<br>
   *   553 user is inactive (eyou mta)
   */
  elseif (preg_match('/user is inactive/i', $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'inactive';
    $result['rule_no'] = '0171';
  } /*
   * <xxxxx@xxx.xxx> is restricted
   */
  elseif (preg_match("/(\S+@\S+\w).*n? is restricted/i", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'inactive';
    $result['rule_no'] = '0201';
    $result['email'] = $match[1];
  } /* rule: inactive
   * sample:
   *   xxxxx@yourdomain.com [Inactive account]
   */
  elseif (preg_match('/inactive account/i', $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'inactive';
    $result['rule_no'] = '0181';
  } /*
   *<xxxxxx@xxxx.xxx>: host mx3.HOTMAIL.COM said: 550
   * Requested action not taken: mailbox unavailable (in reply to RCPT TO command)
   */
  elseif (preg_match("/<(\S+@\S+\w)>.*\n.*mailbox unavailable/i", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'unknown';
    $result['rule_no'] = '124';
    $result['email'] = $match[1];
  } /*
   * rule: mailbox unknown;
   * sample:
   * xxxxx@yourdomain.com
   * 550-5.1.1 The email
   * account that you tried to reach does not exist. Please try 550-5.1.1
   * double-checking the recipient's email address for typos or 550-5.1.1
   * unnecessary spaces. Learn more at 550 5.1.1
   * http://support.google.com/mail/bin/answer.py?answer=6596 n7si4762785wiy.46
   * (in reply to RCPT TO command)
   */
  elseif (preg_match("/<(\S+@\S+\w)>.*\n?.*\n?.*account that you tried to reach does not exist/i", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'unknown';
    $result['rule_no'] = '7770';
    $result['email'] = $match[1];
  } /* rule: dns_unknown
   * sample1:
   *   Delivery to the following recipient failed permanently:
   *
   *     a@b.c
   *
   *   Technical details of permanent failure:
   *   TEMP_FAILURE: Could not initiate SMTP conversation with any hosts:
   *   [b.c (1): Connection timed out]
   * sample2:
   *   Delivery to the following recipient failed permanently:
   *
   *     a@b.c
   *
   *   Technical details of permanent failure:
   *   TEMP_FAILURE: Could not initiate SMTP conversation with any hosts:
   *   [pop.b.c (1): Connection dropped]
   */
  elseif (preg_match('/Technical details of permanent failure:\s+TEMP_FAILURE: Could not initiate SMTP conversation with any hosts/i', $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'dns_unknown';
    $result['rule_no'] = '0251';
  } /* rule: delayed
   * sample:
   *   Delivery to the following recipient has been delayed:
   *
   *     a@b.c
   *
   *   Message will be retried for 2 more day(s)
   *
   *   Technical details of temporary failure:
   *   TEMP_FAILURE: Could not initiate SMTP conversation with any hosts:
   *   [b.c (50): Connection timed out]
   */
  elseif (preg_match('/Technical details of temporary failure:\s+TEMP_FAILURE: Could not initiate SMTP conversation with any hosts/i', $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'delayed';
    $result['rule_no'] = '0252';
  } /* rule: delayed
   * sample:
   *   Delivery to the following recipient has been delayed:
   *
   *     a@b.c
   *
   *   Message will be retried for 2 more day(s)
   *
   *   Technical details of temporary failure:
   *   TEMP_FAILURE: The recipient server did not accept our requests to connect. Learn more at ...
   *   [b.c (10): Connection dropped]
   */
  elseif (preg_match('/Technical details of temporary failure:\s+TEMP_FAILURE: The recipient server did not accept our requests to connect./i', $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'delayed';
    $result['rule_no'] = '0256';
  } /* rule: internal_error
   * sample:
   *   <xxxxx@yourdomain.com>:
   *   Unable to switch to /var/vpopmail/domains/domain.com: input/output error. (#4.3.0)
   */
  elseif (preg_match("/input\/output error/i", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'internal_error';
    $result['rule_no'] = '0172';
    $result['bounce_type'] = 'hard';
    $result['remove'] = 1;
  } /* rule: internal_error
   * sample:
   *   <xxxxx@yourdomain.com>:
   *   can not open new email file errno=13 file=/home/vpopmail/domains/fromc.com/0/domain/Maildir/tmp/1155254417.28358.mx05,S=212350
   */
  elseif (preg_match('/can not open new email file/i', $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'internal_error';
    $result['rule_no'] = '0173';
    $result['bounce_type'] = 'hard';
    $result['remove'] = 1;
  } /* rule: defer
   * sample:
   *   <xxxxx@yourdomain.com>:
   *   111.111.111.111 failed after I sent the message.
   *   Remote host said: 451 mta283.mail.scd.yahoo.com Resources temporarily unavailable. Please try again later [#4.16.5].
   */
  elseif (preg_match('/Resources temporarily unavailable/i', $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'defer';
    $result['rule_no'] = '0163';
  } /* rule: autoreply
   * sample:
   *   AutoReply message from xxxxx@yourdomain.com
   */
  elseif (preg_match("/^AutoReply message from (\S+@\S+\w)/i", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'autoreply';
    $result['rule_no'] = '0167';
    $result['email'] = $match[1];
  } /* rule: block
   * sample:
   *   Delivery to the following recipient failed permanently:
   *     a@b.c
   *   Technical details of permanent failure:
   *   PERM_FAILURE: SMTP Error (state 9): 550 5.7.1 Your message (sent through 209.85.132.244) was blocked by ROTA DNSBL. If you are not a spammer, open http://www.rota.lv/DNSBL and follow instructions or call +371 7019029, or send an e-mail message from another address to dz@ROTA.lv with the blocked sender e-mail name.
   */
  elseif (preg_match("/Your message \([^)]+\) was blocked by/i", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'antispam';
    $result['rule_no'] = '0250';
  } /* rule: content_reject
   * sample:
   *   Failed to deliver to '<a@b.c>'
   *   Messages without To: fields are not accepted here
   */
  elseif (preg_match("/Messages\s+without\s+\S+\s+fields\s+are\s+not\s+accepted\s+here/i", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'content_reject';
    $result['rule_no'] = '0248';
  }  /* rule: inactive
   * sample:
   *   <xxxxx@yourdomain.com>:
   *   This address no longer accepts mail.
   */
  elseif (preg_match("/(?:alias|account|recipient|address|email|mailbox|user).*no\s+longer\s+accepts\s+mail/i", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'inactive';
    $result['rule_no'] = '0235';
  } /* rule: western chars only
   * sample:
   *   <xxxxx@yourdomain.com>:
   *   The user does not accept email in non-Western (non-Latin) character sets.
   */
  elseif (preg_match("/does not accept[^\r\n]*non-Western/i", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'latin_only';
    $result['rule_no'] = '0043';
  } /* rule: unknown
   * sample:
   *   554 delivery error
   *   This user doesn't have a yahoo.com account
   */
  elseif (preg_match("/554.*delivery error.*this user.*doesn't have.*account/is", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'unknown';
    $result['rule_no'] = '0044';
  } /* rule: unknown
   * sample:
   *   550 hotmail.com
   */
  elseif (preg_match('/550.*Requested.*action.*not.*taken:.*mailbox.*unavailable/is', $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'unknown';
    $result['rule_no'] = '0045';
  } /* rule: unknown
   * sample:
   *   550 5.1.1 aim.com
   */
  elseif (preg_match("/550 5\.1\.1.*Recipient address rejected/is", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'unknown';
    $result['rule_no'] = '0046';
  } /* rule: unknown
   * sample:
   *   550 .* (in reply to end of DATA command)
   */
  elseif (preg_match('/550.*in reply to end of DATA command/i', $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'unknown';
    $result['rule_no'] = '0047';
  } /* rule: unknown
   * sample:
   *   550 .* (in reply to RCPT TO command)
   */
  elseif (preg_match('/550.*in reply to RCPT TO command/i', $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'unknown';
    $result['rule_no'] = '0048';
  } /* rule: dns_unknown
   * sample:
   *    a@b.c:
   *      unrouteable mail domain "b.c"
   */
  elseif (preg_match("/unrouteable\s+mail\s+domain/i", $body, $match)) {

This code seems to be duplicated across your project.

    $result['rule_cat'] = 'dns_unknown';
    $result['rule_no'] = '0247';
  }

  if ($result['rule_no'] !== '0000' && $result['email'] === '') {
    $preBody = substr($body, 0, strpos($body, $match[0]));

    $count = preg_match_all('/(\S+@\S+)/', $preBody, $match);
    if ($count) {
      $result['email'] = trim($match[1][$count - 1], "'\"()<>.:; \t\r\n\0\x0B");
    }
  }

  global $rule_categories, $bmh_newline;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

  if ($result['rule_no'] == '0000') {
    if ($debug_mode) {
      echo 'Body:' . $bmh_newline . $body . $bmh_newline;
      echo $bmh_newline;
    }
  } else {

This code seems to be duplicated across your project.

    if ($result['bounce_type'] === false) {
      $result['bounce_type'] = $rule_categories[$result['rule_cat']]['bounce_type'];
      $result['remove'] = $rule_categories[$result['rule_cat']]['remove'];
    }
  }

  return $result;
}