Describe in a long comment what does Newsletter::sendToAll()

[platal.git] / include / newsletter.inc.php

diff --git a/include/newsletter.inc.php b/include/newsletter.inc.php
index ded8520..fa368f9 100644 (file)
--- a/include/newsletter.inc.php
+++ b/include/newsletter.inc.php
@@ -619,6 +619,26 @@ class NewsLetter
         }
     }
 
+    /** Get a full URL to a newsletter
+     */
+    public function fullUrl()
+    {
+        switch ($this->group) {
+        case self::GROUP_XORG:
+            return 'https://www.polytechnique.org/nl';
+        case self::GROUP_COMMUNITY:
+            return 'https://www.polytechnique.org/comletter';
+        case self::GROUP_AX:
+            return 'https://www.polytechnique.org/ax';
+        case self::GROUP_EP:
+            return 'https://www.polytechnique.org/epletter';
+        case self::GROUP_FX:
+            return 'https://www.polytechnique.org/fxletter';
+        default:
+            return 'http://www.polytechnique.net/' . $this->group . '/nl';
+        }
+    }
+
     /** Get links for nl pages.
      */
     public function adminLinks()
@@ -1231,6 +1251,8 @@ class NLIssue
      */
     public function sendTo($user, $hash = null)
     {
+        global $globals;
+
         // Don't send email to users without an address
         // Note: this would never happen when using sendToAll
         if (!$user->bestEmail()) {
@@ -1264,6 +1286,21 @@ class NLIssue
         if (!empty($this->reply_to)) {
             $mailer->addHeader('Reply-To', $this->reply_to);
         }
+
+        // Add mailing list headers
+        // Note: "Precedence: bulk" is known to cause issues on some clients
+        $mailer->addHeader('Precedence', 'list');
+        // RFC 2919 header
+        $mailer->addHeader('List-Id', $this->nl->group .
+            ' <' . $this->nl->group . '.newsletter.' . $globals->mail->domain . '>');
+        // RFC 2369 headers
+        $listurl = $this->nl->fullUrl();
+        $mailer->addHeader('List-Unsubscribe', '<' . $listurl . '/out/nohash/' . $this->id . '>');
+        $mailer->addHeader('List-Subscribe', '<' . $listurl. '/in/nohash/' . $this->id . '>');
+        $mailer->addHeader('List-Archive', '<' . $listurl . '>');
+        $mailer->addHeader('List-Help', '<' . $listurl . '>');
+        $mailer->addHeader('List-Owner', '<mailto:support@' . $globals->mail->domain . '>');
+
         $mailer->sendTo($user);
     }
 
@@ -1301,11 +1338,16 @@ class NLIssue
                        WHERE  id = {?}',
                        $this->id);
 
+        // Every minute, select BATCH_SIZE users who:
+        // * are subscribed to the newsletter
+        // * have not yet been mailed this issue of the newsletter
+        // * have a valid email address
+        // ... and send them the current issue.
+        // Once a mail is sent, newsletter_ins is updated to prevent selecting again the same user a minute later.
         $ufc = new PFC_And($this->getRecipientsUFC(), new UFC_NLSubscribed($this->nl->id, $this->id), new UFC_HasValidEmail());
         $uf = new UserFilter($ufc, array(new UFO_IsAdmin(true), new UFO_Uid()));
         $limit = new PlLimit(self::BATCH_SIZE);
         $global_sent = array();
-
         while (true) {
             $sent = array();
             $users = $uf->getUsers($limit);
@@ -1314,6 +1356,14 @@ class NLIssue
             }
             foreach ($users as $user) {
                 if (array_key_exists($user->id(), $global_sent)) {
+                    // Such a condition may happen if an user:
+                    // 1. was mailed the issue,
+                    // 2. unsubscribed the newsletter,
+                    // 3. subscribed again before the sending was done.
+                    // Such a case is reported by mail to people who monitor the website.
+                    // If you are reading this comment because of such a mail and the lines above explain what happened,
+                    // you only need to reset the state of the issue to "pending".
+                    // A cron script will then restart the mailing from where it stopped and only the problematic user will reveive the issue twice.
                     Platal::page()->kill('Sending the same newsletter issue ' . $this->id . ' to user ' . $user->id() . ' twice, something must be wrong.');
                 }
                 $sent[] = $user->id();