dolibarr 24.0.2
CMailFile.class.php
Go to the documentation of this file.
1<?php
35use OAuth\Common\Storage\DoliStorage;
36use OAuth\Common\Consumer\Credentials;
37
44{
46 public $sendcontext;
48 public $sendmode;
53 public $sendsetup;
54
58 public $subject;
65 public $addr_from;
66
67 // Return-Path: Email where to send bounds.
68
70 public $reply_to;
72 public $errors_to;
74 public $addr_to;
76 public $addr_cc;
78 public $addr_bcc;
80 public $trackid;
81
83 public $mixed_boundary;
85 public $related_boundary;
87 public $alternative_boundary;
89 public $deliveryreceipt;
90
92 public $atleastonefile;
93
95 public $msg;
97 public $eol;
99 public $eol2;
100
104 public $error = '';
105
109 public $errors = array();
110
114 public $smtps;
118 public $mailer;
119
123 public $transport;
127 public $logger;
128
132 public $css;
134 public $styleCSS;
136 public $bodyCSS;
137
141 public $msgid;
142
146 public $in_reply_to;
147
151 public $references;
152
156 public $headers;
157
161 public $message;
162
166 public $filename_list = array();
170 public $mimetype_list = array();
174 public $mimefilename_list = array();
178 public $cid_list = array();
179
181 public $html;
183 public $msgishtml;
185 public $image_boundary;
187 public $atleastoneimage = 0; // at least one image file with file=xxx.ext into content (TODO Debug this. How can this case be tested. Remove if not used).
189 public $html_images = array();
191 public $images_encoded = array();
193 public $image_types = array(
194 'gif' => 'image/gif',
195 'jpg' => 'image/jpeg',
196 'jpeg' => 'image/jpeg',
197 'jpe' => 'image/jpeg',
198 'bmp' => 'image/bmp',
199 'png' => 'image/png',
200 'tif' => 'image/tiff',
201 'tiff' => 'image/tiff',
202 'webp' => 'image/webp',
203 );
204
229 public function __construct($subject, $to, $from, $msg, $filename_list = array(), $mimetype_list = array(), $mimefilename_list = array(), $addr_cc = "", $addr_bcc = "", $deliveryreceipt = 0, $msgishtml = 0, $errors_to = '', $css = '', $trackid = '', $moreinheader = '', $sendcontext = 'standard', $replyto = '', $upload_dir_tmp = '', $in_reply_to = '', $references = '')
230 {
231 global $conf, $dolibarr_main_data_root, $user;
232
233 dol_syslog("CMailFile::CMailFile: charset=".$conf->file->character_set_client." from=$from, to=$to, addr_cc=$addr_cc, addr_bcc=$addr_bcc, errors_to=$errors_to, replyto=$replyto trackid=$trackid sendcontext=$sendcontext");
234 dol_syslog("CMailFile::CMailFile: subject=".$subject.", deliveryreceipt=".$deliveryreceipt.", msgishtml=".$msgishtml, LOG_DEBUG);
235
236 // Clean values of $mimefilename_list
237 if (is_array($mimefilename_list)) {
238 foreach ($mimefilename_list as $key => $val) {
239 $mimefilename_list[$key] = dol_string_unaccent($mimefilename_list[$key]);
240 }
241 }
242
243 $cid_list = array();
244
245 $this->sendcontext = $sendcontext;
246
247 // Define this->sendmode ('mail', 'smtps', 'swiftmailer', ...) according to $sendcontext ('standard', 'emailing', 'ticket', 'passwordreset')
248 $this->sendmode = '';
249 if (!empty($this->sendcontext)) {
250 $smtpContextKey = strtoupper($this->sendcontext);
251 $smtpContextSendMode = getDolGlobalString('MAIN_MAIL_SENDMODE_'.$smtpContextKey);
252 if (!empty($smtpContextSendMode) && $smtpContextSendMode != 'default') {
253 $this->sendmode = $smtpContextSendMode;
254 }
255 }
256 if (empty($this->sendmode)) {
257 $this->sendmode = getDolGlobalString('MAIN_MAIL_SENDMODE', 'mail');
258 }
259
260 // Add a Feedback-ID. Must be used for stats on spam report only.
261 if ($trackid) {
262 //Examples:
263 // LinkedIn – Feedback-ID: accept_invite_04:linkedin
264 // Twitter – Feedback-ID: 0040162518f58f41d1f0:15491f3b2ee48656f8e7fb2fac:none:twitterESP
265 // Amazon.com : Feedback-ID: 1.eu-west-1.kjoQSiqb8G+7lWWiDVsxjM2m0ynYd4I6yEFlfoox6aY=:AmazonSES
266 $moreinheader .= "Feedback-ID: ".$trackid.':'.dol_getprefix('email').":dolib\r\n";
267 }
268
269 // We define end of line (RFC 821).
270 $this->eol = "\r\n";
271 // We define end of line for header fields (RFC 822bis section 2.3 says header must contains \r\n).
272 $this->eol2 = "\r\n";
273 if (getDolGlobalString('MAIN_FIX_FOR_BUGGED_MTA')) {
274 $this->eol = "\n";
275 $this->eol2 = "\n";
276 $moreinheader = str_replace("\r\n", "\n", $moreinheader);
277 }
278
279 // On defini mixed_boundary
280 $this->mixed_boundary = "multipart_x.".time().".x_boundary";
281
282 // On defini related_boundary
283 $this->related_boundary = 'mul_'.dol_hash(uniqid("dolibarr2"), '3'); // Force md5 hash (does not contain special chars)
284
285 // On defini alternative_boundary
286 $this->alternative_boundary = 'mul_'.dol_hash(uniqid("dolibarr3"), '3'); // Force md5 hash (does not contain special chars)
287
288 if (empty($subject)) {
289 dol_syslog("CMailFile::CMailFile: Try to send an email with empty subject");
290 $this->error = 'ErrorSubjectIsRequired';
291 return;
292 }
293 if (empty($msg)) {
294 dol_syslog("CMailFile::CMailFile: Try to send an email with empty body");
295 $msg = '.'; // Avoid empty message (with empty message content, you will see a multipart structure)
296 }
297
298 // Detect if message is HTML (use fast method)
299 if ($msgishtml == -1) {
300 $this->msgishtml = 0;
301 if (dol_textishtml($msg)) {
302 $this->msgishtml = 1;
303 }
304 } else {
305 $this->msgishtml = $msgishtml;
306 }
307
309
310 // Define $urlwithroot
311 $urlwithouturlroot = preg_replace('/'.preg_quote(DOL_URL_ROOT, '/').'$/i', '', trim($dolibarr_main_url_root));
312 $urlwithroot = $urlwithouturlroot.DOL_URL_ROOT; // This is to use external domain name found into config file
313 //$urlwithroot=DOL_MAIN_URL_ROOT; // This is to use same domain name than current
314
315 // Replace relative /viewimage to absolute path
316 $msg = preg_replace('/src="'.preg_quote(DOL_URL_ROOT, '/').'\/viewimage\.php/ims', 'src="'.$urlwithroot.'/viewimage.php', $msg, -1);
317
318 if (getDolGlobalString('MAIN_MAIL_FORCE_CONTENT_TYPE_TO_HTML')) {
319 $this->msgishtml = 1; // To force to send everything with content type html.
320 }
321 dol_syslog("CMailFile::CMailFile: msgishtml=".$this->msgishtml, LOG_DEBUG);
322
323 // Detect images
324 if ($this->msgishtml) {
325 $this->html = $msg;
326
327 $findimg = 0;
328 if (getDolGlobalString('MAIN_MAIL_ADD_INLINE_IMAGES_IF_IN_MEDIAS')) { // Off by default
329 // Search into the body for <img tags of links in medias files to replace them with an embedded file
330 // Note because media links are public, this should be useless, except avoid blocking images with email browser.
331 // This converts an embed file with src="/viewimage.php?modulepart... into a cid link
332 // TODO Exclude viewimage used for the read tracker ?
333 $dolibarr_main_data_root_images = $dolibarr_main_data_root;
334 if ((int) $conf->entity !== 1) {
335 $dolibarr_main_data_root_images .= '/'.$conf->entity.'/';
336 }
337 $findimg = $this->findHtmlImages($dolibarr_main_data_root_images.'/medias');
338 if ($findimg < 0) {
339 dol_syslog("CMailFile::CMailFile: Error on findHtmlImages");
340 $this->error = 'ErrorInAddAttachmentsImageBaseOnMedia';
341 return;
342 }
343 }
344
345 if (getDolGlobalString('MAIN_MAIL_ADD_INLINE_IMAGES_IF_DATA')) { // On by default because Gmail does not support src="data:image..."
346 // Search into the body for <img src="data:image/ext;base64,..." to replace them with an embedded file
347 // This convert an embedded file with src="data:image... into a cid link + attached file.
348 // It modifies ->html and complete ->html_images
349 $resultImageData = $this->findHtmlImagesIsSrcData($upload_dir_tmp);
350 if ($resultImageData < 0) {
351 dol_syslog("CMailFile::CMailFile: Error on findHtmlImagesInSrcData code=".$resultImageData." upload_dir_tmp=".$upload_dir_tmp);
352 $this->error = 'ErrorInAddAttachmentsImageBaseIsSrcData';
353 return;
354 }
355 $findimg += $resultImageData;
356 }
357
358 // Set atleastoneimage if there is at least one embedded file (into ->html_images)
359 if ($findimg > 0) {
360 foreach ($this->html_images as $i => $val) {
361 if ($this->html_images[$i]) {
362 $this->atleastoneimage = 1;
363 if ($this->html_images[$i]['type'] == 'cidfromdata') {
364 if (!in_array($this->html_images[$i]['fullpath'], $filename_list)) {
365 // If this file path is not already into the $filename_list, we append it at end of array
366 $posindice = count($filename_list);
367 $filename_list[$posindice] = $this->html_images[$i]['fullpath'];
368 $mimetype_list[$posindice] = $this->html_images[$i]['content_type'];
369 $mimefilename_list[$posindice] = $this->html_images[$i]['name'];
370 } else {
371 $posindice = array_search($this->html_images[$i]['fullpath'], $filename_list);
372 }
373 // We complete the array of cid_list
374 $cid_list[$posindice] = $this->html_images[$i]['cid'];
375 }
376 dol_syslog("CMailFile::CMailFile: html_images[$i]['name']=".$this->html_images[$i]['name'], LOG_DEBUG);
377 }
378 }
379 }
380 }
381 //var_dump($filename_list);
382 //var_dump($cid_list);exit;
383
384 // Set atleastoneimage if there is at least one file (into $filename_list array)
385 if (is_array($filename_list)) {
386 foreach ($filename_list as $i => $val) {
387 if ($filename_list[$i]) {
388 $this->atleastonefile = 1;
389 dol_syslog("CMailFile::CMailFile: filename_list[$i]=".$filename_list[$i].", mimetype_list[$i]=".$mimetype_list[$i]." mimefilename_list[$i]=".$mimefilename_list[$i]." cid_list[$i]=".(empty($cid_list[$i]) ? '' : $cid_list[$i]), LOG_DEBUG);
390 }
391 }
392 }
393
394 // Add auto copy to if not already in $to (Note: Adding bcc for specific modules are also done from pages)
395 // For example MAIN_MAIL_AUTOCOPY_TO can be 'email@example.com, __USER_EMAIL__, ...'
396 if (getDolGlobalString('MAIN_MAIL_AUTOCOPY_TO')) {
397 $listofemailstoadd = explode(',', getDolGlobalString('MAIN_MAIL_AUTOCOPY_TO'));
398 foreach ($listofemailstoadd as $key => $val) {
399 $emailtoadd = $listofemailstoadd[$key];
400 if (trim($emailtoadd) == '__USER_EMAIL__') {
401 if (!empty($user) && !empty($user->email)) {
402 $emailtoadd = $user->email;
403 } else {
404 $emailtoadd = '';
405 }
406 }
407 if ($emailtoadd && preg_match('/'.preg_quote($emailtoadd, '/').'/i', $to)) {
408 $emailtoadd = ''; // Email already in the "To"
409 }
410 if ($emailtoadd) {
411 $listofemailstoadd[$key] = $emailtoadd;
412 } else {
413 unset($listofemailstoadd[$key]);
414 }
415 }
416 if (!empty($listofemailstoadd)) {
417 $addr_bcc .= ($addr_bcc ? ', ' : '').implode(', ', $listofemailstoadd);
418 }
419 }
420
421 // Verify if $to, $addr_cc and addr_bcc have unwanted addresses
422 if (getDolGlobalString('MAIN_MAIL_FORCE_NOT_SENDING_TO')) {
423 // Parse to, cc and bcc to remove MAIN_MAIL_FORCE_NOT_SENDING_TO
424 $listofemailstonotsendto = explode(',', getDolGlobalString('MAIN_MAIL_FORCE_NOT_SENDING_TO'));
425
426 //Verify for $to
427 $replaceto = false;
428 $tabto = explode(",", $to);
429 foreach ($tabto as $key => $addrto) {
430 $addrto = array_keys($this->getArrayAddress($addrto));
431 if (in_array($addrto[0], $listofemailstonotsendto)) {
432 unset($tabto[$key]);
433 $replaceto = true;
434 }
435 }
436 if ($replaceto && getDolGlobalString('MAIN_MAIL_FORCE_NOT_SENDING_TO_REPLACE')) {
437 $tabto[] = getDolGlobalString('MAIN_MAIL_FORCE_NOT_SENDING_TO_REPLACE');
438 }
439 $to = implode(',', $tabto);
440
441 //Verify for $addr_cc
442 $replacecc = false;
443 $tabcc = explode(',', $addr_cc);
444 foreach ($tabcc as $key => $cc) {
445 $cc = array_keys($this->getArrayAddress($cc));
446 if (in_array($cc[0], $listofemailstonotsendto)) {
447 unset($tabcc[$key]);
448 $replacecc = true;
449 }
450 }
451 if ($replacecc && getDolGlobalString('MAIN_MAIL_FORCE_NOT_SENDING_TO_REPLACE')) {
452 $tabcc[] = getDolGlobalString('MAIN_MAIL_FORCE_NOT_SENDING_TO_REPLACE');
453 }
454 $addr_cc = implode(',', $tabcc);
455
456 //Verify for $addr_bcc
457 $replacebcc = false;
458 $tabbcc = explode(',', $addr_bcc);
459 foreach ($tabbcc as $key => $bcc) {
460 $bcc = array_keys($this->getArrayAddress($bcc));
461 if (in_array($bcc[0], $listofemailstonotsendto)) {
462 unset($tabbcc[$key]);
463 $replacebcc = true;
464 }
465 }
466 if ($replacebcc && getDolGlobalString('MAIN_MAIL_FORCE_NOT_SENDING_TO_REPLACE')) {
467 $tabbcc[] = getDolGlobalString('MAIN_MAIL_FORCE_NOT_SENDING_TO_REPLACE');
468 }
469 $addr_bcc = implode(',', $tabbcc);
470 }
471
472 // We always use a replyto
473 if (empty($replyto)) {
474 $replyto = dol_sanitizeEmail($from);
475 }
476 // We can force the from
477 if (getDolGlobalString('MAIN_MAIL_FORCE_FROM')) {
478 $from = getDolGlobalString('MAIN_MAIL_FORCE_FROM');
479 }
480
481 $this->subject = $subject;
482 $this->addr_to = dol_sanitizeEmail($to);
483 $this->addr_from = dol_sanitizeEmail($from);
484 $this->msg = $msg;
485 $this->addr_cc = dol_sanitizeEmail($addr_cc);
486 $this->addr_bcc = dol_sanitizeEmail($addr_bcc);
487 $this->deliveryreceipt = $deliveryreceipt;
488 $this->reply_to = dol_sanitizeEmail($replyto);
489 $this->errors_to = dol_sanitizeEmail($errors_to);
490 $this->trackid = $trackid;
491 $this->in_reply_to = $in_reply_to;
492 $this->references = $references;
493 // Set arrays with attached files info
494 $this->filename_list = $filename_list;
495 $this->mimetype_list = $mimetype_list;
496 $this->mimefilename_list = $mimefilename_list;
497 $this->cid_list = $cid_list;
498
499 if (getDolGlobalString('MAIN_MAIL_FORCE_SENDTO')) {
500 $this->addr_to = dol_sanitizeEmail(getDolGlobalString('MAIN_MAIL_FORCE_SENDTO'));
501 $this->addr_cc = '';
502 $this->addr_bcc = '';
503 }
504
505 $keyforsslseflsigned = 'MAIN_MAIL_EMAIL_SMTP_ALLOW_SELF_SIGNED';
506 if (!empty($this->sendcontext)) {
507 $smtpContextKey = strtoupper($this->sendcontext);
508 $smtpContextSendMode = getDolGlobalString('MAIN_MAIL_SENDMODE_'.$smtpContextKey);
509 if (!empty($smtpContextSendMode) && $smtpContextSendMode != 'default') {
510 $keyforsslseflsigned = 'MAIN_MAIL_EMAIL_SMTP_ALLOW_SELF_SIGNED_'.$smtpContextKey;
511 }
512 }
513
514 dol_syslog("CMailFile::CMailFile: sendmode=".$this->sendmode." addr_bcc=$addr_bcc, replyto=$replyto", LOG_DEBUG);
515
516 // We set all data according to chose sending method.
517 // We also set a value for ->msgid
518 if ($this->sendmode == 'mail') {
519 // Use mail php function (default PHP method)
520 // ------------------------------------------
521
522 $smtp_headers = "";
523 $mime_headers = "";
524 $text_body = "";
525 $files_encoded = "";
526
527 // Define smtp_headers (this also set SMTP headers from ->in_reply_to and ->references and set the property ->msgid)
528 $smtp_headers = $this->write_smtpheaders();
529 if (!empty($moreinheader)) {
530 $smtp_headers .= $moreinheader; // $moreinheader contains the \r\n
531 }
532
533 // Define mime_headers
534 $mime_headers = $this->write_mimeheaders($filename_list, $mimefilename_list);
535
536 if (!empty($this->html)) {
537 if (!empty($css)) {
538 $this->css = $css;
539 $this->buildCSS(); // Build a css style (mode = all) into this->styleCSS and this->bodyCSS
540 }
541
542 $msg = $this->html;
543 }
544
545 // Define body in text_body
546 $text_body = $this->write_body($msg);
547
548 // Add attachments to text_encoded
549 if (!empty($this->atleastonefile) && $filename_list !== null && $mimetype_list !== null && $mimefilename_list !== null) {
550 $files_encoded = $this->write_files($filename_list, $mimetype_list, $mimefilename_list, $cid_list);
551 }
552
553 // We now define $this->headers and $this->message
554 $this->headers = $smtp_headers.$mime_headers;
555 // Clean the header to avoid that it terminates with a CR character.
556 // This avoid also empty lines at end that can be interpreted as mail injection by email servers.
557 $this->headers = preg_replace("/([\r\n]+)$/i", "", $this->headers);
558
559 //$this->message = $this->eol.'This is a message with multiple parts in MIME format.'.$this->eol;
560 $this->message = 'This is a message with multiple parts in MIME format.'.$this->eol;
561 $this->message .= $text_body.$files_encoded;
562 $this->message .= "--".$this->mixed_boundary."--".$this->eol;
563 } elseif ($this->sendmode == 'smtps') {
564 // Use SMTPS library
565 // ------------------------------------------
566 $host = dol_getprefix('email');
567
568 require_once DOL_DOCUMENT_ROOT.'/core/class/smtps.class.php';
569 $smtps = new SMTPs();
570 $smtps->setCharSet($conf->file->character_set_client);
571
572 // Encode subject if required.
573 $subjecttouse = $this->subject;
574 if (!ascii_check($subjecttouse)) {
575 $subjecttouse = $this->encodetorfc2822($subjecttouse);
576 }
577
578 $smtps->setSubject($subjecttouse);
579 $smtps->setTO($this->getValidAddress($this->addr_to, 0, 1));
580 $smtps->setFrom($this->getValidAddress($this->addr_from, 0, 1));
581 $smtps->setReplyTo($this->getValidAddress($this->reply_to, 0, 1));
582
583 $smtps->setTrackId($this->trackid);
584
585 if (!empty($this->in_reply_to)) {
586 $smtps->setInReplyTo($this->in_reply_to);
587 }
588 if (!empty($this->references)) {
589 // SMTPs expects the list of Message-IDs as an array
590 $smtps->setReferences(preg_split('/[\s,]+/', trim($this->references), -1, PREG_SPLIT_NO_EMPTY));
591 }
592
593 if (!empty($moreinheader)) {
594 $smtps->setMoreInHeader($moreinheader);
595 }
596
597 //X-Dolibarr-TRACKID, In-Reply-To, References and $moreinheader will be added to header inside the smtps->getHeader
598
599 if (!empty($this->html)) {
600 if (!empty($css)) {
601 $this->css = $css;
602 $this->buildCSS();
603 }
604 $msg = $this->html;
605 $msg = $this->checkIfHTML($msg); // This add a header and a body including custom CSS to the HTML content
606 }
607
608 if ($msg === '.') {
609 $msg = "\n.\n";
610 }
611 // Replace . alone on a new line with .. to avoid to have SMTP interpret this as end of message
612 $msg = preg_replace('/(\r|\n)\.(\r|\n)/ims', '\1..\2', $msg);
613
614 if ($this->msgishtml) {
615 $smtps->setBodyContent($msg, 'html');
616 } else {
617 $smtps->setBodyContent($msg, 'plain');
618 }
619
620 if (!empty($this->atleastoneimage)) {
621 foreach ($this->images_encoded as $img) {
622 $smtps->setImageInline($img['image_encoded'], $img['name'], $img['content_type'], $img['cid']);
623 }
624 }
625
626 if (!empty($this->atleastonefile)) {
627 foreach ($filename_list as $i => $val) {
628 $content = file_get_contents($filename_list[$i]);
629 if (empty($cid_list[$i])) {
630 $smtps->setAttachment($content, $mimefilename_list[$i], $mimetype_list[$i], (empty($cid_list[$i]) ? '' : $cid_list[$i]));
631 }
632 }
633 }
634
635 $smtps->setCC($this->addr_cc);
636 $smtps->setBCC($this->addr_bcc);
637 $smtps->setErrorsTo($this->errors_to);
638 $smtps->setDeliveryReceipt($this->deliveryreceipt);
639
640 $options = array();
641 if (getDolGlobalString($keyforsslseflsigned)) {
642 $options = array('ssl' => array('verify_peer' => false, 'verify_peer_name' => false, 'allow_self_signed' => true));
643 }
644 if (getDolGlobalString('SMTPS_CAPTURE_PEER_CERT')) {
645 $options = array_merge($options, array('ssl' => array('capture_peer_cert' => true, 'capture_peer_cert_chain' => true)));
646 // Adding this will allow the code to retrieve information about the TLS certificate by doing
647 // $cert = stream_context_get_params($this->socket)['options']['ssl']['peer_certificate'];
648 // echo "Server Certificate Information:\n";
649 // echo "Subject: " . openssl_x509_parse($cert)['subject']['CN'] . "\n";
650 // echo "Issuer: " . openssl_x509_parse($cert)['issuer']['CN'] . "\n";
651 // echo "Valid From: " . date('Y-m-d H:i:s', openssl_x509_parse($cert)['validFrom_time_t']) . "\n";
652 // echo "Valid To: " . date('Y-m-d H:i:s', openssl_x509_parse($cert)['validTo_time_t']) . "\n";
653 }
654 if (getDolGlobalString('SMTPS_FORCE_IP_V4')) {
655 $options = array_merge($options, array('socket' => ['bindto' => '0.0.0.0:0'])); // Forces IPv4 (IPv6 would be '::0')
656 }
657 if (!empty($options)) {
658 $smtps->setOptions($options);
659 }
660
661 $this->msgid = uniqid('', true).'.SMTPs-dolibarr-'.$this->trackid.'@'.$host;
662
663 $smtps->setMessageID($this->msgid);
664
665 $this->smtps = $smtps;
666 } elseif ($this->sendmode == 'swiftmailer') {
667 // Use Swift Mailer library
668 // ------------------------------------------
669 $host = dol_getprefix('email');
670
671 require_once DOL_DOCUMENT_ROOT.'/includes/swiftmailer/lexer/lib/Doctrine/Common/Lexer/AbstractLexer.php';
672
673 // egulias autoloader lib
674 require_once DOL_DOCUMENT_ROOT.'/includes/swiftmailer/autoload.php';
675
676 require_once DOL_DOCUMENT_ROOT.'/includes/swiftmailer/lib/swift_required.php';
677
678 // Create the message
679 //$this->message = Swift_Message::newInstance();
680 $this->message = new Swift_Message();
681 //$this->message = new Swift_SignedMessage();
682 // Adding a trackid header to a message
683 $headers = $this->message->getHeaders();
684
685 $headers->addTextHeader('X-Dolibarr-TRACKID', $this->trackid.'@'.$host);
686 $this->msgid = uniqid('', true).'.swiftmailer-dolibarr-'.$this->trackid.'@'.$host;
687 $headerID = $this->msgid;
688 $msgid = $headers->get('Message-ID');
689 if ($msgid instanceof Swift_Mime_Headers_IdentificationHeader) {
690 $msgid->setId($headerID);
691 }
692
693 // Add 'In-Reply-To:' header
694 // Swift adds the angle brackets itself and rejects an id that still has them
695 if (!empty($this->in_reply_to)) {
696 $headers->addIdHeader('In-Reply-To', trim($this->in_reply_to, " \t<>"));
697 }
698 // Add 'References:' header
699 if (!empty($this->references)) {
700 $references = array();
701 foreach (preg_split('/[\s,]+/', trim($this->references), -1, PREG_SPLIT_NO_EMPTY) as $reference) {
702 $references[] = trim($reference, '<>');
703 }
704 $headers->addIdHeader('References', $references);
705 }
706
707 if (!empty($moreinheader)) {
708 $moreinheaderarray = preg_split('/[\r\n]+/', $moreinheader);
709 foreach ($moreinheaderarray as $moreinheaderval) {
710 $moreinheadervaltmp = explode(':', $moreinheaderval, 2);
711 if (!empty($moreinheadervaltmp[0]) && !empty($moreinheadervaltmp[1])) {
712 $headers->addTextHeader($moreinheadervaltmp[0], $moreinheadervaltmp[1]);
713 }
714 }
715 }
716
717 // Give the message a subject
718 try {
719 $this->message->setSubject($this->subject);
720 } catch (Exception $e) {
721 $this->errors[] = $e->getMessage();
722 }
723
724 // Set the From address with an associative array
725 // $this->message->setFrom(array('john@doe.com' => 'John Doe'));
726 if (!empty($this->addr_from)) {
727 try {
728 if (getDolGlobalString('MAIN_FORCE_DISABLE_MAIL_SPOOFING')) {
729 // Prevent email spoofing for smtp server with a strict configuration
730 $regexp = '/([a-z0-9_\.\-\+])+\@(([a-z0-9\-])+\.)+([a-z0-9]{2,4})+/i'; // This regular expression extracts all emails from a string
731 $adressEmailFrom = array();
732 $emailMatchs = preg_match_all($regexp, $from, $adressEmailFrom);
733 $adressEmailFrom = reset($adressEmailFrom);
734 if ($emailMatchs !== false && filter_var(getDolGlobalString('MAIN_MAIL_SMTPS_ID'), FILTER_VALIDATE_EMAIL) && getDolGlobalString('MAIN_MAIL_SMTPS_ID') !== $adressEmailFrom[0]) {
735 $this->message->setFrom(getDolGlobalString('MAIN_MAIL_SMTPS_ID'));
736 } else {
737 $this->message->setFrom($this->getArrayAddress($this->addr_from));
738 }
739 } else {
740 $this->message->setFrom($this->getArrayAddress($this->addr_from));
741 }
742 } catch (Exception $e) {
743 $this->errors[] = $e->getMessage();
744 }
745 }
746
747 // Set the To addresses with an associative array
748 if (!empty($this->addr_to)) {
749 try {
750 $this->message->setTo($this->getArrayAddress($this->addr_to));
751 } catch (Exception $e) {
752 $this->errors[] = $e->getMessage();
753 }
754 }
755
756 if (!empty($this->reply_to)) {
757 try {
758 $this->message->SetReplyTo($this->getArrayAddress($this->reply_to));
759 } catch (Exception $e) {
760 $this->errors[] = $e->getMessage();
761 }
762 }
763
764 if (!empty($this->errors_to)) {
765 try {
766 $headers->addMailboxHeader('Errors-To', $this->getArrayAddress($this->errors_to));
767 } catch (Exception $e) {
768 $this->errors[] = $e->getMessage();
769 }
770 }
771
772 try {
773 $this->message->setCharSet($conf->file->character_set_client);
774 } catch (Exception $e) {
775 $this->errors[] = $e->getMessage();
776 }
777
778 if (!empty($this->html)) {
779 if (!empty($css)) {
780 $this->css = $css;
781 $this->buildCSS();
782 }
783 $msg = $this->html;
784 $msg = $this->checkIfHTML($msg); // This add a header and a body including custom CSS to the HTML content
785 }
786
787 if ($this->atleastoneimage) {
788 foreach ($this->html_images as $img) {
789 // $img['fullpath'],$img['image_encoded'],$img['name'],$img['content_type'],$img['cid']
790 $attachment = Swift_Image::fromPath($img['fullpath']);
791 // embed image
792 $imgcid = $this->message->embed($attachment);
793 // replace cid by the one created by swiftmail in html message
794 $msg = str_replace("cid:".$img['cid'], $imgcid, $msg);
795 }
796 foreach ($this->images_encoded as $img) {
797 //$img['fullpath'],$img['image_encoded'],$img['name'],$img['content_type'],$img['cid']
798 $attachment = Swift_Image::fromPath($img['fullpath']);
799 // embed image
800 $imgcid = $this->message->embed($attachment);
801 // replace cid by the one created by swiftmail in html message
802 $msg = str_replace("cid:".$img['cid'], $imgcid, $msg);
803 }
804 }
805
806 if ($this->msgishtml) {
807 $this->message->setBody($msg, 'text/html');
808 // And optionally an alternative body
809 $this->message->addPart(html_entity_decode(strip_tags($msg)), 'text/plain');
810 } else {
811 $this->message->setBody($msg, 'text/plain');
812 // And optionally an alternative body
813 $this->message->addPart(dol_nl2br($msg), 'text/html');
814 }
815
816 if (!empty($this->atleastonefile)) {
817 foreach ($filename_list as $i => $val) {
818 //$this->message->attach(Swift_Attachment::fromPath($filename_list[$i],$mimetype_list[$i]));
819 $attachment = Swift_Attachment::fromPath($filename_list[$i], $mimetype_list[$i]);
820 if (!empty($mimefilename_list[$i])) {
821 $attachment->setFilename($mimefilename_list[$i]);
822 }
823 $this->message->attach($attachment);
824 }
825 }
826
827 if (!empty($this->addr_cc)) {
828 try {
829 $this->message->setCc($this->getArrayAddress($this->addr_cc));
830 } catch (Exception $e) {
831 $this->errors[] = $e->getMessage();
832 }
833 }
834 if (!empty($this->addr_bcc)) {
835 try {
836 $this->message->setBcc($this->getArrayAddress($this->addr_bcc));
837 } catch (Exception $e) {
838 $this->errors[] = $e->getMessage();
839 }
840 }
841 if (isset($this->deliveryreceipt) && $this->deliveryreceipt == 1) {
842 try {
843 $this->message->setReadReceiptTo($this->getArrayAddress($this->addr_from));
844 } catch (Exception $e) {
845 $this->errors[] = $e->getMessage();
846 }
847 }
848 } else {
849 // Send mail method not correctly defined
850 // --------------------------------------
851 $this->error = 'Bad value for sendmode';
852 }
853 }
854
862 public function sendfile()
863 {
864 global $conf, $db, $langs, $hookmanager;
865
866 $errorlevel = error_reporting();
867 //error_reporting($errorlevel ^ E_WARNING); // Desactive warnings
868
869 $res = false;
870
871 if (!getDolGlobalString('MAIN_DISABLE_ALL_MAILS')) {
872 if (!is_object($hookmanager)) {
873 include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
874 $hookmanager = new HookManager($db);
875 }
876 $hookmanager->initHooks(array('mail'));
877
878 $parameters = array();
879 $action = '';
880 $reshook = $hookmanager->executeHooks('sendMail', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
881 if ($reshook < 0) {
882 $this->error = "Error in hook maildao sendMail ".$reshook;
883 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_ERR);
884
885 return false;
886 }
887 if ($reshook == 1) { // Hook replace standard code
888 dol_syslog("A hook has replaced code to send email", LOG_DEBUG);
889 return true;
890 }
891
892 $sendingmode = $this->sendmode;
893 if ($this->sendcontext == 'emailing' && getDolGlobalString('MAILING_NO_USING_PHPMAIL') && $sendingmode == 'mail') {
894 // List of sending methods
895 $listofmethods = array();
896 $listofmethods['mail'] = 'PHP mail function';
897 //$listofmethods['simplemail']='Simplemail class';
898 $listofmethods['smtps'] = 'SMTP/SMTPS socket library';
899
900 // EMailing feature may be a spam problem, so when you host several users/instance, having this option may force each user to use their own SMTP agent.
901 // You ensure that every user is using its own SMTP server when using the mass emailing module.
902 $linktoadminemailbefore = '<a href="'.DOL_URL_ROOT.'/admin/mails.php">';
903 $linktoadminemailend = '</a>';
904 $this->error = $langs->trans("MailSendSetupIs", $listofmethods[$sendingmode]);
905 $this->errors[] = $langs->trans("MailSendSetupIs", $listofmethods[$sendingmode]);
906 $this->error .= '<br>'.$langs->trans("MailSendSetupIs2", $linktoadminemailbefore, $linktoadminemailend, $langs->transnoentitiesnoconv("MAIN_MAIL_SENDMODE"), $listofmethods['smtps']);
907 $this->errors[] = $langs->trans("MailSendSetupIs2", $linktoadminemailbefore, $linktoadminemailend, $langs->transnoentitiesnoconv("MAIN_MAIL_SENDMODE"), $listofmethods['smtps']);
908 if (getDolGlobalString('MAILING_SMTP_SETUP_EMAILS_FOR_QUESTIONS')) {
909 $this->error .= '<br>'.$langs->trans("MailSendSetupIs3", getDolGlobalString('MAILING_SMTP_SETUP_EMAILS_FOR_QUESTIONS'));
910 $this->errors[] = $langs->trans("MailSendSetupIs3", getDolGlobalString('MAILING_SMTP_SETUP_EMAILS_FOR_QUESTIONS'));
911 }
912
913 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_WARNING);
914 return false;
915 }
916
917 // Check number of recipient is lower or equal than MAIL_MAX_NB_OF_RECIPIENTS_IN_SAME_EMAIL
918 if (!getDolGlobalString('MAIL_MAX_NB_OF_RECIPIENTS_TO_IN_SAME_EMAIL')) {
919 $conf->global->MAIL_MAX_NB_OF_RECIPIENTS_TO_IN_SAME_EMAIL = 10;
920 }
921 $tmparray1 = explode(',', $this->addr_to);
922 if (count($tmparray1) > $conf->global->MAIL_MAX_NB_OF_RECIPIENTS_TO_IN_SAME_EMAIL) {
923 $this->error = 'Too much recipients in to:';
924 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_WARNING);
925 return false;
926 }
927 if (!getDolGlobalString('MAIL_MAX_NB_OF_RECIPIENTS_CC_IN_SAME_EMAIL')) {
928 $conf->global->MAIL_MAX_NB_OF_RECIPIENTS_CC_IN_SAME_EMAIL = 10;
929 }
930 $tmparray2 = explode(',', $this->addr_cc);
931 if (count($tmparray2) > $conf->global->MAIL_MAX_NB_OF_RECIPIENTS_CC_IN_SAME_EMAIL) {
932 $this->error = 'Too much recipients in cc:';
933 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_WARNING);
934 return false;
935 }
936 if (!getDolGlobalString('MAIL_MAX_NB_OF_RECIPIENTS_BCC_IN_SAME_EMAIL')) {
937 $conf->global->MAIL_MAX_NB_OF_RECIPIENTS_BCC_IN_SAME_EMAIL = 10;
938 }
939 $tmparray3 = explode(',', $this->addr_bcc);
940 if (count($tmparray3) > $conf->global->MAIL_MAX_NB_OF_RECIPIENTS_BCC_IN_SAME_EMAIL) {
941 $this->error = 'Too much recipients in bcc:';
942 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_WARNING);
943 return false;
944 }
945 if (!getDolGlobalString('MAIL_MAX_NB_OF_RECIPIENTS_IN_SAME_EMAIL')) {
946 $conf->global->MAIL_MAX_NB_OF_RECIPIENTS_IN_SAME_EMAIL = 10;
947 }
948 if ((count($tmparray1) + count($tmparray2) + count($tmparray3)) > $conf->global->MAIL_MAX_NB_OF_RECIPIENTS_IN_SAME_EMAIL) {
949 $this->error = 'Too much recipients in to:, cc:, bcc:';
950 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_WARNING);
951 return false;
952 }
953
954 $keyforsmtpserver = 'MAIN_MAIL_SMTP_SERVER';
955 $keyforsmtpport = 'MAIN_MAIL_SMTP_PORT';
956 $keyforsmtpid = 'MAIN_MAIL_SMTPS_ID';
957 $keyforsmtppw = 'MAIN_MAIL_SMTPS_PW';
958 $keyforsmtpauthtype = 'MAIN_MAIL_SMTPS_AUTH_TYPE';
959 $keyforsmtpoauthservice = 'MAIN_MAIL_SMTPS_OAUTH_SERVICE';
960 $keyfortls = 'MAIN_MAIL_EMAIL_TLS';
961 $keyforstarttls = 'MAIN_MAIL_EMAIL_STARTTLS';
962 $keyforsslseflsigned = 'MAIN_MAIL_EMAIL_SMTP_ALLOW_SELF_SIGNED';
963 if (!empty($this->sendcontext)) {
964 $smtpContextKey = strtoupper($this->sendcontext);
965 $smtpContextSendMode = getDolGlobalString('MAIN_MAIL_SENDMODE_'.$smtpContextKey);
966 if (!empty($smtpContextSendMode) && $smtpContextSendMode != 'default') {
967 $keyforsmtpserver = 'MAIN_MAIL_SMTP_SERVER_'.$smtpContextKey;
968 $keyforsmtpport = 'MAIN_MAIL_SMTP_PORT_'.$smtpContextKey;
969 $keyforsmtpid = 'MAIN_MAIL_SMTPS_ID_'.$smtpContextKey;
970 $keyforsmtppw = 'MAIN_MAIL_SMTPS_PW_'.$smtpContextKey;
971 $keyforsmtpauthtype = 'MAIN_MAIL_SMTPS_AUTH_TYPE_'.$smtpContextKey;
972 $keyforsmtpoauthservice = 'MAIN_MAIL_SMTPS_OAUTH_SERVICE_'.$smtpContextKey;
973 $keyfortls = 'MAIN_MAIL_EMAIL_TLS_'.$smtpContextKey;
974 $keyforstarttls = 'MAIN_MAIL_EMAIL_STARTTLS_'.$smtpContextKey;
975 $keyforsslseflsigned = 'MAIN_MAIL_EMAIL_SMTP_ALLOW_SELF_SIGNED_'.$smtpContextKey;
976 }
977 }
978
979 // Action according to chose sending method
980 if ($this->sendmode == 'mail') {
981 // Use mail php function (default PHP method)
982 // ------------------------------------------
983 dol_syslog("CMailFile::sendfile addr_to=".$this->addr_to.", subject=".$this->subject, LOG_NOTICE);
984 //dol_syslog("CMailFile::sendfile header=\n".$this->headers, LOG_DEBUG);
985 //dol_syslog("CMailFile::sendfile message=\n".$message);
986
987 // If Windows, sendmail_from must be defined
988 if (isset($_SERVER["WINDIR"])) {
989 if (empty($this->addr_from)) {
990 $this->addr_from = 'robot@example.com';
991 }
992 @ini_set('sendmail_from', $this->getValidAddress($this->addr_from, 2));
993 }
994
995 // Force parameters
996 //dol_syslog("CMailFile::sendfile conf->global->".$keyforsmtpserver."=".getDolGlobalString($keyforsmtpserver)." cpnf->global->".$keyforsmtpport."=".$conf->global->$keyforsmtpport, LOG_DEBUG);
997 if (getDolGlobalString($keyforsmtpserver)) {
998 ini_set('SMTP', getDolGlobalString($keyforsmtpserver));
999 }
1000 if (getDolGlobalString($keyforsmtpport)) {
1001 ini_set('smtp_port', getDolGlobalString($keyforsmtpport));
1002 }
1003
1004 $res = true;
1005 if ($res && !$this->subject) {
1006 $this->error = "Failed to send mail with php mail to HOST=".ini_get('SMTP').", PORT=".ini_get('smtp_port')."<br>Subject is empty";
1007 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_ERR);
1008 $res = false;
1009 }
1010 $dest = $this->getValidAddress($this->addr_to, 2);
1011 if ($res && !$dest) {
1012 $this->error = "Failed to send mail with php mail to HOST=".ini_get('SMTP').", PORT=".ini_get('smtp_port')."<br>Recipient address '$dest' invalid";
1013 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_ERR);
1014 $res = false;
1015 }
1016
1017 if ($res) {
1018 $additionnalparam = ''; // By default
1019 if (getDolGlobalString('MAIN_MAIL_ALLOW_SENDMAIL_F')) {
1020 // When using the phpmail function, the mail command may force the from to the user of the login, for example: linuxuser@myserver.mydomain.com
1021 // You can try to set this option to have the command use the From. if it does not work, you can also try the MAIN_MAIL_SENDMAIL_FORCE_BA.
1022 // So forcing using the option -f of sendmail is possible if constant MAIN_MAIL_ALLOW_SENDMAIL_F is defined.
1023 // Having this variable defined may create problems with some sendmail (option -f refused)
1024 // Having this variable not defined may create problems with some other sendmail (option -f required)
1025 $additionnalparam .= ($additionnalparam ? ' ' : '').(getDolGlobalString('MAIN_MAIL_ERRORS_TO') ? '-f'.$this->getValidAddress($conf->global->MAIN_MAIL_ERRORS_TO, 2) : ($this->addr_from != '' ? '-f'.$this->getValidAddress($this->addr_from, 2) : ''));
1026 }
1027 if (getDolGlobalString('MAIN_MAIL_SENDMAIL_FORCE_BA')) { // To force usage of -ba option. This option tells sendmail to read From: or Sender: to setup sender
1028 $additionnalparam .= ($additionnalparam ? ' ' : '').'-ba';
1029 }
1030
1031 if (getDolGlobalString('MAIN_MAIL_SENDMAIL_FORCE_ADDPARAM')) {
1032 $additionnalparam .= ($additionnalparam ? ' ' : '').'-U '.$additionnalparam; // Use -U to add additional params
1033 }
1034
1035 $linuxlike = 1;
1036 if (preg_match('/^win/i', PHP_OS)) {
1037 $linuxlike = 0;
1038 }
1039 if (preg_match('/^mac/i', PHP_OS)) {
1040 $linuxlike = 0;
1041 }
1042
1043 dol_syslog("CMailFile::sendfile: mail start".($linuxlike ? '' : " HOST=".ini_get('SMTP').", PORT=".ini_get('smtp_port')).", additionnal_parameters=".$additionnalparam, LOG_DEBUG);
1044
1045 $this->message = stripslashes($this->message);
1046
1047 if (getDolGlobalString('MAIN_MAIL_DEBUG')) {
1048 $this->dump_mail();
1049 }
1050
1051 // Encode subject if required.
1052 $subjecttouse = $this->subject;
1053 if (!ascii_check($subjecttouse)) {
1054 $subjecttouse = $this->encodetorfc2822($subjecttouse);
1055 }
1056
1057 if (!empty($additionnalparam)) {
1058 $res = mail($dest, $subjecttouse, $this->message, $this->headers, $additionnalparam);
1059 } else {
1060 $res = mail($dest, $subjecttouse, $this->message, $this->headers);
1061 }
1062
1063 if (!$res) {
1064 $langs->load("errors");
1065 $this->error = "Failed to send mail with php mail";
1066 if (!$linuxlike) {
1067 $this->error .= " to HOST=".ini_get('SMTP').", PORT=".ini_get('smtp_port'); // This values are value used only for non linuxlike systems
1068 }
1069 $this->error .= ".<br>";
1070 $this->error .= $langs->trans("ErrorPhpMailDelivery");
1071 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_ERR);
1072
1073 if (getDolGlobalString('MAIN_MAIL_DEBUG')) {
1074 $this->save_dump_mail_in_err('Mail with topic '.$this->subject);
1075 }
1076 } else {
1077 dol_syslog("CMailFile::sendfile: mail end success", LOG_DEBUG);
1078 }
1079 }
1080
1081 if (isset($_SERVER["WINDIR"])) {
1082 @ini_restore('sendmail_from');
1083 }
1084
1085 // Restore parameters
1086 if (getDolGlobalString($keyforsmtpserver)) {
1087 ini_restore('SMTP');
1088 }
1089 if (getDolGlobalString($keyforsmtpport)) {
1090 ini_restore('smtp_port');
1091 }
1092 } elseif ($this->sendmode == 'smtps') {
1093 if (!is_object($this->smtps)) {
1094 $this->error = "Failed to send mail with smtps lib<br>Constructor of object CMailFile was not initialized without errors.";
1095 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_ERR);
1096 return false;
1097 }
1098
1099 // Use SMTPS library
1100 // ------------------------------------------
1101 $this->smtps->setTransportType(0); // Only this method is coded in SMTPs library
1102
1103 // Clean parameters
1104 if (empty($conf->global->$keyforsmtpserver)) {
1105 $conf->global->$keyforsmtpserver = ini_get('SMTP');
1106 }
1107 if (empty($conf->global->$keyforsmtpport)) {
1108 $conf->global->$keyforsmtpport = ini_get('smtp_port');
1109 }
1110
1111 // If we use SSL/TLS
1112 $server = getDolGlobalString($keyforsmtpserver);
1113 $secure = '';
1114 if (getDolGlobalString($keyfortls) && function_exists('openssl_open')) {
1115 $secure = 'ssl';
1116 }
1117 if (getDolGlobalString($keyforstarttls) && function_exists('openssl_open')) {
1118 $secure = 'tls';
1119 }
1120 $server = ($secure ? $secure.'://' : '').$server;
1121
1122 $port = getDolGlobalInt($keyforsmtpport);
1123
1124 $this->smtps->setHost($server);
1125 $this->smtps->setPort($port); // 25, 465...;
1126
1127 $loginid = '';
1128 $loginpass = '';
1129 if (getDolGlobalString($keyforsmtpid)) {
1130 $loginid = getDolGlobalString($keyforsmtpid);
1131 $this->smtps->setID($loginid);
1132 }
1133 if (getDolGlobalString($keyforsmtppw)) {
1134 $loginpass = getDolGlobalString($keyforsmtppw);
1135 $this->smtps->setPW($loginpass);
1136 }
1137
1138 if (getDolGlobalString($keyforsmtpauthtype) === "XOAUTH2") {
1139 require_once DOL_DOCUMENT_ROOT.'/core/lib/oauth.lib.php'; // define $supportedoauth2array
1140
1141 $supportedoauth2array = getSupportedOauth2Array();
1142
1143 $keyforsupportedoauth2array = getDolGlobalString($keyforsmtpoauthservice);
1144 if (preg_match('/^.*-/', $keyforsupportedoauth2array)) {
1145 $keyforprovider = preg_replace('/^.*-/', '', $keyforsupportedoauth2array);
1146 } else {
1147 $keyforprovider = '';
1148 }
1149 $keyforsupportedoauth2array = preg_replace('/-.*$/', '', $keyforsupportedoauth2array);
1150 $keyforsupportedoauth2array = 'OAUTH_'.$keyforsupportedoauth2array.'_NAME';
1151
1152 if (!empty($supportedoauth2array)) {
1153 $nameofservice = ucfirst(strtolower(empty($supportedoauth2array[$keyforsupportedoauth2array]['callbackfile']) ? 'Unknown' : $supportedoauth2array[$keyforsupportedoauth2array]['callbackfile']));
1154 $nameofservice .= ($keyforprovider ? '-'.$keyforprovider : '');
1155 $OAUTH_SERVICENAME = $nameofservice;
1156 } else {
1157 $OAUTH_SERVICENAME = 'Unknown';
1158 }
1159
1160 $keyforparamtenant = 'OAUTH_'.strtoupper(empty($supportedoauth2array[$keyforsupportedoauth2array]['callbackfile']) ? 'Unknown' : $supportedoauth2array[$keyforsupportedoauth2array]['callbackfile']).($keyforprovider ? '-'.$keyforprovider : '').'_TENANT';
1161
1162 require_once DOL_DOCUMENT_ROOT.'/includes/OAuth/bootstrap.php';
1163
1164 $storage = new DoliStorage($db, $conf, $keyforprovider, getDolGlobalString($keyforparamtenant));
1165 try {
1166 $tokenobj = $storage->retrieveAccessToken($OAUTH_SERVICENAME);
1167
1168 $expire = false;
1169 // Is token expired or will token expire in the next 30 seconds
1170 if (is_object($tokenobj)) {
1171 $expire = ($tokenobj->getEndOfLife() !== -9002 && $tokenobj->getEndOfLife() !== -9001 && time() > ($tokenobj->getEndOfLife() - 30));
1172 }
1173 // Token expired so we refresh it
1174 if (is_object($tokenobj) && $expire) {
1175 $credentials = new Credentials(
1176 getDolGlobalString('OAUTH_'.getDolGlobalString($keyforsmtpoauthservice).'_ID'),
1177 getDolGlobalString('OAUTH_'.getDolGlobalString($keyforsmtpoauthservice).'_SECRET'),
1178 getDolGlobalString('OAUTH_'.getDolGlobalString($keyforsmtpoauthservice).'_URLCALLBACK')
1179 );
1180 $serviceFactory = new \OAuth\ServiceFactory();
1181
1182 // Force the curl client, the default stream one uses file_get_contents() which
1183 // fails to reach the token endpoint on many setups, so the token is never refreshed.
1184 $httpClient = new \OAuth\Common\Http\Client\CurlClient();
1185 $serviceFactory->setHttpClient($httpClient);
1186 $oauthname = explode('-', $OAUTH_SERVICENAME);
1187 // Recreate the service with its configured scopes.
1188 // This matters for some providers (Microsoft v2 token endpoint) where scope may be required on refresh.
1189 $oauthScopes = array();
1190 $oauthScopesStr = getDolGlobalString('OAUTH_'.getDolGlobalString($keyforsmtpoauthservice).'_SCOPE');
1191 if (!empty($oauthScopesStr)) {
1192 $oauthScopes = preg_split('/\s*,\s*/', $oauthScopesStr);
1193 if (!is_array($oauthScopes)) {
1194 $oauthScopes = array();
1195 }
1196 }
1197
1198 // ex service is Google-Emails we need only the first part Google
1199 $apiService = $serviceFactory->createService($oauthname[0], $credentials, $storage, $oauthScopes);
1200
1201 // Some providers (like Google) return a refresh token only once.
1202 // If the refreshed token does not contain one, keep the previous refresh token.
1203 $refreshtoken = $tokenobj->getRefreshToken();
1204
1205 if ($apiService instanceof OAuth\OAuth2\Service\AbstractService || $apiService instanceof OAuth\OAuth1\Service\AbstractService) {
1206 // ServiceInterface does not provide refreshAccessToken, AbstractService does
1207 $tokenobj = $apiService->refreshAccessToken($tokenobj);
1208 if (empty($tokenobj->getRefreshToken())) {
1209 $tokenobj->setRefreshToken($refreshtoken);
1210 }
1211 $storage->storeAccessToken($OAUTH_SERVICENAME, $tokenobj);
1212 }
1213
1214 $tokenobj = $storage->retrieveAccessToken($OAUTH_SERVICENAME);
1215 }
1216
1217 if (is_object($tokenobj)) {
1218 $this->smtps->setToken($tokenobj->getAccessToken());
1219 } else {
1220 $this->error = "Token not found";
1221 }
1222 } catch (Exception $e) {
1223 // Return an error if token not found
1224 $this->error = $e->getMessage();
1225 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_ERR);
1226 }
1227 }
1228
1229 $res = true;
1230 $from = $this->smtps->getFrom('org');
1231 if ($res && !$from) {
1232 $this->error = "Failed to send mail with smtps lib to HOST=".$server.", PORT=" . getDolGlobalString($keyforsmtpport)." - Sender address '$from' invalid";
1233 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_ERR);
1234 $res = false;
1235 }
1236 $dest = $this->smtps->getTo();
1237 if ($res && !$dest) {
1238 $this->error = "Failed to send mail with smtps lib to HOST=".$server.", PORT=" . getDolGlobalString($keyforsmtpport)." - Recipient address '$dest' invalid";
1239 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_ERR);
1240 $res = false;
1241 }
1242
1243 if ($res) {
1244 dol_syslog("CMailFile::sendfile: sendMsg, HOST=".$server.", PORT=" . getDolGlobalString($keyforsmtpport), LOG_NOTICE);
1245
1246 if (getDolGlobalString('MAIN_MAIL_DEBUG')) {
1247 $this->smtps->setDebug(true);
1248 }
1249
1250 $result = $this->smtps->sendMsg();
1251
1252 if (getDolGlobalString('MAIN_MAIL_DEBUG')) {
1253 $this->dump_mail(); // Create file dolibarr_mail.log or dolibarr_mail.log.vXXX if option for archive is on
1254 }
1255
1256 $smtperrorcode = 0;
1257 if (! $result) {
1258 $smtperrorcode = $this->smtps->lastretval; // SMTP error code
1259 dol_syslog("CMailFile::sendfile: mail SMTP error code ".$smtperrorcode, LOG_WARNING);
1260
1261 if ($smtperrorcode == '421') { // Try later
1262 // TODO Add a delay and try again
1263 /*
1264 dol_syslog("CMailFile::sendfile: Try later error, so we wait and we retry");
1265 sleep(2);
1266
1267 $result = $this->smtps->sendMsg();
1268
1269 if (getDolGlobalString('MAIN_MAIL_DEBUG')) {
1270 $this->dump_mail();
1271 }
1272 */
1273 }
1274 } else {
1275 dol_syslog("CMailFile::sendfile: mail SMTP sendMsg is success", LOG_DEBUG);
1276 }
1277
1278 $result = $this->smtps->getErrors(); // applicative error code (not SMTP error code)
1279
1280 if (empty($this->error) && empty($result)) {
1281 dol_syslog("CMailFile::sendfile: mail end success", LOG_DEBUG);
1282 $res = true;
1283 } else {
1284 if (empty($this->error)) {
1285 $this->error = $result;
1286 }
1287 dol_syslog("CMailFile::sendfile: mail end error with smtps lib to HOST=".$server.", PORT=" . getDolGlobalString($keyforsmtpport)." - ".$this->error, LOG_ERR);
1288 $res = false;
1289
1290 if (getDolGlobalString('MAIN_MAIL_DEBUG')) {
1291 $this->save_dump_mail_in_err('Mail smtp error '.$smtperrorcode.' with topic '.$this->subject.' - '.$this->error);
1292 }
1293 }
1294 }
1295 } elseif ($this->sendmode == 'swiftmailer') {
1296 // Use Swift Mailer library
1297 // ------------------------------------------
1298 require_once DOL_DOCUMENT_ROOT.'/includes/swiftmailer/lib/swift_required.php';
1299
1300 // Clean parameters
1301 if (empty($conf->global->$keyforsmtpserver)) {
1302 $conf->global->$keyforsmtpserver = ini_get('SMTP');
1303 }
1304 if (empty($conf->global->$keyforsmtpport)) {
1305 $conf->global->$keyforsmtpport = ini_get('smtp_port');
1306 }
1307
1308 // If we use SSL/TLS
1309 $server = getDolGlobalString($keyforsmtpserver);
1310 $secure = '';
1311 if (getDolGlobalString($keyfortls) && function_exists('openssl_open')) {
1312 $secure = 'ssl';
1313 }
1314 if (getDolGlobalString($keyforstarttls) && function_exists('openssl_open')) {
1315 $secure = 'tls';
1316 }
1317
1318 $this->transport = new Swift_SmtpTransport($server, getDolGlobalInt($keyforsmtpport), $secure);
1319
1320 if (getDolGlobalString($keyforsmtpid)) {
1321 $this->transport->setUsername(getDolGlobalString($keyforsmtpid));
1322 }
1323 if (getDolGlobalString($keyforsmtppw) && getDolGlobalString($keyforsmtpauthtype) != "XOAUTH2") {
1324 $this->transport->setPassword(getDolGlobalString($keyforsmtppw));
1325 }
1326 if (getDolGlobalString($keyforsmtpauthtype) === "XOAUTH2") {
1327 $this->transport->setAuthMode('XOAUTH2');
1328 require_once DOL_DOCUMENT_ROOT.'/core/lib/oauth.lib.php';
1329
1330 $supportedoauth2array = getSupportedOauth2Array();
1331
1332 $keyforsupportedoauth2array = getDolGlobalString($keyforsmtpoauthservice);
1333 if (preg_match('/^.*-/', $keyforsupportedoauth2array)) {
1334 $keyforprovider = preg_replace('/^.*-/', '', $keyforsupportedoauth2array);
1335 } else {
1336 $keyforprovider = '';
1337 }
1338 $keyforsupportedoauth2array = preg_replace('/-.*$/', '', $keyforsupportedoauth2array);
1339 $keyforsupportedoauth2array = 'OAUTH_'.$keyforsupportedoauth2array.'_NAME';
1340
1341 if (!empty($supportedoauth2array)) {
1342 $nameofservice = ucfirst(strtolower(empty($supportedoauth2array[$keyforsupportedoauth2array]['callbackfile']) ? 'Unknown' : $supportedoauth2array[$keyforsupportedoauth2array]['callbackfile']));
1343 $nameofservice .= ($keyforprovider ? '-'.$keyforprovider : '');
1344 $OAUTH_SERVICENAME = $nameofservice;
1345 } else {
1346 $OAUTH_SERVICENAME = 'Unknown';
1347 }
1348
1349 $keyforparamtenant = 'OAUTH_'.strtoupper(empty($supportedoauth2array[$keyforsupportedoauth2array]['callbackfile']) ? 'Unknown' : $supportedoauth2array[$keyforsupportedoauth2array]['callbackfile']).($keyforprovider ? '-'.$keyforprovider : '').'_TENANT';
1350
1351 require_once DOL_DOCUMENT_ROOT.'/includes/OAuth/bootstrap.php';
1352
1353 $storage = new DoliStorage($db, $conf, $keyforprovider, getDolGlobalString($keyforparamtenant));
1354
1355 try {
1356 $tokenobj = $storage->retrieveAccessToken($OAUTH_SERVICENAME);
1357
1358 $expire = false;
1359 // Is token expired or will token expire in the next 30 seconds
1360 if (is_object($tokenobj)) {
1361 $expire = ($tokenobj->getEndOfLife() !== -9002 && $tokenobj->getEndOfLife() !== -9001 && time() > ($tokenobj->getEndOfLife() - 30));
1362 }
1363 // Token expired so we refresh it
1364 if (is_object($tokenobj) && $expire) {
1365 $credentials = new Credentials(
1366 getDolGlobalString('OAUTH_'.getDolGlobalString($keyforsmtpoauthservice).'_ID'),
1367 getDolGlobalString('OAUTH_'.getDolGlobalString($keyforsmtpoauthservice).'_SECRET'),
1368 getDolGlobalString('OAUTH_'.getDolGlobalString($keyforsmtpoauthservice).'_URLCALLBACK')
1369 );
1370 $serviceFactory = new \OAuth\ServiceFactory();
1371
1372 // Force the curl client, the default stream one uses file_get_contents() which
1373 // fails to reach the token endpoint on many setups, so the token is never refreshed.
1374 $httpClient = new \OAuth\Common\Http\Client\CurlClient();
1375 $serviceFactory->setHttpClient($httpClient);
1376 $oauthname = explode('-', $OAUTH_SERVICENAME);
1377 // Recreate the service with its configured scopes.
1378 // This matters for some providers (Microsoft v2 token endpoint) where scope may be required on refresh.
1379 $oauthScopes = array();
1380 $oauthScopesStr = getDolGlobalString('OAUTH_'.getDolGlobalString($keyforsmtpoauthservice).'_SCOPE');
1381 if (!empty($oauthScopesStr)) {
1382 $oauthScopes = preg_split('/\s*,\s*/', $oauthScopesStr);
1383 if (!is_array($oauthScopes)) {
1384 $oauthScopes = array();
1385 }
1386 }
1387
1388 // ex service is Google-Emails we need only the first part Google
1389 $apiService = $serviceFactory->createService($oauthname[0], $credentials, $storage, $oauthScopes);
1390 $refreshtoken = $tokenobj->getRefreshToken();
1391
1392 if ($apiService instanceof OAuth\OAuth2\Service\AbstractService || $apiService instanceof OAuth\OAuth1\Service\AbstractService) {
1393 // ServiceInterface does not provide refreshAccessToken, AbstractService does
1394 $tokenobj = $apiService->refreshAccessToken($tokenobj);
1395 if (empty($tokenobj->getRefreshToken())) {
1396 $tokenobj->setRefreshToken($refreshtoken);
1397 }
1398 $storage->storeAccessToken($OAUTH_SERVICENAME, $tokenobj);
1399
1400 $tokenobj = $storage->retrieveAccessToken($OAUTH_SERVICENAME);
1401 }
1402 }
1403
1404 if (is_object($tokenobj)) {
1405 $this->transport->setAuthMode('XOAUTH2');
1406 $this->transport->setPassword($tokenobj->getAccessToken());
1407 } else {
1408 $this->errors[] = "Token not found";
1409 dol_syslog("CMailFile::sendfile: OAuth2 token object is not valid", LOG_ERR);
1410 }
1411 } catch (Exception $e) {
1412 // Return an error if token not found
1413 $this->errors[] = $e->getMessage();
1414 dol_syslog("CMailFile::sendfile: mail end error=".$e->getMessage(), LOG_ERR);
1415 }
1416 }
1417 if (getDolGlobalString($keyforsslseflsigned)) {
1418 $this->transport->setStreamOptions(array('ssl' => array('allow_self_signed' => true, 'verify_peer' => false)));
1419 }
1420 //$smtps->_msgReplyTo = 'reply@web.com';
1421
1422 // Switch content encoding to base64 - avoid the doubledot issue with quoted-printable
1423 $contentEncoderBase64 = new Swift_Mime_ContentEncoder_Base64ContentEncoder();
1424 $this->message->setEncoder($contentEncoderBase64);
1425
1426 // Create the Mailer using your created Transport
1427 $this->mailer = new Swift_Mailer($this->transport);
1428
1429 // DKIM SIGN
1430 if (getDolGlobalString('MAIN_MAIL_EMAIL_DKIM_ENABLED')) {
1431 $privateKey = getDolGlobalString('MAIN_MAIL_EMAIL_DKIM_PRIVATE_KEY');
1432 $domainName = getDolGlobalString('MAIN_MAIL_EMAIL_DKIM_DOMAIN');
1433 $selector = getDolGlobalString('MAIN_MAIL_EMAIL_DKIM_SELECTOR');
1434 $signer = new Swift_Signers_DKIMSigner($privateKey, $domainName, $selector);
1435 $this->message->attachSigner($signer->ignoreHeader('Return-Path'));
1436 }
1437
1438 if (getDolGlobalString('MAIN_MAIL_DEBUG')) {
1439 // To use the ArrayLogger
1440 $this->logger = new Swift_Plugins_Loggers_ArrayLogger();
1441 // Or to use the Echo Logger
1442 //$this->logger = new Swift_Plugins_Loggers_EchoLogger();
1443 $this->mailer->registerPlugin(new Swift_Plugins_LoggerPlugin($this->logger));
1444 }
1445
1446 dol_syslog("CMailFile::sendfile: mailer->send, HOST=".$server.", PORT=" . getDolGlobalString($keyforsmtpport), LOG_NOTICE);
1447
1448 // send mail
1449 $failedRecipients = array();
1450 $result = null;
1451 try {
1452 $result = $this->mailer->send($this->message, $failedRecipients);
1453 } catch (Exception $e) {
1454 $this->errors[] = $e->getMessage();
1455 }
1456 if (getDolGlobalString('MAIN_MAIL_DEBUG')) {
1457 $this->dump_mail();
1458 }
1459
1460 $res = true;
1461 if (!empty($this->error) || !empty($this->errors) || !$result) {
1462 if (!empty($failedRecipients)) {
1463 $this->error = 'Transport failed for the following addresses: "' . implode('", "', $failedRecipients) . '".';
1464 $this->errors[] = $this->error;
1465 }
1466 dol_syslog("CMailFile::sendfile: mail end error=". implode(' ', $this->errors), LOG_ERR);
1467 $res = false;
1468
1469 if (getDolGlobalString('MAIN_MAIL_DEBUG')) {
1470 $this->save_dump_mail_in_err('Mail with topic '.$this->subject);
1471 }
1472 } else {
1473 dol_syslog("CMailFile::sendfile: mail end success", LOG_DEBUG);
1474 }
1475 } else {
1476 // Send mail method not correctly defined
1477 // --------------------------------------
1478
1479 $this->error = 'Bad value for sendmode';
1480 return false;
1481 }
1482
1483 // Now we delete image files that were created dynamically to manage data inline files
1484 /* Note: dol_delete call was disabled, so code commented to not trigger empty if body
1485 foreach ($this->html_images as $val) {
1486 if (!empty($val['type']) && $val['type'] == 'cidfromdata') {
1487 //dol_delete($val['fullpath']);
1488 }
1489 }
1490 */
1491
1492 $parameters = array('sent' => $res);
1493 $action = '';
1494 $reshook = $hookmanager->executeHooks('sendMailAfter', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
1495 if ($reshook < 0) {
1496 $this->error = "Error in hook maildao sendMailAfter ".$reshook;
1497 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_ERR);
1498
1499 return false;
1500 }
1501 } else {
1502 $this->error = 'No mail sent. Feature is disabled by option MAIN_DISABLE_ALL_MAILS';
1503 dol_syslog("CMailFile::sendfile: ".$this->error, LOG_WARNING);
1504 }
1505
1506 error_reporting($errorlevel); // Reactive original error level
1507 return $res;
1508 }
1509
1516 public static function encodetorfc2822($stringtoencode)
1517 {
1518 global $conf;
1519 return '=?'.$conf->file->character_set_client.'?B?'.base64_encode($stringtoencode).'?=';
1520 }
1521
1522 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1529 private function _encode_file($sourcefile)
1530 {
1531 // phpcs:enable
1532 $newsourcefile = dol_osencode($sourcefile);
1533
1534 if (is_readable($newsourcefile)) {
1535 $contents = file_get_contents($newsourcefile); // Need PHP 4.3
1536 $encoded = chunk_split(base64_encode($contents), 76, $this->eol); // 76 max is defined into http://tools.ietf.org/html/rfc2047
1537 return $encoded;
1538 } else {
1539 $this->error = "Error in _encode_file() method: Can't read file '".$sourcefile."'";
1540 dol_syslog("CMailFile::_encode_file: ".$this->error, LOG_ERR);
1541 return -1;
1542 }
1543 }
1544
1545 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1553 public function dump_mail()
1554 {
1555 // phpcs:enable
1556 global $dolibarr_main_data_root;
1557
1558 if (@is_writable($dolibarr_main_data_root)) { // Avoid fatal error on fopen with open_basedir
1559 $outputfile = $dolibarr_main_data_root."/dolibarr_mail.log";
1560 $fp = fopen($outputfile, "w"); // overwrite
1561
1562 if ($fp) {
1563 if ($this->sendmode == 'mail') {
1564 fwrite($fp, 'Param 1 (dest) for mail(): Not yet available in dump');
1565 fwrite($fp, $this->eol); // This eol is added by the mail function, so we add it in log
1566 fwrite($fp, 'Param 2 (topic) for mail(): '.$this->subject);
1567 fwrite($fp, $this->eol); // This eol is added by the mail function, so we add it in log
1568 fwrite($fp, 'Param 4 (headers) for mail():'."\n");
1569 fwrite($fp, $this->headers);
1570 fwrite($fp, $this->eol); // This eol is added by the mail function, so we add it in log
1571 fwrite($fp, 'Param 3 (message) for mail():'."\n");
1572 fwrite($fp, $this->message);
1573 } elseif ($this->sendmode == 'smtps') {
1574 fwrite($fp, $this->smtps->log); // this->smtps->log is filled only if MAIN_MAIL_DEBUG was set to on
1575 } elseif ($this->sendmode == 'swiftmailer') {
1576 fwrite($fp, "smtpheader=\n".$this->message->getHeaders()->toString()."\n");
1577 fwrite($fp, $this->logger->dump()); // this->logger is filled only if MAIN_MAIL_DEBUG was set to on
1578 }
1579
1580 fclose($fp);
1581 dolChmod($outputfile);
1582
1583 // Move dolibarr_mail.log into a dolibarr_mail.log.v123456789
1584 if (getDolGlobalInt('MAIN_MAIL_DEBUG_LOG_WITH_DATE')) {
1585 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
1586 archiveOrBackupFile($outputfile, getDolGlobalInt('MAIN_MAIL_DEBUG_LOG_WITH_DATE'));
1587 }
1588 }
1589 }
1590 }
1591
1592 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1600 public function save_dump_mail_in_err($message = '')
1601 {
1602 global $dolibarr_main_data_root;
1603
1604 if (@is_writable($dolibarr_main_data_root)) { // Avoid fatal error on fopen with open_basedir
1605 $srcfile = $dolibarr_main_data_root."/dolibarr_mail.log";
1606
1607 // Add message to dolibarr_mail.log. We do not use dol_syslog() on purpose,
1608 // to be sure to write into dolibarr_mail.log
1609 if ($message) {
1610 // Test constant SYSLOG_FILE_NO_ERROR (should stay a constant defined with define('SYSLOG_FILE_NO_ERROR',1);
1611 if (defined('SYSLOG_FILE_NO_ERROR')) {
1612 $filefd = @fopen($srcfile, 'a+');
1613 } else {
1614 $filefd = fopen($srcfile, 'a+');
1615 }
1616 if ($filefd) {
1617 fwrite($filefd, $message."\n");
1618 fclose($filefd);
1619 dolChmod($srcfile);
1620 }
1621 }
1622
1623 // Move dolibarr_mail.log into a dolibarr_mail.err or dolibarr_mail.date.err
1624 if (getDolGlobalString('MAIN_MAIL_DEBUG_ERR_WITH_DATE')) {
1625 $destfile = $dolibarr_main_data_root."/dolibarr_mail.".dol_print_date(dol_now(), 'dayhourlog', 'gmt').".err";
1626 } else {
1627 $destfile = $dolibarr_main_data_root."/dolibarr_mail.err";
1628 }
1629
1630 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
1631 dol_move($srcfile, $destfile, '0', 1, 0, 0);
1632 }
1633 }
1634
1641 public function checkIfHTML($msg)
1642 {
1643 if (!preg_match('/^[\s\t]*<html/i', $msg)) {
1644 $out = "<html><head><title></title>";
1645 if (!empty($this->styleCSS)) {
1646 $out .= $this->styleCSS;
1647 }
1648 $out .= "</head><body";
1649 if (!empty($this->bodyCSS)) {
1650 $out .= $this->bodyCSS;
1651 }
1652 $out .= ">";
1653 $out .= $msg;
1654 $out .= "</body></html>";
1655 } else {
1656 $out = $msg;
1657 }
1658
1659 return $out;
1660 }
1661
1667 public function buildCSS()
1668 {
1669 if (!empty($this->css)) {
1670 // Style CSS
1671 $this->styleCSS = '<style type="text/css">';
1672 $this->styleCSS .= 'body {';
1673
1674 if ($this->css['bgcolor']) {
1675 $this->styleCSS .= ' background-color: '.$this->css['bgcolor'].';';
1676 $this->bodyCSS .= ' bgcolor="'.$this->css['bgcolor'].'"';
1677 }
1678 if ($this->css['bgimage']) {
1679 // TODO recuperer cid
1680 $this->styleCSS .= ' background-image: url("cid:'.$this->css['bgimage_cid'].'");';
1681 }
1682 $this->styleCSS .= '}';
1683 $this->styleCSS .= '</style>';
1684 }
1685 }
1686
1687 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1693 public function write_smtpheaders()
1694 {
1695 // phpcs:enable
1696 $out = "";
1697 $host = dol_getprefix('email');
1698
1699 // Sender
1700 //$out.= "Sender: ".getValidAddress($this->addr_from,2)).$this->eol2;
1701 $out .= "From: ".$this->getValidAddress($this->addr_from, 3, 1).$this->eol2;
1702 if (getDolGlobalString('MAIN_MAIL_SENDMAIL_FORCE_BA')) {
1703 $out .= "To: ".$this->getValidAddress($this->addr_to, 0, 1).$this->eol2;
1704 }
1705 if (!getDolGlobalString('MAIN_MAIL_NO_RETURN_PATH_FOR_MODE_MAIL')) {
1706 // Return-Path is important because it is used by SPF. Some command line MTA overwrites the Return-Path, even if already in the
1707 // SMTP header, with a value guessed by command line tool. See option MAIN_MAIL_ALLOW_SENDMAIL_F to provide email to the command line tool.
1708 // Return-Path is used for bounced emails. If not set (most cases), the From is used.
1709 $out .= "Return-Path: ".$this->getValidAddress($this->addr_from, 1, 1).$this->eol2;
1710 }
1711 if (isset($this->reply_to) && $this->reply_to) {
1712 $out .= "Reply-To: ".$this->getValidAddress($this->reply_to, 2).$this->eol2;
1713 }
1714 if (isset($this->errors_to) && $this->errors_to) {
1715 $out .= "Errors-To: ".$this->getValidAddress($this->errors_to, 2).$this->eol2;
1716 }
1717
1718 // Receiver
1719 if (isset($this->addr_cc) && $this->addr_cc) {
1720 $out .= "Cc: ".$this->getValidAddress($this->addr_cc, 2).$this->eol2;
1721 }
1722 if (isset($this->addr_bcc) && $this->addr_bcc) {
1723 $out .= "Bcc: ".$this->getValidAddress($this->addr_bcc, 2).$this->eol2; // TODO Question: bcc must not be into header, only into SMTP command "RCPT TO". Does php mail support this ?
1724 }
1725
1726 // Delivery receipt
1727 if (isset($this->deliveryreceipt) && $this->deliveryreceipt == 1) {
1728 $out .= "Disposition-Notification-To: ".$this->getValidAddress($this->addr_from, 2).$this->eol2;
1729 }
1730
1731 //$out.= "X-Priority: 3".$this->eol2;
1732 $out .= 'Date: '.date("r").$this->eol2;
1733
1734 $trackid = $this->trackid;
1735 if ($trackid) {
1736 $this->msgid = uniqid('', true).'.phpmail-dolibarr-'.$trackid.'@'.$host;
1737 $out .= 'Message-ID: <'.$this->msgid.">".$this->eol2; // Uppercase seems replaced by phpmail
1738 $out .= 'X-Dolibarr-TRACKID: '.$trackid.'@'.$host.$this->eol2;
1739 } else {
1740 $this->msgid = uniqid('', true).'.phpmail@'.$host;
1741 $out .= 'Message-ID: <'.$this->msgid.">".$this->eol2;
1742 }
1743
1744 // Add 'In-Reply-To:' header with the Message-Id we answer
1745 if (!empty($this->in_reply_to)) {
1746 $out .= 'In-Reply-To: <'.$this->in_reply_to.'>'.$this->eol2;
1747 }
1748 // Add 'References:' header with list of all Message-ID in thread history
1749 if (!empty($this->references)) {
1750 $out .= 'References: '.$this->references.$this->eol2;
1751 }
1752
1753 if (!empty($_SERVER['REMOTE_ADDR'])) {
1754 $out .= "X-RemoteAddr: ".$_SERVER['REMOTE_ADDR'].$this->eol2;
1755 }
1756 $out .= "X-Mailer: Dolibarr version ".DOL_VERSION." (using php mail)".$this->eol2;
1757 $out .= "Mime-Version: 1.0".$this->eol2;
1758
1759 //$out.= "From: ".$this->getValidAddress($this->addr_from,3,1).$this->eol;
1760
1761 $out .= "Content-Type: multipart/mixed;".$this->eol2." boundary=\"".$this->mixed_boundary."\"".$this->eol2;
1762 if (!getDolGlobalString("MAIN_EMAIL_DISABLE_ADD_CONTENT_ENCODING_8BIT")) {
1763 $out .= "Content-Transfer-Encoding: 8bit".$this->eol2; // TODO Seems to be ignored. Header is 7bit once received.
1764 }
1765
1766 dol_syslog("CMailFile::write_smtpheaders smtp_header=\n".$out, LOG_DEBUG);
1767 return $out;
1768 }
1769
1770 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1778 public function write_mimeheaders($filename_list, $mimefilename_list)
1779 {
1780 // phpcs:enable
1781 $out = "";
1782
1783 if (is_array($filename_list) && is_array($mimefilename_list)) {
1784 $filename_list_size = count($filename_list);
1785 for ($i = 0; $i < $filename_list_size; $i++) {
1786 if ($filename_list[$i]) {
1787 if ($mimefilename_list[$i]) {
1788 $filename_list[$i] = $mimefilename_list[$i];
1789 }
1790 $out .= "X-attachments: $filename_list[$i]".$this->eol2;
1791 }
1792 }
1793 }
1794
1795 dol_syslog("CMailFile::write_mimeheaders mime_header=\n".$out, LOG_DEBUG);
1796 return $out;
1797 }
1798
1799 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1806 public function write_body($msgtext)
1807 {
1808 // phpcs:enable
1809 global $conf;
1810
1811 $out = '';
1812
1813 $out .= "--".$this->mixed_boundary.$this->eol;
1814
1815 if ($this->atleastoneimage) {
1816 $out .= "Content-Type: multipart/alternative;".$this->eol." boundary=\"".$this->alternative_boundary."\"".$this->eol;
1817 $out .= $this->eol;
1818 $out .= "--".$this->alternative_boundary.$this->eol;
1819 }
1820
1821 // Make RFC821 Compliant, replace bare linefeeds
1822 $strContent = preg_replace("/(?<!\r)\n/si", "\r\n", $msgtext); // PCRE modifier /s means new lines are common chars
1823 if (getDolGlobalString('MAIN_FIX_FOR_BUGGED_MTA')) {
1824 $strContent = preg_replace("/\r\n/si", "\n", $strContent); // PCRE modifier /s means new lines are common chars
1825 }
1826
1827 $strContentAltText = '';
1828 if ($this->msgishtml) {
1829 // Similar code to forge a text from html is also in smtps.class.php
1830 $strContentAltText = preg_replace("/<br\s*[^>]*>/", " ", $strContent);
1831 // TODO We could replace <img ...> with [Filename.ext] like Gmail do.
1832 $strContentAltText = html_entity_decode(strip_tags($strContentAltText)); // Remove any HTML tags
1833 $strContentAltText = trim(wordwrap($strContentAltText, 75, !getDolGlobalString('MAIN_FIX_FOR_BUGGED_MTA') ? "\r\n" : "\n"));
1834
1835 // Check if html header already in message, if not complete the message
1836 $strContent = $this->checkIfHTML($strContent); // This add a header and a body including custom CSS to the HTML content
1837 }
1838
1839 // Make RFC2045 Compliant, split lines
1840 //$strContent = rtrim(chunk_split($strContent)); // Function chunck_split seems ko if not used on a base64 content
1841 // TODO Encode main content into base64 and use the chunk_split, or quoted-printable
1842 $strContent = rtrim(wordwrap($strContent, 75, !getDolGlobalString('MAIN_FIX_FOR_BUGGED_MTA') ? "\r\n" : "\n")); // TODO Using this method creates unexpected line break on text/plain content.
1843
1844 if ($this->msgishtml) {
1845 if ($this->atleastoneimage) {
1846 $out .= "Content-Type: text/plain; charset=".$conf->file->character_set_client.$this->eol;
1847 //$out.= "Content-Transfer-Encoding: 7bit".$this->eol;
1848 $out .= $this->eol.($strContentAltText ? $strContentAltText : strip_tags($strContent)).$this->eol; // Add plain text message
1849 $out .= "--".$this->alternative_boundary.$this->eol;
1850 $out .= "Content-Type: multipart/related;".$this->eol." boundary=\"".$this->related_boundary."\"".$this->eol;
1851 $out .= $this->eol;
1852 $out .= "--".$this->related_boundary.$this->eol;
1853 }
1854
1855 if (!$this->atleastoneimage && $strContentAltText && getDolGlobalString('MAIN_MAIL_USE_MULTI_PART')) { // Add plain text message part before html part
1856 $out .= "Content-Type: multipart/alternative;".$this->eol." boundary=\"".$this->alternative_boundary."\"".$this->eol;
1857 $out .= $this->eol;
1858 $out .= "--".$this->alternative_boundary.$this->eol;
1859 $out .= "Content-Type: text/plain; charset=".$conf->file->character_set_client.$this->eol;
1860 //$out.= "Content-Transfer-Encoding: 7bit".$this->eol;
1861 $out .= $this->eol.$strContentAltText.$this->eol;
1862 $out .= "--".$this->alternative_boundary.$this->eol;
1863 }
1864
1865 $out .= "Content-Type: text/html; charset=".$conf->file->character_set_client.$this->eol;
1866 //$out.= "Content-Transfer-Encoding: 7bit".$this->eol; // TODO Use base64
1867 $out .= $this->eol.$strContent.$this->eol;
1868
1869 if (!$this->atleastoneimage && $strContentAltText && getDolGlobalString('MAIN_MAIL_USE_MULTI_PART')) { // Add plain text message part after html part
1870 $out .= "--".$this->alternative_boundary."--".$this->eol;
1871 }
1872 } else {
1873 $out .= "Content-Type: text/plain; charset=".$conf->file->character_set_client.$this->eol;
1874 //$out.= "Content-Transfer-Encoding: 7bit".$this->eol;
1875 $out .= $this->eol.$strContent.$this->eol;
1876 }
1877
1878 $out .= $this->eol;
1879
1880 // Encode images
1881 if ($this->atleastoneimage) {
1882 $out .= $this->write_images($this->images_encoded);
1883 // always end related and end alternative after inline images
1884 $out .= "--".$this->related_boundary."--".$this->eol;
1885 $out .= $this->eol."--".$this->alternative_boundary."--".$this->eol;
1886 $out .= $this->eol;
1887 }
1888
1889 return $out;
1890 }
1891
1892 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1902 private function write_files($filename_list, $mimetype_list, $mimefilename_list, $cidlist)
1903 {
1904 // phpcs:enable
1905 $out = '';
1906
1907 $filename_list_size = count($filename_list);
1908 for ($i = 0; $i < $filename_list_size; $i++) {
1909 if ($filename_list[$i]) {
1910 dol_syslog("CMailFile::write_files: i=$i ".$filename_list[$i]);
1911 $encoded = $this->_encode_file($filename_list[$i]);
1912 if ($encoded !== -1) {
1913 if ($mimefilename_list[$i]) {
1914 $filename_list[$i] = $mimefilename_list[$i];
1915 }
1916 if (!$mimetype_list[$i]) {
1917 $mimetype_list[$i] = "application/octet-stream";
1918 }
1919
1920 // Skip files that have a CID (they will be added as inline images instead)
1921 // @phpstan-ignore-next-line
1922 if (!empty($cidlist) && is_array($cidlist) && isset($cidlist[$i]) && $cidlist[$i] !== null && $cidlist[$i] !== '') {
1923 continue; // Skip this file as it will be processed as inline image
1924 }
1925
1926 $out .= "--".$this->mixed_boundary.$this->eol;
1927
1928 $out .= "Content-Disposition: attachment; filename=\"".$filename_list[$i]."\"".$this->eol;
1929 $out .= "Content-Type: ".$mimetype_list[$i]."; name=\"".$filename_list[$i]."\"".$this->eol;
1930 $out .= "Content-Transfer-Encoding: base64".$this->eol;
1931 $out .= "Content-Description: ".$filename_list[$i].$this->eol;
1932 $out .= $this->eol;
1933 $out .= $encoded;
1934 $out .= $this->eol;
1935 //$out.= $this->eol;
1936 } else {
1937 return $encoded;
1938 }
1939 }
1940 }
1941
1942 return $out;
1943 }
1944
1945 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1952 public function write_images($images_list)
1953 {
1954 // phpcs:enable
1955 $out = '';
1956
1957 if (is_array($images_list)) {
1958 foreach ($images_list as $img) {
1959 dol_syslog("CMailFile::write_images: ".$img["name"]);
1960
1961 $out .= "--".$this->related_boundary.$this->eol; // always related for an inline image
1962 $out .= "Content-Type: ".$img["content_type"]."; name=\"".$img["name"]."\"".$this->eol;
1963 $out .= "Content-Transfer-Encoding: base64".$this->eol;
1964 $out .= "Content-Disposition: inline; filename=\"".$img["name"]."\"".$this->eol;
1965 $out .= "Content-ID: <".$img["cid"].">".$this->eol;
1966 $out .= $this->eol;
1967 $out .= $img["image_encoded"];
1968 $out .= $this->eol;
1969 }
1970 }
1971
1972 return $out;
1973 }
1974
1975 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1983 public function check_server_port($host, $port)
1984 {
1985 include_once DOL_DOCUMENT_ROOT.'/core/lib/geturl.lib.php';
1986
1987 // phpcs:enable
1988 $_retVal = 0;
1989 $timeout = 5; // Timeout in seconds
1990
1991 // Parse $newUrl
1992 $newUrlArray = parse_url($host);
1993 $hosttocheck = $newUrlArray['host'] ?? ($newUrlArray['path'] ?? '');
1994 $hosttocheck = str_replace(array('[', ']'), '', $hosttocheck); // Remove brackets of IPv6
1995
1996 // Deny some reserved host names
1997 if (in_array($hosttocheck, array('metadata.google.internal'))) {
1998 $info = array();
1999 $info['http_code'] = 400;
2000 $info['content'] = 'Error bad hostname '.$hosttocheck.' (Used by Google metadata). This value for hostname is not allowed.';
2001 return $info;
2002 }
2003
2004 // Clean host name $hosttocheck to convert it into an IP $iptocheck
2005 if (in_array($hosttocheck, array('localhost', 'localhost.domain'))) {
2006 $iptocheck = '127.0.0.1';
2007 } elseif (in_array($hosttocheck, array('ip6-localhost', 'ip6-loopback'))) {
2008 $iptocheck = '::1';
2009 } else {
2010 // Resolve $hosttocheck to get the IP $iptocheck
2011 $iptocheck = resolveDns($hosttocheck);
2012 }
2013
2014 // Check $iptocheck is an IP (v4 or v6), if not clear value.
2015 if (!filter_var($iptocheck, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4 | FILTER_FLAG_IPV6)) { // This is not an IP, we clean data
2016 $iptocheck = '0'; // will disabled check on IP
2017 }
2018
2019 if ($iptocheck && !in_array($iptocheck, array('127.0.0.1', '::1'))) {
2020 $localurl = 0;
2021 $tmpresult = isIPAllowed($iptocheck, $localurl);
2022
2023 if ($tmpresult) {
2024 $info = array();
2025 $info['http_code'] = 400;
2026 $info['content'] = $tmpresult;
2027 return $info;
2028 }
2029 }
2030
2031 if (function_exists('fsockopen')) {
2032 $keyforsmtpserver = 'MAIN_MAIL_SMTP_SERVER';
2033 $keyforsmtpport = 'MAIN_MAIL_SMTP_PORT';
2034 $keyforsmtpid = 'MAIN_MAIL_SMTPS_ID';
2035 $keyforsmtppw = 'MAIN_MAIL_SMTPS_PW';
2036 $keyforsmtpauthtype = 'MAIN_MAIL_SMTPS_AUTH_TYPE';
2037 $keyforsmtpoauthservice = 'MAIN_MAIL_SMTPS_OAUTH_SERVICE';
2038 $keyfortls = 'MAIN_MAIL_EMAIL_TLS';
2039 $keyforstarttls = 'MAIN_MAIL_EMAIL_STARTTLS';
2040 $keyforsslseflsigned = 'MAIN_MAIL_EMAIL_SMTP_ALLOW_SELF_SIGNED';
2041
2042 if (!empty($this->sendcontext)) {
2043 $smtpContextKey = strtoupper($this->sendcontext);
2044 $smtpContextSendMode = getDolGlobalString('MAIN_MAIL_SENDMODE_'.$smtpContextKey);
2045 if (!empty($smtpContextSendMode) && $smtpContextSendMode != 'default') {
2046 $keyforsmtpserver = 'MAIN_MAIL_SMTP_SERVER_'.$smtpContextKey;
2047 $keyforsmtpport = 'MAIN_MAIL_SMTP_PORT_'.$smtpContextKey;
2048 $keyforsmtpid = 'MAIN_MAIL_SMTPS_ID_'.$smtpContextKey;
2049 $keyforsmtppw = 'MAIN_MAIL_SMTPS_PW_'.$smtpContextKey;
2050 $keyforsmtpauthtype = 'MAIN_MAIL_SMTPS_AUTH_TYPE_'.$smtpContextKey;
2051 $keyforsmtpoauthservice = 'MAIN_MAIL_SMTPS_OAUTH_SERVICE_'.$smtpContextKey;
2052 $keyfortls = 'MAIN_MAIL_EMAIL_TLS_'.$smtpContextKey;
2053 $keyforstarttls = 'MAIN_MAIL_EMAIL_STARTTLS_'.$smtpContextKey;
2054 $keyforsslseflsigned = 'MAIN_MAIL_EMAIL_SMTP_ALLOW_SELF_SIGNED_'.$smtpContextKey;
2055 }
2056 }
2057
2058 // If we use SSL/TLS
2059 if (getDolGlobalString($keyfortls) && function_exists('openssl_open')) {
2060 $host = 'ssl://'.$host;
2061 }
2062 // tls smtp start with no encryption
2063 //if (getDolGlobalString('MAIN_MAIL_EMAIL_STARTTLS') && function_exists('openssl_open')) $host='tls://'.$host;
2064
2065 dol_syslog("Try socket connection to host=".$host." port=".$port." timeout=".$timeout);
2066 //See if we can connect to the SMTP server
2067 $errno = 0;
2068 $errstr = '';
2069 if ($socket = @fsockopen(
2070 $host, // Host to test, IP or domain. Add ssl:// for SSL/TLS.
2071 $port, // which Port number to use
2072 $errno, // actual system level error
2073 $errstr, // and any text that goes with the error
2074 $timeout // timeout for reading/writing data over the socket
2075 )) {
2076 // Windows still does not have support for this timeout function
2077 if (function_exists('stream_set_timeout')) {
2078 stream_set_timeout($socket, $timeout, 0);
2079 }
2080
2081 dol_syslog("Now we wait for answer 220");
2082
2083 // Check response from Server
2084 if ($_retVal = $this->server_parse($socket, "220")) {
2085 $_retVal = $socket;
2086 } else {
2087 $this->error = ($this->error ? $this->error." - " : "")."Succeed in opening socket but answer 220 not received";
2088 }
2089 } else {
2090 $this->error = utf8_check('Error '.$errno.' - '.$errstr) ? 'Error '.$errno.' - '.$errstr : mb_convert_encoding('Error '.$errno.' - '.$errstr, 'UTF-8', 'ISO-8859-1');
2091 }
2092 }
2093
2094 sleep(1);
2095
2096 return $_retVal;
2097 }
2098
2099 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
2108 public function server_parse($socket, $response)
2109 {
2110 // phpcs:enable
2111 $_retVal = true; // Indicates if Object was created or not
2112 $server_response = '';
2113
2114 while (substr($server_response, 3, 1) != ' ') {
2115 if (!($server_response = fgets($socket, 256))) {
2116 $this->error = "Couldn't get mail server response codes";
2117 return false;
2118 }
2119 }
2120
2121 if (!(substr($server_response, 0, 3) == $response)) {
2122 $this->error = "Ran into problems sending Mail.\r\nResponse: $server_response";
2123 $_retVal = false;
2124 }
2125
2126 return $_retVal;
2127 }
2128
2136 private function findHtmlImages($images_dir)
2137 {
2138 // Build the array of image extensions
2139 $extensions = array_keys($this->image_types);
2140
2141 // We search (into mail body this->html), if we find some strings like "... .imgext" or '... .imgext' to detect strings like "...file=xxx.img"
2142 // For example to detect:
2143 // <img alt="" src="/viewimage.php?modulepart=medias&amp;entity=1&amp;file=image/picture.jpg" style="height:356px; width:1040px" />
2144 $matches = array();
2145 preg_match_all('/(?:"|\')([^"\']+\.('.implode('|', $extensions).'))(?:"|\')/Ui', $this->html, $matches); // If "xxx.ext" or 'xxx.ext' found
2146
2147 if (!empty($matches) && !empty($matches[1])) {
2148 $i = 0;
2149 // We are interested in $matches[1] only (the second set of parenthesis into regex)
2150 foreach ($matches[1] as $full) {
2151 $full = urldecode($full);
2152
2153 $regs = array();
2154 if (preg_match('/file=([A-Za-z0-9_\-\/ ]+[\.]?[A-Za-z0-9]+)?$/i', $full, $regs)) { // If xxx is 'file=aaa'
2155 $img = $regs[1];
2156
2157 if (file_exists($images_dir.'/'.$img)) {
2158 // Image path in src
2159 $src = preg_quote($full, '/');
2160 // Image full path
2161 $this->html_images[$i]["fullpath"] = $images_dir.'/'.$img;
2162 // Image name
2163 $this->html_images[$i]["name"] = $img;
2164 // Content type
2165 $regext = array();
2166 if (preg_match('/^.+\.(\w{3,4})$/', $img, $regext)) {
2167 $ext = strtolower($regext[1]);
2168 $this->html_images[$i]["content_type"] = $this->image_types[$ext];
2169 }
2170 // cid
2171 $this->html_images[$i]["cid"] = dol_hash($this->html_images[$i]["fullpath"], 'md5'); // Force md5 hash (does not contain special chars)
2172 // type
2173 $this->html_images[$i]["type"] = 'cidfromurl';
2174
2175 $this->html = preg_replace("/src=\"$src\"|src='$src'/i", "src=\"cid:".$this->html_images[$i]["cid"]."\"", $this->html);
2176 }
2177 $i++;
2178 }
2179 }
2180
2181 if (!empty($this->html_images)) {
2182 $inline = array();
2183
2184 $i = 0;
2185
2186 foreach ($this->html_images as $img) {
2187 $fullpath = $images_dir.'/'.$img["name"];
2188
2189 // If referenced image is found on disk (src link), it may show up as attachments, so we remove it by storing it into images_encoded
2190 if (!in_array($fullpath, $inline)) {
2191 // Read image file
2192 if ($image = file_get_contents($fullpath)) {
2193 // On garde que le nom de l'image
2194 $regs = array();
2195 preg_match('/([A-Za-z0-9_-]+[\.]?[A-Za-z0-9]+)?$/i', $img["name"], $regs);
2196 $imgName = $regs[1];
2197 $this->images_encoded[$i]['name'] = $imgName;
2198 $this->images_encoded[$i]['fullpath'] = $fullpath;
2199 $this->images_encoded[$i]['content_type'] = $img["content_type"];
2200 $this->images_encoded[$i]['cid'] = $img["cid"];
2201 // Encodage de l'image
2202 $this->images_encoded[$i]["image_encoded"] = chunk_split(base64_encode($image), 68, $this->eol);
2203 $inline[] = $fullpath;
2204 }
2205 }
2206 $i++;
2207 }
2208 } else {
2209 return -1;
2210 }
2211
2212 return 1;
2213 } else {
2214 return 0;
2215 }
2216 }
2217
2226 private function findHtmlImagesIsSrcData($images_dir)
2227 {
2228 global $conf;
2229
2230 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
2231
2232 // Build the array of image extensions
2233 $extensions = array_keys($this->image_types);
2234
2235 if (empty($images_dir)) {
2236 //$images_dir = $conf->admin->dir_output.'/temp/'.uniqid('cmailfile');
2237 $images_dir = $conf->admin->dir_output.'/temp/cmailfile';
2238 }
2239
2240 if ($images_dir && !dol_is_dir($images_dir)) {
2241 dol_mkdir($images_dir, DOL_DATA_ROOT);
2242 }
2243
2244 // Uncomment this for debug
2245 /*
2246 global $dolibarr_main_data_root;
2247 $outputfile = $dolibarr_main_data_root."/dolibarr_mail.log";
2248 $fp = fopen($outputfile, "w+");
2249 fwrite($fp, $this->html);
2250 fclose($fp);
2251 */
2252
2253 // We search (into mail body this->html), if we find some strings like "... file=xxx.img"
2254 // For example when:
2255 // <img alt="" src="/src="data:image....;base64,...." />
2256 $matches = array();
2257 preg_match_all('/src="data:image\/('.implode('|', $extensions).');base64,([^"]+)"/Ui', $this->html, $matches); // If "xxx.ext" or 'xxx.ext' found
2258
2259 if (!empty($matches) && !empty($matches[1])) {
2260 if (empty($images_dir)) {
2261 // No temp directory provided, so we are not able to support conversion of data:image into physical images.
2262 $this->errors[] = 'NoTempDirProvidedInCMailConstructorSoCantConvertDataImgOnDisk';
2263 return -1;
2264 }
2265
2266 $i = count($this->html_images);
2267 foreach ($matches[1] as $key => $ext) {
2268 // We save the image to send in disk
2269 $filecontent = $matches[2][$key];
2270
2271 $cid = 'cid000'.dol_hash($filecontent, 'md5'); // The id must not change if image is same
2272
2273 $destfiletmp = $images_dir.'/'.$cid.'.'.$ext;
2274
2275 if (!dol_is_file($destfiletmp)) { // If file does not exist yet (this is the case for the first email sent with a data:image inside)
2276 dol_syslog("write the cid file ".$destfiletmp);
2277 $fhandle = @fopen($destfiletmp, 'w');
2278 if ($fhandle) {
2279 $nbofbyteswrote = fwrite($fhandle, base64_decode($filecontent));
2280 fclose($fhandle);
2281 dolChmod($destfiletmp);
2282 } else {
2283 $this->errors[] = "Failed to open file '".$destfiletmp."' for write";
2284 return -2;
2285 }
2286 }
2287
2288 if (file_exists($destfiletmp)) {
2289 // Image full path
2290 $this->html_images[$i]["fullpath"] = $destfiletmp;
2291 // Image name
2292 $this->html_images[$i]["name"] = basename($destfiletmp);
2293 // Content type
2294 $this->html_images[$i]["content_type"] = $this->image_types[strtolower($ext)];
2295 // cid
2296 $this->html_images[$i]["cid"] = $cid;
2297 // type
2298 $this->html_images[$i]["type"] = 'cidfromdata';
2299
2300 $this->html = str_replace('src="data:image/'.$ext.';base64,'.$filecontent.'"', 'src="cid:'.$this->html_images[$i]["cid"].'"', $this->html);
2301 }
2302 $i++;
2303 }
2304
2305 // Also add cidfromdata images to images_encoded array so they are sent as inline images
2306 foreach ($this->html_images as $img) {
2307 if ($img['type'] == 'cidfromdata') {
2308 $image_content = file_get_contents($img['fullpath']);
2309 if ($image_content !== false) {
2310 $idx = count($this->images_encoded);
2311 $this->images_encoded[$idx]['name'] = $img['name'];
2312 $this->images_encoded[$idx]['fullpath'] = $img['fullpath'];
2313 $this->images_encoded[$idx]['content_type'] = $img['content_type'];
2314 $this->images_encoded[$idx]['cid'] = $img['cid'];
2315 $this->images_encoded[$idx]['type'] = 'cidfromdata';
2316 $this->images_encoded[$idx]['image_encoded'] = chunk_split(base64_encode($image_content), 68, $this->eol);
2317 }
2318 }
2319 }
2320
2321 return 1;
2322 } else {
2323 return 0;
2324 }
2325 }
2326
2342 public static function getValidAddress($address, $format, $encode = 0, $maxnumberofemail = 0)
2343 {
2344 $ret = '';
2345
2346 $arrayaddress = (!empty($address) ? explode(',', $address) : array());
2347
2348 // Loop over every component of the address
2349 $i = 0;
2350 foreach ($arrayaddress as $val) {
2351 $regs = array();
2352 if (preg_match('/^(.*)<(.*)>$/i', trim($val), $regs)) {
2353 $name = trim($regs[1]);
2354 $email = trim($regs[2]);
2355 } else {
2356 $name = '';
2357 $email = trim($val);
2358 }
2359
2360 if ($email) {
2361 $i++;
2362
2363 $newemail = '';
2364 if ($format == 5) {
2365 $newemail = $name ? $name : $email;
2366 $newemail = '<a href="mailto:'.$email.'">'.$newemail.'</a>';
2367 }
2368 if ($format == 4) {
2369 $newemail = $name ? $name : $email;
2370 }
2371 if ($format == 2) {
2372 $newemail = $email;
2373 }
2374 if ($format == 1 || $format == 3) {
2375 $newemail = '<'.$email.'>';
2376 }
2377 if ($format == 0 || $format == 3) {
2378 if (getDolGlobalString('MAIN_MAIL_NO_FULL_EMAIL')) {
2379 $newemail = '<'.$email.'>';
2380 } elseif (!$name) {
2381 $newemail = '<'.$email.'>';
2382 } else {
2383 $newemail = ($format == 3 ? '"' : '').($encode ? self::encodetorfc2822($name) : $name).($format == 3 ? '"' : '').' <'.$email.'>';
2384 //$newemail = (($format == 3 && !$encode) ? '"' : '').($encode ? self::encodetorfc2822($name) : $name).(($format == 3 && !$encode) ? '"' : '').' <'.$email.'>';
2385 }
2386 }
2387
2388 $ret = ($ret ? $ret.',' : '').$newemail;
2389
2390 // Stop if we have too much records
2391 if ($maxnumberofemail && $i >= $maxnumberofemail) {
2392 if (count($arrayaddress) > $maxnumberofemail) {
2393 $ret .= '...';
2394 }
2395 break;
2396 }
2397 }
2398 }
2399
2400 return $ret;
2401 }
2402
2410 public static function getArrayAddress($address)
2411 {
2412 $ret = array();
2413
2414 $arrayaddress = explode(',', $address);
2415
2416 // Loop over every component of the address
2417 foreach ($arrayaddress as $val) {
2418 $regs = array();
2419 if (preg_match('/^(.*)<(.*)>$/i', trim($val), $regs)) {
2420 $name = trim($regs[1]);
2421 $email = trim($regs[2]);
2422 } else {
2423 $name = null;
2424 $email = trim($val);
2425 }
2426
2427 $ret[$email] = getDolGlobalString('MAIN_MAIL_NO_FULL_EMAIL') ? null : $name;
2428 }
2429
2430 return $ret;
2431 }
2432}
global $dolibarr_main_url_root
Class to send emails (with attachments or not) Usage: $mailfile = new CMailFile($subject,...
_encode_file($sourcefile)
Read a file on disk and return encoded content for emails (mode = 'mail')
write_body($msgtext)
Return email content (mode = 'mail')
__construct($subject, $to, $from, $msg, $filename_list=array(), $mimetype_list=array(), $mimefilename_list=array(), $addr_cc="", $addr_bcc="", $deliveryreceipt=0, $msgishtml=0, $errors_to='', $css='', $trackid='', $moreinheader='', $sendcontext='standard', $replyto='', $upload_dir_tmp='', $in_reply_to='', $references='')
CMailFile.
dump_mail()
Write content of a SMTP request into a dump file (mode = all) Used for debugging.
sendfile()
Send mail that was prepared by constructor.
save_dump_mail_in_err($message='')
Save content if mail is in error Used for debugging.
static encodetorfc2822($stringtoencode)
Encode subject according to RFC 2822 - http://en.wikipedia.org/wiki/MIME#Encoded-Word.
checkIfHTML($msg)
Correct an incomplete html string.
static getValidAddress($address, $format, $encode=0, $maxnumberofemail=0)
Return a formatted address string for SMTP protocol.
write_images($images_list)
Attach an image to email (mode = 'mail')
server_parse($socket, $response)
This function has been modified as provided by SirSir to allow multiline responses when using SMTP Ex...
write_smtpheaders()
Create SMTP headers (mode = 'mail')
findHtmlImagesIsSrcData($images_dir)
Search images with src="data:image..." format into html message.
write_mimeheaders($filename_list, $mimefilename_list)
Create header MIME (mode = 'mail')
check_server_port($host, $port)
Try to create a socket connection.
buildCSS()
Build a css style (mode = all) into this->styleCSS and this->bodyCSS.
write_files($filename_list, $mimetype_list, $mimefilename_list, $cidlist)
Attach file to email (mode = 'mail')
static getArrayAddress($address)
Return a formatted array of address string for SMTP protocol.
findHtmlImages($images_dir)
Search images into html message and init array this->images_encoded if found This is called in the CM...
Class to manage hooks.
Class to construct and send SMTP compliant email, even to a secure SMTP server, regardless of platfor...
if(!isModEnabled('ai')||!getDolGlobalString('AI_ASSISTANT_ENABLED')) global $conf
The main.inc.php has been included so the following variable are now defined:
if(!isModEnabled('ai')||!getDolGlobalString('AI_ASSISTANT_ENABLED')) global $db
API class for accounts.
dol_move($srcfile, $destfile, $newmask='0', $overwriteifexists=1, $testvirus=0, $indexdatabase=1, $moreinfo=array(), $entity=null)
Move a file into another name.
archiveOrBackupFile($srcfile, $max_versions=5, $archivedir='', $suffix="v", $moveorcopy='move')
Manage backup versions for a given file, ensuring only a maximum number of versions are kept.
dol_is_file($pathoffile)
Return if path is a file.
dol_is_dir($folder)
Test if filename is a directory.
dol_now($mode='gmt')
Return date for now.
dol_osencode($str)
Return a string encoded into OS filesystem encoding.
dol_nl2br($stringtoencode, $nl2brmode=0, $forxml=false)
Replace CRLF in string with a HTML BR tag.
dolChmod($filepath, $newmask='')
Change mod of a file.
getDolGlobalInt($key, $default=0)
Return a Dolibarr global constant int value.
dol_string_unaccent($str)
Clean a string from all accent characters to be used as ref, login or by dol_sanitizeFileName.
ascii_check($str)
Check if a string is in ASCII.
dol_textishtml($msg, $option=0)
Return if a text is a html content.
dol_print_date($time, $format='', $tzoutput='auto', $outputlangs=null, $encodetooutput=false, $decorate=0)
Output date in a string format according to outputlangs (or langs if not defined).
getDolGlobalString($key, $default='')
Return a Dolibarr global constant string value.
utf8_check($str)
Check if a string is in UTF8.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.
dol_mkdir($dir, $dataroot='', $newmask='')
Creation of a directory (this can create recursive subdir)
dol_sanitizeEmail($stringtoclean)
Clean a string to use it as an Email.
isIPAllowed($iptocheck, $localurl)
Is IP allowed.
resolveDns($hosttocheck)
Resolve a hostname into its IP.
getSupportedOauth2Array()
Return array of tabs to use on pages to setup cron module.
dol_hash($chain, $type='0', $nosalt=0, $mode=0)
Returns a hash (non reversible encryption) of a string.