3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * Class to handle encoding and decoding Variable Enveleope Return Path (VERP)
33 * @copyright CiviCRM LLC (c) 2004-2019
35 class CRM_Utils_Verp
{
37 * Mapping of reserved characters to hex codes
40 public static $encodeMap = [
52 * Mapping of hex codes to reserved characters
55 public static $decodeMap = [
67 * Encode the sender's address with the VERPed recipient.
69 * @param string $sender
70 * The address of the sender.
71 * @param string $recipient
72 * The address of the recipient.
75 * The VERP encoded address
77 public static function encode($sender, $recipient) {
78 preg_match('/(.+)\@([^\@]+)$/', $sender, $match);
82 preg_match('/(.+)\@([^\@]+)$/', $recipient, $match);
83 $rlocal = CRM_Utils_Array
::value(1, $match);
84 $rdomain = CRM_Utils_Array
::value(2, $match);
86 foreach (self
::$encodeMap as $char => $code) {
87 $rlocal = preg_replace('/' . preg_quote($char) . '/i', "+$code", $rlocal);
88 $rdomain = preg_replace('/' . preg_quote($char) . '/i', "+$code", $rdomain);
91 return "$slocal-$rlocal=$rdomain@$sdomain";
95 * Decode the address and return the sender and recipient as an array.
97 * @param string $address
98 * The address to be decoded.
101 * The tuple ($sender, $recipient)
103 public static function &verpdecode($address) {
104 preg_match('/^(.+)-([^=]+)=([^\@]+)\@(.+)/', $address, $match);
108 $rdomain = $match[3];
109 $sdomain = $match[4];
111 foreach (self
::$decodeMap as $code => $char) {
112 $rlocal = preg_replace("/+$code/i", $char, $rlocal);
113 $rdomain = preg_replace("/+$code/i", $char, $rdomain);
116 return ["$slocal@$sdomain", "$rlocal@$rdomain"];