CiviCRM Community Forums (archive)

Hi,

I have backported to an existing CiviCRM installation a patch [1] linked with CRM-2574 in order to have shorter VERP addresses in CiviMail. Since CRM-2574 changes the address of e-mails sent, e.g. they use "b.1.9.27.243c148ff9a0f4b0b4327c5a-mike=example.com@example.com" instead of "bounce.1.9.27.[...]".  This helps to create e-mail addresses which conform better to RFC2821, by not being more than 64 characters.

Now, since we use imap2soap, we also need to patch imap2soap to support this. I have made the following changes (below). Did I miss anything?

One thing I am not sure whether I am breaking something, is on the line detecting replies. I am not sure why the $dest uses a regexp for that case in particular.

--- imap2soap-2.1.pl-ORIG       2008-05-28 15:16:49.000000000 -0400
+++ imap2soap-2.1.pl    2008-05-28 15:21:49.000000000 -0400
@@ -280,7 +280,7 @@
     $attempt = 0;
 
     if (defined($hash)) {
-      if ($dest eq 'bounce') {          # i.e. this is a bounced message
+      if ($dest eq 'bounce' || $dest eq 'b') {          # i.e. this is a bounced message
         while (1) {
           $result =
             $soapClient->mailer_event_bounce($soapKey, $jobId, $qId,
@@ -303,7 +303,7 @@
           $imap->move("INBOX.Failed", $msg) or die "imap2soap: Could not move to Failed \n";
         }
 
-      } elsif ($dest =~ /.*reply.*/i) { # or it's a reply
+      } elsif ($dest =~ /.*reply.*/i || $dest eq 'r') { # or it's a reply
         while (1) {
           $result =
             $soapClient->mailer_event_reply($soapKey,
@@ -327,7 +327,7 @@
           $imap->move("INBOX.Failed", $msg) or die "imap2soap: Could not move to Failed \n";
         }
 
-      } elsif ($dest eq 'unsubscribe') { # or an unsubscription
+      } elsif ($dest eq 'unsubscribe' || $dest eq 'u') { # or an unsubscription
         while (1) {
           $result =
             $soapClient->mailer_event_unsubscribe($soapKey, $jobId, $qId, $hash);
@@ -348,7 +348,7 @@
           $imap->move("INBOX.Failed", $msg) or die "imap2soap: Could not move to Failed \n";
         }
 
-      } elsif ($dest eq 'confirm') {    # or an opt-in confirmation
+      } elsif ($dest eq 'confirm' || $dest eq 'c') {    # or an opt-in confirmation
         while (1) {
           $result =
             $soapClient->mailer_event_confirm($soapKey, $jobId, $qId, $hash);
@@ -369,7 +369,7 @@
           printf "CiviCRM: failed opt-in event: $verpInfo \n";
           $imap->move("INBOX.Failed", $msg) or die "imap2soap: Could not move to Failed \n";
         }
-      } elsif ($dest eq 'optOut') {     # or an opt-out
+      } elsif ($dest eq 'optOut' || $dest eq 'o') {     # or an opt-out
         while (1) {
           $result =
             $soapClient->mailer_event_domain_unsubscribe($soapKey, $jobId, $qId, $hash);
@@ -394,7 +394,7 @@
       my ($dest, $dId, $gId) =
         ($verpInfo =~ m/(\w+)\.(\d+).(\d+)\@.*/);
 
-      if ($dest eq 'subscribe') {       # it's a subscribe request
+      if ($dest eq 'subscribe' || $dest eq 's') {       # it's a subscribe request
         while (1) {
           $result =
             $soapClient->mailer_event_subscribe($soapKey, $from, $dId, $gId);

Thanks,
matt (bgm on #civicrm)

i'm currently using

r for reply
and re for resubscribe

if it makes the code easier we can switch to using e for resubscribe. i suspect resubscribe is not a very frequent operation

also with the new "getting rid of domain id" proposal (http://civicrm.org/blog/), reduces the size of the verp string by 2 more characters. so i think we are now quite safe with the 64 character limit for most cases (some ridiculously long email addresses / domain names will still trip us)

lobo

Hi Matt -

How do you distinguish between 'reply' and 'resubscribe' with a single letter?

Note that imap2soap-2.1.pl is an older version of imap2soap.  The preferred version pointed to by http://wiki.civicrm.org/confluence/display/CRMDOC/Alternative+configuration+with+imap2soap.pl+-+no+Amavis+or+root+access can be downloaded from https://svn.civicactions.net/repos/civicrm/scripts/

Assuming you work out the reply/resubscribe conflict, in addition to your changes you'd probably want something like this (untested):

Code: [Select]

--- imap2soap.pl (revision 1436)
+++ imap2soap.pl (working copy)
@@ -300,7 +300,8 @@
         junk($imap, $msg, "No To: header in message $n");
         next;
       }
-    unless ($to =~ m/^\s*<?(bounce|confirm|optout|reply|subscribe|unsubscribe|resubscribe)/i)
+    # look for (bounce|confirm|optout|reply|subscribe|unsubscribe|resubscribe)
+    unless ($to =~ m/^\s*<?(bcorsu)[a-z]*[\.-]\d+[\.-]\d+[\.-]\d+[\.-]/i)
       {
         junk($imap, $msg, "Not a CiviMail message $n -- To: $to");
         next;


I'm having more luck with this patch:

--- imap2soap.pl.orig   2008-09-20 00:57:27.000000000 -0500
+++ imap2soap.pl        2008-09-22 16:43:23.000000000 -0500
@@ -300,7 +300,8 @@
         junk($imap, $msg, "No To: header in message $n");
         next;
       }
-    unless ($to =~ m/^\s*<*"?(bounce|confirm|optout|reply|subscribe|unsubscribe|resubscribe)/i)
+    # look for (bounce|confirm|optout|reply|subscribe|unsubscribe|resubscribe)
+    unless ($to =~ m/^\s*<?([bcorsu]|re)[\.-]\d+[\.-]\d+[\.-]\d+[\.-]/i)
       {
         junk($imap, $msg, "Not a CiviMail message $n -- To: $to");
         next;
@@ -355,7 +356,7 @@
 
     if (defined($hash))
       {
-        if ($dest eq 'bounce')          # i.e. this is a bounced message
+        if ($dest eq 'b')          # i.e. this is a bounced message
           {
             while (1) {
               $result =
@@ -381,7 +382,7 @@
                 or fatal "Could not move to Failed";
             }
           }
-        elsif ($dest =~ /.*reply.*/i)   # or it's a reply
+        elsif ($dest eq 'r')   # or it's a reply
           {
             unless ($replyto)
               {
@@ -412,7 +413,7 @@
                 or fatal "Could not move to Failed";
             }
           }
-        elsif ($dest eq 'unsubscribe')  # or an unsubscription
+        elsif ($dest eq 'u')  # or an unsubscription
           {
             while (1) {
               $result =
@@ -437,7 +438,7 @@
             }
 
           }
-        elsif ($dest eq 'resubscribe')  # or an unsubscription
+        elsif ($dest eq 're')  # or an unsubscription
           {
             while (1) {
               $result =
@@ -462,7 +463,7 @@
             }
 
           }
-        elsif ($dest eq 'confirm')      # or an opt-in confirmation
+        elsif ($dest eq 'c')      # or an opt-in confirmation
           {
             while (1) {
               $result =
@@ -487,7 +488,7 @@
                 or fatal "Could not move to Failed";
             }
           }
-        elsif ($dest eq 'optOut')       # or an opt-out
+        elsif ($dest eq 'o')       # or an opt-out
           {
             while (1) {
               $result =
@@ -516,7 +517,7 @@
       {
         my ($dest, $dId, $gId) = ($verpInfo =~ m/(\w+).(\d+).(\d+)\@.*/);
 
-        if ($dest && $dest eq 'subscribe')      # it's a subscribe request
+        if ($dest && $dest eq 's')      # it's a subscribe request
           {
             unless ($replyto)           # contains $from if no Reply-to
               {


also with the new "getting rid of domain id" proposal (http://civicrm.org/blog/), reduces the size of the verp string by 2 more characters. so i think we are now quite safe with the 64 character limit for most cases (some ridiculously long email addresses / domain names will still trip us)

I missed this proposal and I couldn't find it in the link.  Is the domain id still with us?  I think it's useful, though I do understand that it creates more complexity...

But it looks like the $domainId is still sent in the mail strings.  From http://fisheye.civicrm.org/browse/CiviCRM/trunk/tools/amavisd-new/amavisd-new-2.5.2/amavisd?r=14828 :
17631    my ($dest, $domainId, $jobId, $qId, $hash) =
17632        ($verpInfo =~ m/(\w+)\.(\d+)\.(\d+)\.(\d+)\.([0-9A-F]+)\@.*/i);

Correct?

yes that is still being included. i suspect we'll elminate it in a 2.x / 3.x version

lobo

Quote from: fen on October 03, 2008, 07:28:43 am

I've just released a new imap2soap.pl that should be v2.1 compliant.  I still don't have a live site to test it on right now, though, so please - if someone can test it out and report back, I would greatly appreciate it.

See: https://svn.civicactions.net/repos/civicrm/scripts/imap2soap.pl

When initially posted, that version had a bug in the regex - please re-pull (VERSION = '20081004-0430')

I still haven't got confirmation that it is v2.1 compatible, but the version posted earlier today was not even v1.9 compatible.

Correction: the version number is VERSION = '20081004-0455'

Brave alpha-testers of the new return channel PHP processor, please check out this thread.