Refactor BulkDeliver so that the guts can be used in VERPDeliver.

Rename the substitution variables in verp_format.

1 files changed, 9 insertions, 10 deletions

diff --git a/src/mailman/config/schema.cfg b/src/mailman/config/schema.cfg
index 1520c4726..b0e7d52d9 100644
--- a/src/mailman/config/schema.cfg
+++ b/src/mailman/config/schema.cfg
@@ -306,11 +306,10 @@ delivery_retry_period: 5d
 #
 # http://cr.yp.to/proto/verp.txt
 #
-# This involves encoding the address of the recipient as we (Mailman) know it
-# into the envelope sender address (i.e. the SMTP `MAIL FROM:' address).
-# Thus, no matter what kind of forwarding the recipient has in place, should
-# it eventually bounce, we will receive an unambiguous notice of the bouncing
-# address.
+# This involves encoding the address of the recipient as Mailman knows it into
+# the envelope sender address (i.e. RFC 5321 MAIL FROM).  Thus, no matter what
+# kind of forwarding the recipient has in place, should it eventually bounce,
+# we will receive an unambiguous notice of the bouncing address.
 #
 # However, we're technically only "VERP-like" because we're doing the envelope
 # sender encoding in Mailman, not in the MTA.  We do require cooperation from
@@ -318,11 +317,11 @@ delivery_retry_period: 5d
 # semantics.
 #
 # The first variable describes how to encode VERP envelopes.  It must contain
-# these three string interpolations:
+# these three string interpolations, which get filled in by Mailman:
 #
-# $bounces -- the list-bounces mailbox will be set here
-# $mailbox -- the recipient's mailbox will be set here
-# $host    -- the recipient's host name will be set here
+# $bounces -- the list's -bounces robot address will be set here
+# $local   -- the recipient address's local mailbox part will be set here
+# $domain  -- the recipient address's domain name will be set here
 #
 # This example uses the default below.
 #
@@ -334,7 +333,7 @@ delivery_retry_period: 5d
 # Note that your MTA /must/ be configured to deliver such an addressed message
 # to mylist-bounces!
 verp_delimiter: +
-verp_format: ${bounces}+${mailbox}=${host}
+verp_format: ${bounces}+${local}=${domain}
 
 # For nicer confirmation emails, use a VERP-like format which encodes the
 # confirmation cookie in the reply address.  This lets us put a more user