source: spip-zone/_plugins_/mailshot/trunk/bulkmailer/mandrill.php @ 68925

Last change on this file since 68925 was 68925, checked in by cedric@…, 7 years ago

quand on utilise le tracking avec mandrill, activer track_opens et track_clicks pour cet envoi (permet de le garder desactivé dans le réglage général du compte)

File size: 13.7 KB
Line 
1<?php
2/**
3 * Plugin MailShot
4 * (c) 2012 Cedric Morin
5 * Licence GNU/GPL
6 */
7
8if (!defined('_ECRIRE_INC_VERSION')) return;
9include_spip("inc/config");
10include_spip("inc/json"); // compat avec les PHP sans json_truc
11include_spip("classes/facteur");
12include_spip("lib/mandrill-api-php/src/Mandrill");
13
14/**
15 * @param array $to_send
16 *   string email
17 *   string sujet
18 *   string html
19 *   string texte
20 * @param array $options
21 *   bool filtre_images
22 *   array smtp
23 *     string host
24 *     string port
25 *     string auth
26 *     string username
27 *     string password
28 *     string secure
29 *     string errorsto
30 *   string adresse_envoi_nom
31 *   string adresse_envoi_email
32 * @return Facteur
33 */
34function &bulkmailer_mandrill_dist($to_send,$options=array()){
35        static $config = null;
36        static $mailer_defaut;
37        if (is_null($config)){
38                $config = lire_config("mailshot/");
39                $mailer_defaut = charger_fonction("defaut","bulkmailer");
40        }
41
42        // on ecrase le smtp avec celui de la config
43        $options['sender_class'] = "FacteurMandrill";
44        return $mailer_defaut($to_send,$options);
45
46}
47
48/**
49 * Prendre en charge le webhook mandrill
50 *
51 * @param $arg
52 */
53function bulkmailer_mandrill_webhook_dist($arg){
54
55        if ($_SERVER['REQUEST_METHOD'] == 'HEAD'){
56                http_status(200);
57                exit;
58        }
59
60        $events = _request('mandrill_events');
61        spip_log("bulkmailer_mandrill_webhook_dist $events","mailshot");
62
63        include_spip("inc/json");
64        $events = json_decode($events, true);
65
66        #spip_log("bulkmailer_mandrill_webhook_dist ".var_export($events,true),"mailshot");
67
68        foreach ($events as $event){
69                $quoi = $event['event'];
70                if ($quoi=="open") $quoi=="read"; // open chez mandrill, read ici
71                if ($quoi=="click") $quoi=="clic"; // click chez mandrill, clic ici
72
73                $email = $event['msg']['email'];
74                $tags = $event['msg']['tags'];
75                if (count($tags)){
76                        $tracking_id = end($tags);
77                        $tracking_id = explode('/#',$tracking_id);
78                        if (reset($tracking_id)==protocole_implicite($GLOBALS['meta']['adresse_site'])){
79                                $tracking_id = end($tracking_id);
80                                spip_log("tracking $quoi $email $tracking_id",'mailshot');
81                                // appeler l'api webhook mailshot
82                                $feedback = charger_fonction("feedback","newsletter");
83                                $feedback($quoi,$email,$tracking_id);
84                        }
85                }
86        }
87}
88
89
90/**
91 * Initialiser mandrill : declarer un webhook pour recuperer les retours sur bounce, reject, open, clic....
92 *
93 * @param int $id_mailshot
94 * @return bool
95 */
96function bulkmailer_mandrill_init_dist($id_mailshot=0){
97        $api_key = lire_config("mailshot/mandrill_api_key");
98        $mandrill = new Mandrill($api_key);
99
100        spip_log("bulkmailer_mandrill_init_dist $id_mailshot","mailshot");
101
102        //WARNING: this would prevent curl from detecting a 'man in the middle' attack
103        curl_setopt($mandrill->ch, CURLOPT_SSL_VERIFYHOST, 0);
104        curl_setopt($mandrill->ch, CURLOPT_SSL_VERIFYPEER, 0);
105
106        // recuperer les webhooks existants
107        try {
108                $list = $mandrill->webhooks->getList();
109        }
110        catch (Exception $e) {
111                spip_log($e="Mandrill Exception ".$e->getMessage(),"mailshot"._LOG_ERREUR);
112    return false;
113  }
114
115        // son webhook
116        $url = url_absolue(_DIR_RACINE."mailshot_webhook.api/mandrill/");
117        $events = array(/*"send",*/"hard_bounce", "soft_bounce", "open", "click", "spam", "reject");
118
119        // chercher si un webhook deja existant avec cette url, et si les events sont ok
120        if (count($list)){
121                foreach ($list as $l){
122                        if ($l['url']==$url){
123                                $e = $l['events'];
124                                if (!count(array_diff($e,$events)) AND !count(array_diff($events,$e)))
125                                        return true;
126
127                                // la liste des events est non ok : supprimer ce webhook
128                                try {
129                                        $mandrill->webhooks->delete($l['id']);
130                                }
131                                catch (Exception $e) {
132                                        spip_log($e="Mandrill Exception ".$e->getMessage(),"mailshot"._LOG_ERREUR);
133                            return false;
134                          }
135                        }
136                }
137        }
138
139        // donc on a pas de webhook pour ce site, on l'ajoute
140
141        if (count($events)){
142                try {
143                        $mandrill->webhooks->add($url,$events);
144                }
145                catch (Exception $e) {
146                        spip_log($e="Mandrill Exception ".$e->getMessage(),"mailshot"._LOG_ERREUR);
147            return false;
148          }
149
150                // Debug : on verifie
151                /*
152                try {
153                        $list = $mandrill->webhooks->getList();
154                }
155                catch (Exception $e) {
156                        spip_log($e="Mandrill Exception ".$e->getMessage(),"mailshot"._LOG_ERREUR);
157            return false;
158          }
159                */
160        }
161
162        return true;
163}
164
165
166class FacteurMandrill extends Facteur {
167
168        protected $message = array('to'=>array(),'headers'=>array());
169
170        protected function cleanAdress($address, $name = ''){
171                $address = trim($address);
172    $name = trim(preg_replace('/[\r\n]+/', '', $name)); //Strip breaks and trim
173                if (!self::ValidateAddress($address)) {
174                        $this->SetError('invalid_address'.': '. $address);
175                        return false;
176          }
177                return array($address,$name);
178        }
179
180        /**
181        * Adds a "To" address.
182        * @param string $address
183        * @param string $name
184        * @return boolean true on success, false if address already used
185        */
186        public function AddAddress($address, $name = '') {
187                if ($a = $this->cleanAdress($address,$name)){
188                        $this->message['to'][] = array('email'=>$address,'name'=>$name);
189                        return true;
190                }
191                return false;
192        }
193
194        /**
195        * Adds a "Cc" address.
196        * Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
197        * @param string $address
198        * @param string $name
199        * @return boolean true on success, false if address already used
200        */
201        public function AddCC($address, $name = '') {
202                return $this->AddAddress($address, $name);
203        }
204
205        /**
206        * Adds a "Bcc" address.
207        * Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
208        * @param string $address
209        * @param string $name
210        * @return boolean true on success, false if address already used
211        */
212        public function AddBCC($address, $name = '') {
213                if ($a = $this->cleanAdress($address,$name)){
214                        $this->message['bcc_address'] = $address;
215                        return true;
216                }
217                return false;
218        }
219
220        /**
221        * Adds a "Reply-to" address.
222        * @param string $address
223        * @param string $name
224        * @return boolean
225        */
226        public function AddReplyTo($address, $name = '') {
227                if ($a = $this->cleanAdress($address,$name)){
228                        $this->message['headers']['ReplyTo'] = $address;
229                        return true;
230                }
231                return false;
232        }
233
234        /**
235        * Adds a custom header.
236        * @access public
237        * @return void
238        */
239        public function AddCustomHeader($custom_header) {
240                list($key,$value) = explode(':', $custom_header, 2);
241                $this->message['headers'][$key] = trim($value);
242        }
243
244        /**
245         * @param array $options
246         *   options d'envoi
247         *     string tracking_id
248         * @return bool
249         */
250        public function Send($options) {
251                $api_key = lire_config("mailshot/mandrill_api_key");
252
253                /**
254   * Send a new transactional message through Mandrill
255   * @param struct $message the information on the message to send
256   *     - html string the full HTML content to be sent
257   *     - text string optional full text content to be sent
258   *     - subject string the message subject
259   *     - from_email string the sender email address.
260   *     - from_name string optional from name to be used
261   *     - to array an array of recipient information.
262   *         - to[] struct a single recipient's information.
263   *             - email string the email address of the recipient
264   *             - name string the optional display name to use for the recipient
265   *     - headers struct optional extra headers to add to the message (currently only Reply-To and X-* headers are allowed)
266   *     - track_opens boolean whether or not to turn on open tracking for the message
267   *     - track_clicks boolean whether or not to turn on click tracking for the message
268   *     - auto_text boolean whether or not to automatically generate a text part for messages that are not given text
269   *     - url_strip_qs boolean whether or not to strip the query string from URLs when aggregating tracked URL data
270   *     - preserve_recipients boolean whether or not to expose all recipients in to "To" header for each email
271   *     - bcc_address string an optional address to receive an exact copy of each recipient's email
272   *     - merge boolean whether to evaluate merge tags in the message. Will automatically be set to true if either merge_vars or global_merge_vars are provided.
273   *     - global_merge_vars array global merge variables to use for all recipients. You can override these per recipient.
274   *         - global_merge_vars[] struct a single global merge variable
275   *             - name string the global merge variable's name. Merge variable names are case-insensitive and may not start with _
276   *             - content string the global merge variable's content
277   *     - merge_vars array per-recipient merge variables, which override global merge variables with the same name.
278   *         - merge_vars[] struct per-recipient merge variables
279   *             - rcpt string the email address of the recipient that the merge variables should apply to
280   *             - vars array the recipient's merge variables
281   *                 - vars[] struct a single merge variable
282   *                     - name string the merge variable's name. Merge variable names are case-insensitive and may not start with _
283   *                     - content string the merge variable's content
284   *     - tags array an array of string to tag the message with.  Stats are accumulated using tags, though we only store the first 100 we see, so this should not be unique or change frequently.  Tags should be 50 characters or less.  Any tags starting with an underscore are reserved for internal use and will cause errors.
285   *         - tags[] string a single tag - must not start with an underscore
286   *     - google_analytics_domains array an array of strings indicating for which any matching URLs will automatically have Google Analytics parameters appended to their query string automatically.
287   *     - google_analytics_campaign array|string optional string indicating the value to set for the utm_campaign tracking parameter. If this isn't provided the email's from address will be used instead.
288   *     - metadata array metadata an associative array of user metadata. Mandrill will store this metadata and make it available for retrieval. In addition, you can select up to 10 metadata fields to index and make searchable using the Mandrill search api.
289   *     - recipient_metadata array Per-recipient metadata that will override the global values specified in the metadata parameter.
290   *         - recipient_metadata[] struct metadata for a single recipient
291   *             - rcpt string the email address of the recipient that the metadata is associated with
292   *             - values array an associated array containing the recipient's unique metadata. If a key exists in both the per-recipient metadata and the global metadata, the per-recipient metadata will be used.
293   *     - attachments array an array of supported attachments to add to the message
294   *         - attachments[] struct a single supported attachment
295   *             - type string the MIME type of the attachment - allowed types are text/*, image/*, and application/pdf
296   *             - name string the file name of the attachment
297   *             - content string the content of the attachment as a base64-encoded string
298   * @param boolean $async enable a background sending mode that is optimized for bulk sending. In async mode, messages/send will immediately return a status of "queued" for every recipient. To handle rejections when sending in async mode, set up a webhook for the 'reject' event. Defaults to false for messages with fewer than 100 recipients; messages with more than 100 recipients are always sent asynchronously, regardless of the value of async.
299   * @return array of structs for each recipient containing the key "email" with the email address and "status" as either "sent", "queued", or "rejected"
300   *     - return[] struct the sending results for a single recipient
301   *         - email string the email address of the recipient
302   *         - status string the sending status of the recipient - either "sent", "queued", "rejected", or "invalid"
303   */
304                $this->message['html'] = $this->Body;
305                $this->message['text'] = $this->AltBody;
306                $this->message['subject'] = $this->Subject;
307                $this->message['from_email'] = $this->From;
308                $this->message['from_name'] = $this->FromName;
309
310                // ajouter le tracking_id en tag, pour retrouver le message apres webhook
311                if (isset($options['tracking_id'])
312                  AND $id = $options['tracking_id']){
313                        $this->message['track_opens'] = true;
314                        $this->message['track_clicks'] = true;
315                        // prefixer le tracking par l'url du site pour ne pas melanger les feedbacks
316                        $this->message['tags'][] = protocole_implicite($GLOBALS['meta']['adresse_site'])."/#".$options['tracking_id'];
317                }
318
319                $mandrill = new Mandrill($api_key);
320
321                //WARNING: this would prevent curl from detecting a 'man in the middle' attack
322                curl_setopt($mandrill->ch, CURLOPT_SSL_VERIFYHOST, 0);
323                curl_setopt($mandrill->ch, CURLOPT_SSL_VERIFYPEER, 0);
324
325                try {
326                        $res = $mandrill->messages->send($this->message, false);
327                }
328                catch (Exception $e) {
329      $this->SetError($e->getMessage());
330      return false;
331    }
332
333                spip_log("FacteurMandrill->Send resultat:".var_export($res,true),"mailshot");
334
335                // statut d'erreur au premier niveau ?
336                if (isset($res['status'])){
337                        switch ($res['status']){
338                                case 'error':
339                                        $this->SetError($res['name'].": ".$res['message']);
340                                        return false;
341                                        break;
342                                default:
343                                        $this->SetError("??????".var_export($res,true));
344                                        return false;
345                                        break;
346                        }
347                }
348
349                // sinon regarder le status du premier mail envoye (le to)
350                // ici on ne gere qu'un destinataire
351                $rmail = reset($res);
352                switch ($rmail['status']){
353                        case 'invalid':
354                                $this->SetError("invalid");
355                                return false;
356                                break;
357                        case 'rejected':
358                                $this->SetError("rejected");
359                                return false;
360                                break;
361                        case "sent":
362                        case "queued":
363                                return true;
364                                break;
365                }
366
367                // ici on ne sait pas ce qu'il s'est passe !
368                $this->SetError("??????".var_export($res,true));
369                spip_log("FacteurMandrill->Send resultat inatendu : ".var_export($res,true),"mailshot"._LOG_ERREUR);
370                return false;
371
372        }
373
374        public function CreateHeader(){}
375}
Note: See TracBrowser for help on using the repository browser.