dolibarr 24.0.1
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->setReferences($this->references);
590 }
591
592 if (!empty($moreinheader)) {
593 $smtps->setMoreInHeader($moreinheader);
594 }
595
596 //X-Dolibarr-TRACKID, In-Reply-To, References and $moreinheader will be added to header inside the smtps->getHeader
597
598 if (!empty($this->html)) {
599 if (!empty($css)) {
600 $this->css = $css;
601 $this->buildCSS();
602 }
603 $msg = $this->html;
604 $msg = $this->checkIfHTML($msg); // This add a header and a body including custom CSS to the HTML content
605 }
606
607 if ($msg === '.') {
608 $msg = "\n.\n";
609 }
610 // Replace . alone on a new line with .. to avoid to have SMTP interpret this as end of message
611 $msg = preg_replace('/(\r|\n)\.(\r|\n)/ims', '\1..\2', $msg);
612
613 if ($this->msgishtml) {
614 $smtps->setBodyContent($msg, 'html');
615 } else {
616 $smtps->setBodyContent($msg, 'plain');
617 }
618
619 if (!empty($this->atleastoneimage)) {
620 foreach ($this->images_encoded as $img) {
621 $smtps->setImageInline($img['image_encoded'], $img['name'], $img['content_type'], $img['cid']);
622 }
623 }
624
625 if (!empty($this->atleastonefile)) {
626 foreach ($filename_list as $i => $val) {
627 $content = file_get_contents($filename_list[$i]);
628 if (empty($cid_list[$i])) {
629 $smtps->setAttachment($content, $mimefilename_list[$i], $mimetype_list[$i], (empty($cid_list[$i]) ? '' : $cid_list[$i]));
630 }
631 }
632 }
633
634 $smtps->setCC($this->addr_cc);
635 $smtps->setBCC($this->addr_bcc);
636 $smtps->setErrorsTo($this->errors_to);
637 $smtps->setDeliveryReceipt($this->deliveryreceipt);
638
639 $options = array();
640 if (getDolGlobalString($keyforsslseflsigned)) {
641 $options = array('ssl' => array('verify_peer' => false, 'verify_peer_name' => false, 'allow_self_signed' => true));
642 }
643 if (getDolGlobalString('SMTPS_CAPTURE_PEER_CERT')) {
644 $options = array_merge($options, array('ssl' => array('capture_peer_cert' => true, 'capture_peer_cert_chain' => true)));
645 // Adding this will allow the code to retrieve information about the TLS certificate by doing
646 // $cert = stream_context_get_params($this->socket)['options']['ssl']['peer_certificate'];
647 // echo "Server Certificate Information:\n";
648 // echo "Subject: " . openssl_x509_parse($cert)['subject']['CN'] . "\n";
649 // echo "Issuer: " . openssl_x509_parse($cert)['issuer']['CN'] . "\n";
650 // echo "Valid From: " . date('Y-m-d H:i:s', openssl_x509_parse($cert)['validFrom_time_t']) . "\n";
651 // echo "Valid To: " . date('Y-m-d H:i:s', openssl_x509_parse($cert)['validTo_time_t']) . "\n";
652 }
653 if (getDolGlobalString('SMTPS_FORCE_IP_V4')) {
654 $options = array_merge($options, array('socket' => ['bindto' => '0.0.0.0:0'])); // Forces IPv4 (IPv6 would be '::0')
655 }
656 if (!empty($options)) {
657 $smtps->setOptions($options);
658 }
659
660 $this->msgid = uniqid('', true).'.SMTPs-dolibarr-'.$this->trackid.'@'.$host;
661
662 $smtps->setMessageID($this->msgid);
663
664 $this->smtps = $smtps;
665 } elseif ($this->sendmode == 'swiftmailer') {
666 // Use Swift Mailer library
667 // ------------------------------------------
668 $host = dol_getprefix('email');
669
670 require_once DOL_DOCUMENT_ROOT.'/includes/swiftmailer/lexer/lib/Doctrine/Common/Lexer/AbstractLexer.php';
671
672 // egulias autoloader lib
673 require_once DOL_DOCUMENT_ROOT.'/includes/swiftmailer/autoload.php';
674
675 require_once DOL_DOCUMENT_ROOT.'/includes/swiftmailer/lib/swift_required.php';
676
677 // Create the message
678 //$this->message = Swift_Message::newInstance();
679 $this->message = new Swift_Message();
680 //$this->message = new Swift_SignedMessage();
681 // Adding a trackid header to a message
682 $headers = $this->message->getHeaders();
683
684 $headers->addTextHeader('X-Dolibarr-TRACKID', $this->trackid.'@'.$host);
685 $this->msgid = uniqid('', true).'.swiftmailer-dolibarr-'.$this->trackid.'@'.$host;
686 $headerID = $this->msgid;
687 $msgid = $headers->get('Message-ID');
688 if ($msgid instanceof Swift_Mime_Headers_IdentificationHeader) {
689 $msgid->setId($headerID);
690 }
691
692 // Add 'In-Reply-To:' header
693 if (!empty($this->in_reply_to)) {
694 $headers->addIdHeader('In-Reply-To', $this->in_reply_to);
695 }
696 // Add 'References:' header
697 if (!empty($this->references)) {
698 $headers->addIdHeader('References', $this->references);
699 }
700
701 if (!empty($moreinheader)) {
702 $moreinheaderarray = preg_split('/[\r\n]+/', $moreinheader);
703 foreach ($moreinheaderarray as $moreinheaderval) {
704 $moreinheadervaltmp = explode(':', $moreinheaderval, 2);
705 if (!empty($moreinheadervaltmp[0]) && !empty($moreinheadervaltmp[1])) {
706 $headers->addTextHeader($moreinheadervaltmp[0], $moreinheadervaltmp[1]);
707 }
708 }
709 }
710
711 // Give the message a subject
712 try {
713 $this->message->setSubject($this->subject);
714 } catch (Exception $e) {
715 $this->errors[] = $e->getMessage();
716 }
717
718 // Set the From address with an associative array
719 // $this->message->setFrom(array('john@doe.com' => 'John Doe'));
720 if (!empty($this->addr_from)) {
721 try {
722 if (getDolGlobalString('MAIN_FORCE_DISABLE_MAIL_SPOOFING')) {
723 // Prevent email spoofing for smtp server with a strict configuration
724 $regexp = '/([a-z0-9_\.\-\+])+\@(([a-z0-9\-])+\.)+([a-z0-9]{2,4})+/i'; // This regular expression extracts all emails from a string
725 $adressEmailFrom = array();
726 $emailMatchs = preg_match_all($regexp, $from, $adressEmailFrom);
727 $adressEmailFrom = reset($adressEmailFrom);
728 if ($emailMatchs !== false && filter_var(getDolGlobalString('MAIN_MAIL_SMTPS_ID'), FILTER_VALIDATE_EMAIL) && getDolGlobalString('MAIN_MAIL_SMTPS_ID') !== $adressEmailFrom[0]) {
729 $this->message->setFrom(getDolGlobalString('MAIN_MAIL_SMTPS_ID'));
730 } else {
731 $this->message->setFrom($this->getArrayAddress($this->addr_from));
732 }
733 } else {
734 $this->message->setFrom($this->getArrayAddress($this->addr_from));
735 }
736 } catch (Exception $e) {
737 $this->errors[] = $e->getMessage();
738 }
739 }
740
741 // Set the To addresses with an associative array
742 if (!empty($this->addr_to)) {
743 try {
744 $this->message->setTo($this->getArrayAddress($this->addr_to));
745 } catch (Exception $e) {
746 $this->errors[] = $e->getMessage();
747 }
748 }
749
750 if (!empty($this->reply_to)) {
751 try {
752 $this->message->SetReplyTo($this->getArrayAddress($this->reply_to));
753 } catch (Exception $e) {
754 $this->errors[] = $e->getMessage();
755 }
756 }
757
758 if (!empty($this->errors_to)) {
759 try {
760 $headers->addMailboxHeader('Errors-To', $this->getArrayAddress($this->errors_to));
761 } catch (Exception $e) {
762 $this->errors[] = $e->getMessage();
763 }
764 }
765
766 try {
767 $this->message->setCharSet($conf->file->character_set_client);
768 } catch (Exception $e) {
769 $this->errors[] = $e->getMessage();
770 }
771
772 if (!empty($this->html)) {
773 if (!empty($css)) {
774 $this->css = $css;
775 $this->buildCSS();
776 }
777 $msg = $this->html;
778 $msg = $this->checkIfHTML($msg); // This add a header and a body including custom CSS to the HTML content
779 }
780
781 if ($this->atleastoneimage) {
782 foreach ($this->html_images as $img) {
783 // $img['fullpath'],$img['image_encoded'],$img['name'],$img['content_type'],$img['cid']
784 $attachment = Swift_Image::fromPath($img['fullpath']);
785 // embed image
786 $imgcid = $this->message->embed($attachment);
787 // replace cid by the one created by swiftmail in html message
788 $msg = str_replace("cid:".$img['cid'], $imgcid, $msg);
789 }
790 foreach ($this->images_encoded as $img) {
791 //$img['fullpath'],$img['image_encoded'],$img['name'],$img['content_type'],$img['cid']
792 $attachment = Swift_Image::fromPath($img['fullpath']);
793 // embed image
794 $imgcid = $this->message->embed($attachment);
795 // replace cid by the one created by swiftmail in html message
796 $msg = str_replace("cid:".$img['cid'], $imgcid, $msg);
797 }
798 }
799
800 if ($this->msgishtml) {
801 $this->message->setBody($msg, 'text/html');
802 // And optionally an alternative body
803 $this->message->addPart(html_entity_decode(strip_tags($msg)), 'text/plain');
804 } else {
805 $this->message->setBody($msg, 'text/plain');
806 // And optionally an alternative body
807 $this->message->addPart(dol_nl2br($msg), 'text/html');
808 }
809
810 if (!empty($this->atleastonefile)) {
811 foreach ($filename_list as $i => $val) {
812 //$this->message->attach(Swift_Attachment::fromPath($filename_list[$i],$mimetype_list[$i]));
813 $attachment = Swift_Attachment::fromPath($filename_list[$i], $mimetype_list[$i]);
814 if (!empty($mimefilename_list[$i])) {
815 $attachment->setFilename($mimefilename_list[$i]);
816 }
817 $this->message->attach($attachment);
818 }
819 }
820
821 if (!empty($this->addr_cc)) {
822 try {
823 $this->message->setCc($this->getArrayAddress($this->addr_cc));
824 } catch (Exception $e) {
825 $this->errors[] = $e->getMessage();
826 }
827 }
828 if (!empty($this->addr_bcc)) {
829 try {
830 $this->message->setBcc($this->getArrayAddress($this->addr_bcc));
831 } catch (Exception $e) {
832 $this->errors[] = $e->getMessage();
833 }
834 }
835 if (isset($this->deliveryreceipt) && $this->deliveryreceipt == 1) {
836 try {
837 $this->message->setReadReceiptTo($this->getArrayAddress($this->addr_from));
838 } catch (Exception $e) {
839 $this->errors[] = $e->getMessage();
840 }
841 }
842 } else {
843 // Send mail method not correctly defined
844 // --------------------------------------
845 $this->error = 'Bad value for sendmode';
846 }
847 }
848
856 public function sendfile()
857 {
858 global $conf, $db, $langs, $hookmanager;
859
860 $errorlevel = error_reporting();
861 //error_reporting($errorlevel ^ E_WARNING); // Desactive warnings
862
863 $res = false;
864
865 if (!getDolGlobalString('MAIN_DISABLE_ALL_MAILS')) {
866 if (!is_object($hookmanager)) {
867 include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
868 $hookmanager = new HookManager($db);
869 }
870 $hookmanager->initHooks(array('mail'));
871
872 $parameters = array();
873 $action = '';
874 $reshook = $hookmanager->executeHooks('sendMail', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
875 if ($reshook < 0) {
876 $this->error = "Error in hook maildao sendMail ".$reshook;
877 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_ERR);
878
879 return false;
880 }
881 if ($reshook == 1) { // Hook replace standard code
882 dol_syslog("A hook has replaced code to send email", LOG_DEBUG);
883 return true;
884 }
885
886 $sendingmode = $this->sendmode;
887 if ($this->sendcontext == 'emailing' && getDolGlobalString('MAILING_NO_USING_PHPMAIL') && $sendingmode == 'mail') {
888 // List of sending methods
889 $listofmethods = array();
890 $listofmethods['mail'] = 'PHP mail function';
891 //$listofmethods['simplemail']='Simplemail class';
892 $listofmethods['smtps'] = 'SMTP/SMTPS socket library';
893
894 // 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.
895 // You ensure that every user is using its own SMTP server when using the mass emailing module.
896 $linktoadminemailbefore = '<a href="'.DOL_URL_ROOT.'/admin/mails.php">';
897 $linktoadminemailend = '</a>';
898 $this->error = $langs->trans("MailSendSetupIs", $listofmethods[$sendingmode]);
899 $this->errors[] = $langs->trans("MailSendSetupIs", $listofmethods[$sendingmode]);
900 $this->error .= '<br>'.$langs->trans("MailSendSetupIs2", $linktoadminemailbefore, $linktoadminemailend, $langs->transnoentitiesnoconv("MAIN_MAIL_SENDMODE"), $listofmethods['smtps']);
901 $this->errors[] = $langs->trans("MailSendSetupIs2", $linktoadminemailbefore, $linktoadminemailend, $langs->transnoentitiesnoconv("MAIN_MAIL_SENDMODE"), $listofmethods['smtps']);
902 if (getDolGlobalString('MAILING_SMTP_SETUP_EMAILS_FOR_QUESTIONS')) {
903 $this->error .= '<br>'.$langs->trans("MailSendSetupIs3", getDolGlobalString('MAILING_SMTP_SETUP_EMAILS_FOR_QUESTIONS'));
904 $this->errors[] = $langs->trans("MailSendSetupIs3", getDolGlobalString('MAILING_SMTP_SETUP_EMAILS_FOR_QUESTIONS'));
905 }
906
907 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_WARNING);
908 return false;
909 }
910
911 // Check number of recipient is lower or equal than MAIL_MAX_NB_OF_RECIPIENTS_IN_SAME_EMAIL
912 if (!getDolGlobalString('MAIL_MAX_NB_OF_RECIPIENTS_TO_IN_SAME_EMAIL')) {
913 $conf->global->MAIL_MAX_NB_OF_RECIPIENTS_TO_IN_SAME_EMAIL = 10;
914 }
915 $tmparray1 = explode(',', $this->addr_to);
916 if (count($tmparray1) > $conf->global->MAIL_MAX_NB_OF_RECIPIENTS_TO_IN_SAME_EMAIL) {
917 $this->error = 'Too much recipients in to:';
918 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_WARNING);
919 return false;
920 }
921 if (!getDolGlobalString('MAIL_MAX_NB_OF_RECIPIENTS_CC_IN_SAME_EMAIL')) {
922 $conf->global->MAIL_MAX_NB_OF_RECIPIENTS_CC_IN_SAME_EMAIL = 10;
923 }
924 $tmparray2 = explode(',', $this->addr_cc);
925 if (count($tmparray2) > $conf->global->MAIL_MAX_NB_OF_RECIPIENTS_CC_IN_SAME_EMAIL) {
926 $this->error = 'Too much recipients in cc:';
927 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_WARNING);
928 return false;
929 }
930 if (!getDolGlobalString('MAIL_MAX_NB_OF_RECIPIENTS_BCC_IN_SAME_EMAIL')) {
931 $conf->global->MAIL_MAX_NB_OF_RECIPIENTS_BCC_IN_SAME_EMAIL = 10;
932 }
933 $tmparray3 = explode(',', $this->addr_bcc);
934 if (count($tmparray3) > $conf->global->MAIL_MAX_NB_OF_RECIPIENTS_BCC_IN_SAME_EMAIL) {
935 $this->error = 'Too much recipients in bcc:';
936 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_WARNING);
937 return false;
938 }
939 if (!getDolGlobalString('MAIL_MAX_NB_OF_RECIPIENTS_IN_SAME_EMAIL')) {
940 $conf->global->MAIL_MAX_NB_OF_RECIPIENTS_IN_SAME_EMAIL = 10;
941 }
942 if ((count($tmparray1) + count($tmparray2) + count($tmparray3)) > $conf->global->MAIL_MAX_NB_OF_RECIPIENTS_IN_SAME_EMAIL) {
943 $this->error = 'Too much recipients in to:, cc:, bcc:';
944 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_WARNING);
945 return false;
946 }
947
948 $keyforsmtpserver = 'MAIN_MAIL_SMTP_SERVER';
949 $keyforsmtpport = 'MAIN_MAIL_SMTP_PORT';
950 $keyforsmtpid = 'MAIN_MAIL_SMTPS_ID';
951 $keyforsmtppw = 'MAIN_MAIL_SMTPS_PW';
952 $keyforsmtpauthtype = 'MAIN_MAIL_SMTPS_AUTH_TYPE';
953 $keyforsmtpoauthservice = 'MAIN_MAIL_SMTPS_OAUTH_SERVICE';
954 $keyfortls = 'MAIN_MAIL_EMAIL_TLS';
955 $keyforstarttls = 'MAIN_MAIL_EMAIL_STARTTLS';
956 $keyforsslseflsigned = 'MAIN_MAIL_EMAIL_SMTP_ALLOW_SELF_SIGNED';
957 if (!empty($this->sendcontext)) {
958 $smtpContextKey = strtoupper($this->sendcontext);
959 $smtpContextSendMode = getDolGlobalString('MAIN_MAIL_SENDMODE_'.$smtpContextKey);
960 if (!empty($smtpContextSendMode) && $smtpContextSendMode != 'default') {
961 $keyforsmtpserver = 'MAIN_MAIL_SMTP_SERVER_'.$smtpContextKey;
962 $keyforsmtpport = 'MAIN_MAIL_SMTP_PORT_'.$smtpContextKey;
963 $keyforsmtpid = 'MAIN_MAIL_SMTPS_ID_'.$smtpContextKey;
964 $keyforsmtppw = 'MAIN_MAIL_SMTPS_PW_'.$smtpContextKey;
965 $keyforsmtpauthtype = 'MAIN_MAIL_SMTPS_AUTH_TYPE_'.$smtpContextKey;
966 $keyforsmtpoauthservice = 'MAIN_MAIL_SMTPS_OAUTH_SERVICE_'.$smtpContextKey;
967 $keyfortls = 'MAIN_MAIL_EMAIL_TLS_'.$smtpContextKey;
968 $keyforstarttls = 'MAIN_MAIL_EMAIL_STARTTLS_'.$smtpContextKey;
969 $keyforsslseflsigned = 'MAIN_MAIL_EMAIL_SMTP_ALLOW_SELF_SIGNED_'.$smtpContextKey;
970 }
971 }
972
973 // Action according to chose sending method
974 if ($this->sendmode == 'mail') {
975 // Use mail php function (default PHP method)
976 // ------------------------------------------
977 dol_syslog("CMailFile::sendfile addr_to=".$this->addr_to.", subject=".$this->subject, LOG_NOTICE);
978 //dol_syslog("CMailFile::sendfile header=\n".$this->headers, LOG_DEBUG);
979 //dol_syslog("CMailFile::sendfile message=\n".$message);
980
981 // If Windows, sendmail_from must be defined
982 if (isset($_SERVER["WINDIR"])) {
983 if (empty($this->addr_from)) {
984 $this->addr_from = 'robot@example.com';
985 }
986 @ini_set('sendmail_from', $this->getValidAddress($this->addr_from, 2));
987 }
988
989 // Force parameters
990 //dol_syslog("CMailFile::sendfile conf->global->".$keyforsmtpserver."=".getDolGlobalString($keyforsmtpserver)." cpnf->global->".$keyforsmtpport."=".$conf->global->$keyforsmtpport, LOG_DEBUG);
991 if (getDolGlobalString($keyforsmtpserver)) {
992 ini_set('SMTP', getDolGlobalString($keyforsmtpserver));
993 }
994 if (getDolGlobalString($keyforsmtpport)) {
995 ini_set('smtp_port', getDolGlobalString($keyforsmtpport));
996 }
997
998 $res = true;
999 if ($res && !$this->subject) {
1000 $this->error = "Failed to send mail with php mail to HOST=".ini_get('SMTP').", PORT=".ini_get('smtp_port')."<br>Subject is empty";
1001 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_ERR);
1002 $res = false;
1003 }
1004 $dest = $this->getValidAddress($this->addr_to, 2);
1005 if ($res && !$dest) {
1006 $this->error = "Failed to send mail with php mail to HOST=".ini_get('SMTP').", PORT=".ini_get('smtp_port')."<br>Recipient address '$dest' invalid";
1007 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_ERR);
1008 $res = false;
1009 }
1010
1011 if ($res) {
1012 $additionnalparam = ''; // By default
1013 if (getDolGlobalString('MAIN_MAIL_ALLOW_SENDMAIL_F')) {
1014 // When using the phpmail function, the mail command may force the from to the user of the login, for example: linuxuser@myserver.mydomain.com
1015 // 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.
1016 // So forcing using the option -f of sendmail is possible if constant MAIN_MAIL_ALLOW_SENDMAIL_F is defined.
1017 // Having this variable defined may create problems with some sendmail (option -f refused)
1018 // Having this variable not defined may create problems with some other sendmail (option -f required)
1019 $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) : ''));
1020 }
1021 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
1022 $additionnalparam .= ($additionnalparam ? ' ' : '').'-ba';
1023 }
1024
1025 if (getDolGlobalString('MAIN_MAIL_SENDMAIL_FORCE_ADDPARAM')) {
1026 $additionnalparam .= ($additionnalparam ? ' ' : '').'-U '.$additionnalparam; // Use -U to add additional params
1027 }
1028
1029 $linuxlike = 1;
1030 if (preg_match('/^win/i', PHP_OS)) {
1031 $linuxlike = 0;
1032 }
1033 if (preg_match('/^mac/i', PHP_OS)) {
1034 $linuxlike = 0;
1035 }
1036
1037 dol_syslog("CMailFile::sendfile: mail start".($linuxlike ? '' : " HOST=".ini_get('SMTP').", PORT=".ini_get('smtp_port')).", additionnal_parameters=".$additionnalparam, LOG_DEBUG);
1038
1039 $this->message = stripslashes($this->message);
1040
1041 if (getDolGlobalString('MAIN_MAIL_DEBUG')) {
1042 $this->dump_mail();
1043 }
1044
1045 // Encode subject if required.
1046 $subjecttouse = $this->subject;
1047 if (!ascii_check($subjecttouse)) {
1048 $subjecttouse = $this->encodetorfc2822($subjecttouse);
1049 }
1050
1051 if (!empty($additionnalparam)) {
1052 $res = mail($dest, $subjecttouse, $this->message, $this->headers, $additionnalparam);
1053 } else {
1054 $res = mail($dest, $subjecttouse, $this->message, $this->headers);
1055 }
1056
1057 if (!$res) {
1058 $langs->load("errors");
1059 $this->error = "Failed to send mail with php mail";
1060 if (!$linuxlike) {
1061 $this->error .= " to HOST=".ini_get('SMTP').", PORT=".ini_get('smtp_port'); // This values are value used only for non linuxlike systems
1062 }
1063 $this->error .= ".<br>";
1064 $this->error .= $langs->trans("ErrorPhpMailDelivery");
1065 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_ERR);
1066
1067 if (getDolGlobalString('MAIN_MAIL_DEBUG')) {
1068 $this->save_dump_mail_in_err('Mail with topic '.$this->subject);
1069 }
1070 } else {
1071 dol_syslog("CMailFile::sendfile: mail end success", LOG_DEBUG);
1072 }
1073 }
1074
1075 if (isset($_SERVER["WINDIR"])) {
1076 @ini_restore('sendmail_from');
1077 }
1078
1079 // Restore parameters
1080 if (getDolGlobalString($keyforsmtpserver)) {
1081 ini_restore('SMTP');
1082 }
1083 if (getDolGlobalString($keyforsmtpport)) {
1084 ini_restore('smtp_port');
1085 }
1086 } elseif ($this->sendmode == 'smtps') {
1087 if (!is_object($this->smtps)) {
1088 $this->error = "Failed to send mail with smtps lib<br>Constructor of object CMailFile was not initialized without errors.";
1089 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_ERR);
1090 return false;
1091 }
1092
1093 // Use SMTPS library
1094 // ------------------------------------------
1095 $this->smtps->setTransportType(0); // Only this method is coded in SMTPs library
1096
1097 // Clean parameters
1098 if (empty($conf->global->$keyforsmtpserver)) {
1099 $conf->global->$keyforsmtpserver = ini_get('SMTP');
1100 }
1101 if (empty($conf->global->$keyforsmtpport)) {
1102 $conf->global->$keyforsmtpport = ini_get('smtp_port');
1103 }
1104
1105 // If we use SSL/TLS
1106 $server = getDolGlobalString($keyforsmtpserver);
1107 $secure = '';
1108 if (getDolGlobalString($keyfortls) && function_exists('openssl_open')) {
1109 $secure = 'ssl';
1110 }
1111 if (getDolGlobalString($keyforstarttls) && function_exists('openssl_open')) {
1112 $secure = 'tls';
1113 }
1114 $server = ($secure ? $secure.'://' : '').$server;
1115
1116 $port = getDolGlobalInt($keyforsmtpport);
1117
1118 $this->smtps->setHost($server);
1119 $this->smtps->setPort($port); // 25, 465...;
1120
1121 $loginid = '';
1122 $loginpass = '';
1123 if (getDolGlobalString($keyforsmtpid)) {
1124 $loginid = getDolGlobalString($keyforsmtpid);
1125 $this->smtps->setID($loginid);
1126 }
1127 if (getDolGlobalString($keyforsmtppw)) {
1128 $loginpass = getDolGlobalString($keyforsmtppw);
1129 $this->smtps->setPW($loginpass);
1130 }
1131
1132 if (getDolGlobalString($keyforsmtpauthtype) === "XOAUTH2") {
1133 require_once DOL_DOCUMENT_ROOT.'/core/lib/oauth.lib.php'; // define $supportedoauth2array
1134
1135 $supportedoauth2array = getSupportedOauth2Array();
1136
1137 $keyforsupportedoauth2array = getDolGlobalString($keyforsmtpoauthservice);
1138 if (preg_match('/^.*-/', $keyforsupportedoauth2array)) {
1139 $keyforprovider = preg_replace('/^.*-/', '', $keyforsupportedoauth2array);
1140 } else {
1141 $keyforprovider = '';
1142 }
1143 $keyforsupportedoauth2array = preg_replace('/-.*$/', '', $keyforsupportedoauth2array);
1144 $keyforsupportedoauth2array = 'OAUTH_'.$keyforsupportedoauth2array.'_NAME';
1145
1146 if (!empty($supportedoauth2array)) {
1147 $nameofservice = ucfirst(strtolower(empty($supportedoauth2array[$keyforsupportedoauth2array]['callbackfile']) ? 'Unknown' : $supportedoauth2array[$keyforsupportedoauth2array]['callbackfile']));
1148 $nameofservice .= ($keyforprovider ? '-'.$keyforprovider : '');
1149 $OAUTH_SERVICENAME = $nameofservice;
1150 } else {
1151 $OAUTH_SERVICENAME = 'Unknown';
1152 }
1153
1154 $keyforparamtenant = 'OAUTH_'.strtoupper(empty($supportedoauth2array[$keyforsupportedoauth2array]['callbackfile']) ? 'Unknown' : $supportedoauth2array[$keyforsupportedoauth2array]['callbackfile']).($keyforprovider ? '-'.$keyforprovider : '').'_TENANT';
1155
1156 require_once DOL_DOCUMENT_ROOT.'/includes/OAuth/bootstrap.php';
1157
1158 $storage = new DoliStorage($db, $conf, $keyforprovider, getDolGlobalString($keyforparamtenant));
1159 try {
1160 $tokenobj = $storage->retrieveAccessToken($OAUTH_SERVICENAME);
1161
1162 $expire = false;
1163 // Is token expired or will token expire in the next 30 seconds
1164 if (is_object($tokenobj)) {
1165 $expire = ($tokenobj->getEndOfLife() !== -9002 && $tokenobj->getEndOfLife() !== -9001 && time() > ($tokenobj->getEndOfLife() - 30));
1166 }
1167 // Token expired so we refresh it
1168 if (is_object($tokenobj) && $expire) {
1169 $credentials = new Credentials(
1170 getDolGlobalString('OAUTH_'.getDolGlobalString($keyforsmtpoauthservice).'_ID'),
1171 getDolGlobalString('OAUTH_'.getDolGlobalString($keyforsmtpoauthservice).'_SECRET'),
1172 getDolGlobalString('OAUTH_'.getDolGlobalString($keyforsmtpoauthservice).'_URLCALLBACK')
1173 );
1174 $serviceFactory = new \OAuth\ServiceFactory();
1175
1176 // Force the curl client, the default stream one uses file_get_contents() which
1177 // fails to reach the token endpoint on many setups, so the token is never refreshed.
1178 $httpClient = new \OAuth\Common\Http\Client\CurlClient();
1179 $serviceFactory->setHttpClient($httpClient);
1180 $oauthname = explode('-', $OAUTH_SERVICENAME);
1181 // Recreate the service with its configured scopes.
1182 // This matters for some providers (Microsoft v2 token endpoint) where scope may be required on refresh.
1183 $oauthScopes = array();
1184 $oauthScopesStr = getDolGlobalString('OAUTH_'.getDolGlobalString($keyforsmtpoauthservice).'_SCOPE');
1185 if (!empty($oauthScopesStr)) {
1186 $oauthScopes = preg_split('/\s*,\s*/', $oauthScopesStr);
1187 if (!is_array($oauthScopes)) {
1188 $oauthScopes = array();
1189 }
1190 }
1191
1192 // ex service is Google-Emails we need only the first part Google
1193 $apiService = $serviceFactory->createService($oauthname[0], $credentials, $storage, $oauthScopes);
1194
1195 // Some providers (like Google) return a refresh token only once.
1196 // If the refreshed token does not contain one, keep the previous refresh token.
1197 $refreshtoken = $tokenobj->getRefreshToken();
1198
1199 if ($apiService instanceof OAuth\OAuth2\Service\AbstractService || $apiService instanceof OAuth\OAuth1\Service\AbstractService) {
1200 // ServiceInterface does not provide refreshAccessToken, AbstractService does
1201 $tokenobj = $apiService->refreshAccessToken($tokenobj);
1202 if (empty($tokenobj->getRefreshToken())) {
1203 $tokenobj->setRefreshToken($refreshtoken);
1204 }
1205 $storage->storeAccessToken($OAUTH_SERVICENAME, $tokenobj);
1206 }
1207
1208 $tokenobj = $storage->retrieveAccessToken($OAUTH_SERVICENAME);
1209 }
1210
1211 if (is_object($tokenobj)) {
1212 $this->smtps->setToken($tokenobj->getAccessToken());
1213 } else {
1214 $this->error = "Token not found";
1215 }
1216 } catch (Exception $e) {
1217 // Return an error if token not found
1218 $this->error = $e->getMessage();
1219 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_ERR);
1220 }
1221 }
1222
1223 $res = true;
1224 $from = $this->smtps->getFrom('org');
1225 if ($res && !$from) {
1226 $this->error = "Failed to send mail with smtps lib to HOST=".$server.", PORT=" . getDolGlobalString($keyforsmtpport)." - Sender address '$from' invalid";
1227 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_ERR);
1228 $res = false;
1229 }
1230 $dest = $this->smtps->getTo();
1231 if ($res && !$dest) {
1232 $this->error = "Failed to send mail with smtps lib to HOST=".$server.", PORT=" . getDolGlobalString($keyforsmtpport)." - Recipient address '$dest' invalid";
1233 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_ERR);
1234 $res = false;
1235 }
1236
1237 if ($res) {
1238 dol_syslog("CMailFile::sendfile: sendMsg, HOST=".$server.", PORT=" . getDolGlobalString($keyforsmtpport), LOG_NOTICE);
1239
1240 if (getDolGlobalString('MAIN_MAIL_DEBUG')) {
1241 $this->smtps->setDebug(true);
1242 }
1243
1244 $result = $this->smtps->sendMsg();
1245
1246 if (getDolGlobalString('MAIN_MAIL_DEBUG')) {
1247 $this->dump_mail(); // Create file dolibarr_mail.log or dolibarr_mail.log.vXXX if option for archive is on
1248 }
1249
1250 $smtperrorcode = 0;
1251 if (! $result) {
1252 $smtperrorcode = $this->smtps->lastretval; // SMTP error code
1253 dol_syslog("CMailFile::sendfile: mail SMTP error code ".$smtperrorcode, LOG_WARNING);
1254
1255 if ($smtperrorcode == '421') { // Try later
1256 // TODO Add a delay and try again
1257 /*
1258 dol_syslog("CMailFile::sendfile: Try later error, so we wait and we retry");
1259 sleep(2);
1260
1261 $result = $this->smtps->sendMsg();
1262
1263 if (getDolGlobalString('MAIN_MAIL_DEBUG')) {
1264 $this->dump_mail();
1265 }
1266 */
1267 }
1268 } else {
1269 dol_syslog("CMailFile::sendfile: mail SMTP sendMsg is success", LOG_DEBUG);
1270 }
1271
1272 $result = $this->smtps->getErrors(); // applicative error code (not SMTP error code)
1273
1274 if (empty($this->error) && empty($result)) {
1275 dol_syslog("CMailFile::sendfile: mail end success", LOG_DEBUG);
1276 $res = true;
1277 } else {
1278 if (empty($this->error)) {
1279 $this->error = $result;
1280 }
1281 dol_syslog("CMailFile::sendfile: mail end error with smtps lib to HOST=".$server.", PORT=" . getDolGlobalString($keyforsmtpport)." - ".$this->error, LOG_ERR);
1282 $res = false;
1283
1284 if (getDolGlobalString('MAIN_MAIL_DEBUG')) {
1285 $this->save_dump_mail_in_err('Mail smtp error '.$smtperrorcode.' with topic '.$this->subject.' - '.$this->error);
1286 }
1287 }
1288 }
1289 } elseif ($this->sendmode == 'swiftmailer') {
1290 // Use Swift Mailer library
1291 // ------------------------------------------
1292 require_once DOL_DOCUMENT_ROOT.'/includes/swiftmailer/lib/swift_required.php';
1293
1294 // Clean parameters
1295 if (empty($conf->global->$keyforsmtpserver)) {
1296 $conf->global->$keyforsmtpserver = ini_get('SMTP');
1297 }
1298 if (empty($conf->global->$keyforsmtpport)) {
1299 $conf->global->$keyforsmtpport = ini_get('smtp_port');
1300 }
1301
1302 // If we use SSL/TLS
1303 $server = getDolGlobalString($keyforsmtpserver);
1304 $secure = '';
1305 if (getDolGlobalString($keyfortls) && function_exists('openssl_open')) {
1306 $secure = 'ssl';
1307 }
1308 if (getDolGlobalString($keyforstarttls) && function_exists('openssl_open')) {
1309 $secure = 'tls';
1310 }
1311
1312 $this->transport = new Swift_SmtpTransport($server, getDolGlobalInt($keyforsmtpport), $secure);
1313
1314 if (getDolGlobalString($keyforsmtpid)) {
1315 $this->transport->setUsername(getDolGlobalString($keyforsmtpid));
1316 }
1317 if (getDolGlobalString($keyforsmtppw) && getDolGlobalString($keyforsmtpauthtype) != "XOAUTH2") {
1318 $this->transport->setPassword(getDolGlobalString($keyforsmtppw));
1319 }
1320 if (getDolGlobalString($keyforsmtpauthtype) === "XOAUTH2") {
1321 $this->transport->setAuthMode('XOAUTH2');
1322 require_once DOL_DOCUMENT_ROOT.'/core/lib/oauth.lib.php';
1323
1324 $supportedoauth2array = getSupportedOauth2Array();
1325
1326 $keyforsupportedoauth2array = getDolGlobalString($keyforsmtpoauthservice);
1327 if (preg_match('/^.*-/', $keyforsupportedoauth2array)) {
1328 $keyforprovider = preg_replace('/^.*-/', '', $keyforsupportedoauth2array);
1329 } else {
1330 $keyforprovider = '';
1331 }
1332 $keyforsupportedoauth2array = preg_replace('/-.*$/', '', $keyforsupportedoauth2array);
1333 $keyforsupportedoauth2array = 'OAUTH_'.$keyforsupportedoauth2array.'_NAME';
1334
1335 if (!empty($supportedoauth2array)) {
1336 $nameofservice = ucfirst(strtolower(empty($supportedoauth2array[$keyforsupportedoauth2array]['callbackfile']) ? 'Unknown' : $supportedoauth2array[$keyforsupportedoauth2array]['callbackfile']));
1337 $nameofservice .= ($keyforprovider ? '-'.$keyforprovider : '');
1338 $OAUTH_SERVICENAME = $nameofservice;
1339 } else {
1340 $OAUTH_SERVICENAME = 'Unknown';
1341 }
1342
1343 $keyforparamtenant = 'OAUTH_'.strtoupper(empty($supportedoauth2array[$keyforsupportedoauth2array]['callbackfile']) ? 'Unknown' : $supportedoauth2array[$keyforsupportedoauth2array]['callbackfile']).($keyforprovider ? '-'.$keyforprovider : '').'_TENANT';
1344
1345 require_once DOL_DOCUMENT_ROOT.'/includes/OAuth/bootstrap.php';
1346
1347 $storage = new DoliStorage($db, $conf, $keyforprovider, getDolGlobalString($keyforparamtenant));
1348
1349 try {
1350 $tokenobj = $storage->retrieveAccessToken($OAUTH_SERVICENAME);
1351
1352 $expire = false;
1353 // Is token expired or will token expire in the next 30 seconds
1354 if (is_object($tokenobj)) {
1355 $expire = ($tokenobj->getEndOfLife() !== -9002 && $tokenobj->getEndOfLife() !== -9001 && time() > ($tokenobj->getEndOfLife() - 30));
1356 }
1357 // Token expired so we refresh it
1358 if (is_object($tokenobj) && $expire) {
1359 $credentials = new Credentials(
1360 getDolGlobalString('OAUTH_'.getDolGlobalString($keyforsmtpoauthservice).'_ID'),
1361 getDolGlobalString('OAUTH_'.getDolGlobalString($keyforsmtpoauthservice).'_SECRET'),
1362 getDolGlobalString('OAUTH_'.getDolGlobalString($keyforsmtpoauthservice).'_URLCALLBACK')
1363 );
1364 $serviceFactory = new \OAuth\ServiceFactory();
1365
1366 // Force the curl client, the default stream one uses file_get_contents() which
1367 // fails to reach the token endpoint on many setups, so the token is never refreshed.
1368 $httpClient = new \OAuth\Common\Http\Client\CurlClient();
1369 $serviceFactory->setHttpClient($httpClient);
1370 $oauthname = explode('-', $OAUTH_SERVICENAME);
1371 // Recreate the service with its configured scopes.
1372 // This matters for some providers (Microsoft v2 token endpoint) where scope may be required on refresh.
1373 $oauthScopes = array();
1374 $oauthScopesStr = getDolGlobalString('OAUTH_'.getDolGlobalString($keyforsmtpoauthservice).'_SCOPE');
1375 if (!empty($oauthScopesStr)) {
1376 $oauthScopes = preg_split('/\s*,\s*/', $oauthScopesStr);
1377 if (!is_array($oauthScopes)) {
1378 $oauthScopes = array();
1379 }
1380 }
1381
1382 // ex service is Google-Emails we need only the first part Google
1383 $apiService = $serviceFactory->createService($oauthname[0], $credentials, $storage, $oauthScopes);
1384 $refreshtoken = $tokenobj->getRefreshToken();
1385
1386 if ($apiService instanceof OAuth\OAuth2\Service\AbstractService || $apiService instanceof OAuth\OAuth1\Service\AbstractService) {
1387 // ServiceInterface does not provide refreshAccessToken, AbstractService does
1388 $tokenobj = $apiService->refreshAccessToken($tokenobj);
1389 if (empty($tokenobj->getRefreshToken())) {
1390 $tokenobj->setRefreshToken($refreshtoken);
1391 }
1392 $storage->storeAccessToken($OAUTH_SERVICENAME, $tokenobj);
1393
1394 $tokenobj = $storage->retrieveAccessToken($OAUTH_SERVICENAME);
1395 }
1396 }
1397
1398 if (is_object($tokenobj)) {
1399 $this->transport->setAuthMode('XOAUTH2');
1400 $this->transport->setPassword($tokenobj->getAccessToken());
1401 } else {
1402 $this->errors[] = "Token not found";
1403 dol_syslog("CMailFile::sendfile: OAuth2 token object is not valid", LOG_ERR);
1404 }
1405 } catch (Exception $e) {
1406 // Return an error if token not found
1407 $this->errors[] = $e->getMessage();
1408 dol_syslog("CMailFile::sendfile: mail end error=".$e->getMessage(), LOG_ERR);
1409 }
1410 }
1411 if (getDolGlobalString($keyforsslseflsigned)) {
1412 $this->transport->setStreamOptions(array('ssl' => array('allow_self_signed' => true, 'verify_peer' => false)));
1413 }
1414 //$smtps->_msgReplyTo = 'reply@web.com';
1415
1416 // Switch content encoding to base64 - avoid the doubledot issue with quoted-printable
1417 $contentEncoderBase64 = new Swift_Mime_ContentEncoder_Base64ContentEncoder();
1418 $this->message->setEncoder($contentEncoderBase64);
1419
1420 // Create the Mailer using your created Transport
1421 $this->mailer = new Swift_Mailer($this->transport);
1422
1423 // DKIM SIGN
1424 if (getDolGlobalString('MAIN_MAIL_EMAIL_DKIM_ENABLED')) {
1425 $privateKey = getDolGlobalString('MAIN_MAIL_EMAIL_DKIM_PRIVATE_KEY');
1426 $domainName = getDolGlobalString('MAIN_MAIL_EMAIL_DKIM_DOMAIN');
1427 $selector = getDolGlobalString('MAIN_MAIL_EMAIL_DKIM_SELECTOR');
1428 $signer = new Swift_Signers_DKIMSigner($privateKey, $domainName, $selector);
1429 $this->message->attachSigner($signer->ignoreHeader('Return-Path'));
1430 }
1431
1432 if (getDolGlobalString('MAIN_MAIL_DEBUG')) {
1433 // To use the ArrayLogger
1434 $this->logger = new Swift_Plugins_Loggers_ArrayLogger();
1435 // Or to use the Echo Logger
1436 //$this->logger = new Swift_Plugins_Loggers_EchoLogger();
1437 $this->mailer->registerPlugin(new Swift_Plugins_LoggerPlugin($this->logger));
1438 }
1439
1440 dol_syslog("CMailFile::sendfile: mailer->send, HOST=".$server.", PORT=" . getDolGlobalString($keyforsmtpport), LOG_NOTICE);
1441
1442 // send mail
1443 $failedRecipients = array();
1444 $result = null;
1445 try {
1446 $result = $this->mailer->send($this->message, $failedRecipients);
1447 } catch (Exception $e) {
1448 $this->errors[] = $e->getMessage();
1449 }
1450 if (getDolGlobalString('MAIN_MAIL_DEBUG')) {
1451 $this->dump_mail();
1452 }
1453
1454 $res = true;
1455 if (!empty($this->error) || !empty($this->errors) || !$result) {
1456 if (!empty($failedRecipients)) {
1457 $this->error = 'Transport failed for the following addresses: "' . implode('", "', $failedRecipients) . '".';
1458 $this->errors[] = $this->error;
1459 }
1460 dol_syslog("CMailFile::sendfile: mail end error=". implode(' ', $this->errors), LOG_ERR);
1461 $res = false;
1462
1463 if (getDolGlobalString('MAIN_MAIL_DEBUG')) {
1464 $this->save_dump_mail_in_err('Mail with topic '.$this->subject);
1465 }
1466 } else {
1467 dol_syslog("CMailFile::sendfile: mail end success", LOG_DEBUG);
1468 }
1469 } else {
1470 // Send mail method not correctly defined
1471 // --------------------------------------
1472
1473 $this->error = 'Bad value for sendmode';
1474 return false;
1475 }
1476
1477 // Now we delete image files that were created dynamically to manage data inline files
1478 /* Note: dol_delete call was disabled, so code commented to not trigger empty if body
1479 foreach ($this->html_images as $val) {
1480 if (!empty($val['type']) && $val['type'] == 'cidfromdata') {
1481 //dol_delete($val['fullpath']);
1482 }
1483 }
1484 */
1485
1486 $parameters = array('sent' => $res);
1487 $action = '';
1488 $reshook = $hookmanager->executeHooks('sendMailAfter', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
1489 if ($reshook < 0) {
1490 $this->error = "Error in hook maildao sendMailAfter ".$reshook;
1491 dol_syslog("CMailFile::sendfile: mail end error=".$this->error, LOG_ERR);
1492
1493 return false;
1494 }
1495 } else {
1496 $this->error = 'No mail sent. Feature is disabled by option MAIN_DISABLE_ALL_MAILS';
1497 dol_syslog("CMailFile::sendfile: ".$this->error, LOG_WARNING);
1498 }
1499
1500 error_reporting($errorlevel); // Reactive original error level
1501 return $res;
1502 }
1503
1510 public static function encodetorfc2822($stringtoencode)
1511 {
1512 global $conf;
1513 return '=?'.$conf->file->character_set_client.'?B?'.base64_encode($stringtoencode).'?=';
1514 }
1515
1516 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1523 private function _encode_file($sourcefile)
1524 {
1525 // phpcs:enable
1526 $newsourcefile = dol_osencode($sourcefile);
1527
1528 if (is_readable($newsourcefile)) {
1529 $contents = file_get_contents($newsourcefile); // Need PHP 4.3
1530 $encoded = chunk_split(base64_encode($contents), 76, $this->eol); // 76 max is defined into http://tools.ietf.org/html/rfc2047
1531 return $encoded;
1532 } else {
1533 $this->error = "Error in _encode_file() method: Can't read file '".$sourcefile."'";
1534 dol_syslog("CMailFile::_encode_file: ".$this->error, LOG_ERR);
1535 return -1;
1536 }
1537 }
1538
1539 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1547 public function dump_mail()
1548 {
1549 // phpcs:enable
1550 global $dolibarr_main_data_root;
1551
1552 if (@is_writable($dolibarr_main_data_root)) { // Avoid fatal error on fopen with open_basedir
1553 $outputfile = $dolibarr_main_data_root."/dolibarr_mail.log";
1554 $fp = fopen($outputfile, "w"); // overwrite
1555
1556 if ($fp) {
1557 if ($this->sendmode == 'mail') {
1558 fwrite($fp, 'Param 1 (dest) for mail(): Not yet available in dump');
1559 fwrite($fp, $this->eol); // This eol is added by the mail function, so we add it in log
1560 fwrite($fp, 'Param 2 (topic) for mail(): '.$this->subject);
1561 fwrite($fp, $this->eol); // This eol is added by the mail function, so we add it in log
1562 fwrite($fp, 'Param 4 (headers) for mail():'."\n");
1563 fwrite($fp, $this->headers);
1564 fwrite($fp, $this->eol); // This eol is added by the mail function, so we add it in log
1565 fwrite($fp, 'Param 3 (message) for mail():'."\n");
1566 fwrite($fp, $this->message);
1567 } elseif ($this->sendmode == 'smtps') {
1568 fwrite($fp, $this->smtps->log); // this->smtps->log is filled only if MAIN_MAIL_DEBUG was set to on
1569 } elseif ($this->sendmode == 'swiftmailer') {
1570 fwrite($fp, "smtpheader=\n".$this->message->getHeaders()->toString()."\n");
1571 fwrite($fp, $this->logger->dump()); // this->logger is filled only if MAIN_MAIL_DEBUG was set to on
1572 }
1573
1574 fclose($fp);
1575 dolChmod($outputfile);
1576
1577 // Move dolibarr_mail.log into a dolibarr_mail.log.v123456789
1578 if (getDolGlobalInt('MAIN_MAIL_DEBUG_LOG_WITH_DATE')) {
1579 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
1580 archiveOrBackupFile($outputfile, getDolGlobalInt('MAIN_MAIL_DEBUG_LOG_WITH_DATE'));
1581 }
1582 }
1583 }
1584 }
1585
1586 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1594 public function save_dump_mail_in_err($message = '')
1595 {
1596 global $dolibarr_main_data_root;
1597
1598 if (@is_writable($dolibarr_main_data_root)) { // Avoid fatal error on fopen with open_basedir
1599 $srcfile = $dolibarr_main_data_root."/dolibarr_mail.log";
1600
1601 // Add message to dolibarr_mail.log. We do not use dol_syslog() on purpose,
1602 // to be sure to write into dolibarr_mail.log
1603 if ($message) {
1604 // Test constant SYSLOG_FILE_NO_ERROR (should stay a constant defined with define('SYSLOG_FILE_NO_ERROR',1);
1605 if (defined('SYSLOG_FILE_NO_ERROR')) {
1606 $filefd = @fopen($srcfile, 'a+');
1607 } else {
1608 $filefd = fopen($srcfile, 'a+');
1609 }
1610 if ($filefd) {
1611 fwrite($filefd, $message."\n");
1612 fclose($filefd);
1613 dolChmod($srcfile);
1614 }
1615 }
1616
1617 // Move dolibarr_mail.log into a dolibarr_mail.err or dolibarr_mail.date.err
1618 if (getDolGlobalString('MAIN_MAIL_DEBUG_ERR_WITH_DATE')) {
1619 $destfile = $dolibarr_main_data_root."/dolibarr_mail.".dol_print_date(dol_now(), 'dayhourlog', 'gmt').".err";
1620 } else {
1621 $destfile = $dolibarr_main_data_root."/dolibarr_mail.err";
1622 }
1623
1624 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
1625 dol_move($srcfile, $destfile, '0', 1, 0, 0);
1626 }
1627 }
1628
1635 public function checkIfHTML($msg)
1636 {
1637 if (!preg_match('/^[\s\t]*<html/i', $msg)) {
1638 $out = "<html><head><title></title>";
1639 if (!empty($this->styleCSS)) {
1640 $out .= $this->styleCSS;
1641 }
1642 $out .= "</head><body";
1643 if (!empty($this->bodyCSS)) {
1644 $out .= $this->bodyCSS;
1645 }
1646 $out .= ">";
1647 $out .= $msg;
1648 $out .= "</body></html>";
1649 } else {
1650 $out = $msg;
1651 }
1652
1653 return $out;
1654 }
1655
1661 public function buildCSS()
1662 {
1663 if (!empty($this->css)) {
1664 // Style CSS
1665 $this->styleCSS = '<style type="text/css">';
1666 $this->styleCSS .= 'body {';
1667
1668 if ($this->css['bgcolor']) {
1669 $this->styleCSS .= ' background-color: '.$this->css['bgcolor'].';';
1670 $this->bodyCSS .= ' bgcolor="'.$this->css['bgcolor'].'"';
1671 }
1672 if ($this->css['bgimage']) {
1673 // TODO recuperer cid
1674 $this->styleCSS .= ' background-image: url("cid:'.$this->css['bgimage_cid'].'");';
1675 }
1676 $this->styleCSS .= '}';
1677 $this->styleCSS .= '</style>';
1678 }
1679 }
1680
1681 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1687 public function write_smtpheaders()
1688 {
1689 // phpcs:enable
1690 $out = "";
1691 $host = dol_getprefix('email');
1692
1693 // Sender
1694 //$out.= "Sender: ".getValidAddress($this->addr_from,2)).$this->eol2;
1695 $out .= "From: ".$this->getValidAddress($this->addr_from, 3, 1).$this->eol2;
1696 if (getDolGlobalString('MAIN_MAIL_SENDMAIL_FORCE_BA')) {
1697 $out .= "To: ".$this->getValidAddress($this->addr_to, 0, 1).$this->eol2;
1698 }
1699 if (!getDolGlobalString('MAIN_MAIL_NO_RETURN_PATH_FOR_MODE_MAIL')) {
1700 // Return-Path is important because it is used by SPF. Some command line MTA overwrites the Return-Path, even if already in the
1701 // 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.
1702 // Return-Path is used for bounced emails. If not set (most cases), the From is used.
1703 $out .= "Return-Path: ".$this->getValidAddress($this->addr_from, 1, 1).$this->eol2;
1704 }
1705 if (isset($this->reply_to) && $this->reply_to) {
1706 $out .= "Reply-To: ".$this->getValidAddress($this->reply_to, 2).$this->eol2;
1707 }
1708 if (isset($this->errors_to) && $this->errors_to) {
1709 $out .= "Errors-To: ".$this->getValidAddress($this->errors_to, 2).$this->eol2;
1710 }
1711
1712 // Receiver
1713 if (isset($this->addr_cc) && $this->addr_cc) {
1714 $out .= "Cc: ".$this->getValidAddress($this->addr_cc, 2).$this->eol2;
1715 }
1716 if (isset($this->addr_bcc) && $this->addr_bcc) {
1717 $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 ?
1718 }
1719
1720 // Delivery receipt
1721 if (isset($this->deliveryreceipt) && $this->deliveryreceipt == 1) {
1722 $out .= "Disposition-Notification-To: ".$this->getValidAddress($this->addr_from, 2).$this->eol2;
1723 }
1724
1725 //$out.= "X-Priority: 3".$this->eol2;
1726 $out .= 'Date: '.date("r").$this->eol2;
1727
1728 $trackid = $this->trackid;
1729 if ($trackid) {
1730 $this->msgid = uniqid('', true).'.phpmail-dolibarr-'.$trackid.'@'.$host;
1731 $out .= 'Message-ID: <'.$this->msgid.">".$this->eol2; // Uppercase seems replaced by phpmail
1732 $out .= 'X-Dolibarr-TRACKID: '.$trackid.'@'.$host.$this->eol2;
1733 } else {
1734 $this->msgid = uniqid('', true).'.phpmail@'.$host;
1735 $out .= 'Message-ID: <'.$this->msgid.">".$this->eol2;
1736 }
1737
1738 // Add 'In-Reply-To:' header with the Message-Id we answer
1739 if (!empty($this->in_reply_to)) {
1740 $out .= 'In-Reply-To: <'.$this->in_reply_to.'>'.$this->eol2;
1741 }
1742 // Add 'References:' header with list of all Message-ID in thread history
1743 if (!empty($this->references)) {
1744 $out .= 'References: '.$this->references.$this->eol2;
1745 }
1746
1747 if (!empty($_SERVER['REMOTE_ADDR'])) {
1748 $out .= "X-RemoteAddr: ".$_SERVER['REMOTE_ADDR'].$this->eol2;
1749 }
1750 $out .= "X-Mailer: Dolibarr version ".DOL_VERSION." (using php mail)".$this->eol2;
1751 $out .= "Mime-Version: 1.0".$this->eol2;
1752
1753 //$out.= "From: ".$this->getValidAddress($this->addr_from,3,1).$this->eol;
1754
1755 $out .= "Content-Type: multipart/mixed;".$this->eol2." boundary=\"".$this->mixed_boundary."\"".$this->eol2;
1756 if (!getDolGlobalString("MAIN_EMAIL_DISABLE_ADD_CONTENT_ENCODING_8BIT")) {
1757 $out .= "Content-Transfer-Encoding: 8bit".$this->eol2; // TODO Seems to be ignored. Header is 7bit once received.
1758 }
1759
1760 dol_syslog("CMailFile::write_smtpheaders smtp_header=\n".$out, LOG_DEBUG);
1761 return $out;
1762 }
1763
1764 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1772 public function write_mimeheaders($filename_list, $mimefilename_list)
1773 {
1774 // phpcs:enable
1775 $out = "";
1776
1777 if (is_array($filename_list) && is_array($mimefilename_list)) {
1778 $filename_list_size = count($filename_list);
1779 for ($i = 0; $i < $filename_list_size; $i++) {
1780 if ($filename_list[$i]) {
1781 if ($mimefilename_list[$i]) {
1782 $filename_list[$i] = $mimefilename_list[$i];
1783 }
1784 $out .= "X-attachments: $filename_list[$i]".$this->eol2;
1785 }
1786 }
1787 }
1788
1789 dol_syslog("CMailFile::write_mimeheaders mime_header=\n".$out, LOG_DEBUG);
1790 return $out;
1791 }
1792
1793 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1800 public function write_body($msgtext)
1801 {
1802 // phpcs:enable
1803 global $conf;
1804
1805 $out = '';
1806
1807 $out .= "--".$this->mixed_boundary.$this->eol;
1808
1809 if ($this->atleastoneimage) {
1810 $out .= "Content-Type: multipart/alternative;".$this->eol." boundary=\"".$this->alternative_boundary."\"".$this->eol;
1811 $out .= $this->eol;
1812 $out .= "--".$this->alternative_boundary.$this->eol;
1813 }
1814
1815 // Make RFC821 Compliant, replace bare linefeeds
1816 $strContent = preg_replace("/(?<!\r)\n/si", "\r\n", $msgtext); // PCRE modifier /s means new lines are common chars
1817 if (getDolGlobalString('MAIN_FIX_FOR_BUGGED_MTA')) {
1818 $strContent = preg_replace("/\r\n/si", "\n", $strContent); // PCRE modifier /s means new lines are common chars
1819 }
1820
1821 $strContentAltText = '';
1822 if ($this->msgishtml) {
1823 // Similar code to forge a text from html is also in smtps.class.php
1824 $strContentAltText = preg_replace("/<br\s*[^>]*>/", " ", $strContent);
1825 // TODO We could replace <img ...> with [Filename.ext] like Gmail do.
1826 $strContentAltText = html_entity_decode(strip_tags($strContentAltText)); // Remove any HTML tags
1827 $strContentAltText = trim(wordwrap($strContentAltText, 75, !getDolGlobalString('MAIN_FIX_FOR_BUGGED_MTA') ? "\r\n" : "\n"));
1828
1829 // Check if html header already in message, if not complete the message
1830 $strContent = $this->checkIfHTML($strContent); // This add a header and a body including custom CSS to the HTML content
1831 }
1832
1833 // Make RFC2045 Compliant, split lines
1834 //$strContent = rtrim(chunk_split($strContent)); // Function chunck_split seems ko if not used on a base64 content
1835 // TODO Encode main content into base64 and use the chunk_split, or quoted-printable
1836 $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.
1837
1838 if ($this->msgishtml) {
1839 if ($this->atleastoneimage) {
1840 $out .= "Content-Type: text/plain; charset=".$conf->file->character_set_client.$this->eol;
1841 //$out.= "Content-Transfer-Encoding: 7bit".$this->eol;
1842 $out .= $this->eol.($strContentAltText ? $strContentAltText : strip_tags($strContent)).$this->eol; // Add plain text message
1843 $out .= "--".$this->alternative_boundary.$this->eol;
1844 $out .= "Content-Type: multipart/related;".$this->eol." boundary=\"".$this->related_boundary."\"".$this->eol;
1845 $out .= $this->eol;
1846 $out .= "--".$this->related_boundary.$this->eol;
1847 }
1848
1849 if (!$this->atleastoneimage && $strContentAltText && getDolGlobalString('MAIN_MAIL_USE_MULTI_PART')) { // Add plain text message part before html part
1850 $out .= "Content-Type: multipart/alternative;".$this->eol." boundary=\"".$this->alternative_boundary."\"".$this->eol;
1851 $out .= $this->eol;
1852 $out .= "--".$this->alternative_boundary.$this->eol;
1853 $out .= "Content-Type: text/plain; charset=".$conf->file->character_set_client.$this->eol;
1854 //$out.= "Content-Transfer-Encoding: 7bit".$this->eol;
1855 $out .= $this->eol.$strContentAltText.$this->eol;
1856 $out .= "--".$this->alternative_boundary.$this->eol;
1857 }
1858
1859 $out .= "Content-Type: text/html; charset=".$conf->file->character_set_client.$this->eol;
1860 //$out.= "Content-Transfer-Encoding: 7bit".$this->eol; // TODO Use base64
1861 $out .= $this->eol.$strContent.$this->eol;
1862
1863 if (!$this->atleastoneimage && $strContentAltText && getDolGlobalString('MAIN_MAIL_USE_MULTI_PART')) { // Add plain text message part after html part
1864 $out .= "--".$this->alternative_boundary."--".$this->eol;
1865 }
1866 } else {
1867 $out .= "Content-Type: text/plain; charset=".$conf->file->character_set_client.$this->eol;
1868 //$out.= "Content-Transfer-Encoding: 7bit".$this->eol;
1869 $out .= $this->eol.$strContent.$this->eol;
1870 }
1871
1872 $out .= $this->eol;
1873
1874 // Encode images
1875 if ($this->atleastoneimage) {
1876 $out .= $this->write_images($this->images_encoded);
1877 // always end related and end alternative after inline images
1878 $out .= "--".$this->related_boundary."--".$this->eol;
1879 $out .= $this->eol."--".$this->alternative_boundary."--".$this->eol;
1880 $out .= $this->eol;
1881 }
1882
1883 return $out;
1884 }
1885
1886 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1896 private function write_files($filename_list, $mimetype_list, $mimefilename_list, $cidlist)
1897 {
1898 // phpcs:enable
1899 $out = '';
1900
1901 $filename_list_size = count($filename_list);
1902 for ($i = 0; $i < $filename_list_size; $i++) {
1903 if ($filename_list[$i]) {
1904 dol_syslog("CMailFile::write_files: i=$i ".$filename_list[$i]);
1905 $encoded = $this->_encode_file($filename_list[$i]);
1906 if ($encoded !== -1) {
1907 if ($mimefilename_list[$i]) {
1908 $filename_list[$i] = $mimefilename_list[$i];
1909 }
1910 if (!$mimetype_list[$i]) {
1911 $mimetype_list[$i] = "application/octet-stream";
1912 }
1913
1914 // Skip files that have a CID (they will be added as inline images instead)
1915 // @phpstan-ignore-next-line
1916 if (!empty($cidlist) && is_array($cidlist) && isset($cidlist[$i]) && $cidlist[$i] !== null && $cidlist[$i] !== '') {
1917 continue; // Skip this file as it will be processed as inline image
1918 }
1919
1920 $out .= "--".$this->mixed_boundary.$this->eol;
1921
1922 $out .= "Content-Disposition: attachment; filename=\"".$filename_list[$i]."\"".$this->eol;
1923 $out .= "Content-Type: ".$mimetype_list[$i]."; name=\"".$filename_list[$i]."\"".$this->eol;
1924 $out .= "Content-Transfer-Encoding: base64".$this->eol;
1925 $out .= "Content-Description: ".$filename_list[$i].$this->eol;
1926 $out .= $this->eol;
1927 $out .= $encoded;
1928 $out .= $this->eol;
1929 //$out.= $this->eol;
1930 } else {
1931 return $encoded;
1932 }
1933 }
1934 }
1935
1936 return $out;
1937 }
1938
1939 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1946 public function write_images($images_list)
1947 {
1948 // phpcs:enable
1949 $out = '';
1950
1951 if (is_array($images_list)) {
1952 foreach ($images_list as $img) {
1953 dol_syslog("CMailFile::write_images: ".$img["name"]);
1954
1955 $out .= "--".$this->related_boundary.$this->eol; // always related for an inline image
1956 $out .= "Content-Type: ".$img["content_type"]."; name=\"".$img["name"]."\"".$this->eol;
1957 $out .= "Content-Transfer-Encoding: base64".$this->eol;
1958 $out .= "Content-Disposition: inline; filename=\"".$img["name"]."\"".$this->eol;
1959 $out .= "Content-ID: <".$img["cid"].">".$this->eol;
1960 $out .= $this->eol;
1961 $out .= $img["image_encoded"];
1962 $out .= $this->eol;
1963 }
1964 }
1965
1966 return $out;
1967 }
1968
1969 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1977 public function check_server_port($host, $port)
1978 {
1979 include_once DOL_DOCUMENT_ROOT.'/core/lib/geturl.lib.php';
1980
1981 // phpcs:enable
1982 $_retVal = 0;
1983 $timeout = 5; // Timeout in seconds
1984
1985 // Parse $newUrl
1986 $newUrlArray = parse_url($host);
1987 $hosttocheck = $newUrlArray['host'] ?: $newUrlArray['path'];
1988 $hosttocheck = str_replace(array('[', ']'), '', $hosttocheck); // Remove brackets of IPv6
1989
1990 // Deny some reserved host names
1991 if (in_array($hosttocheck, array('metadata.google.internal'))) {
1992 $info = array();
1993 $info['http_code'] = 400;
1994 $info['content'] = 'Error bad hostname '.$hosttocheck.' (Used by Google metadata). This value for hostname is not allowed.';
1995 return $info;
1996 }
1997
1998 // Clean host name $hosttocheck to convert it into an IP $iptocheck
1999 if (in_array($hosttocheck, array('localhost', 'localhost.domain'))) {
2000 $iptocheck = '127.0.0.1';
2001 } elseif (in_array($hosttocheck, array('ip6-localhost', 'ip6-loopback'))) {
2002 $iptocheck = '::1';
2003 } else {
2004 // Resolve $hosttocheck to get the IP $iptocheck
2005 $iptocheck = resolveDns($hosttocheck);
2006 }
2007
2008 // Check $iptocheck is an IP (v4 or v6), if not clear value.
2009 if (!filter_var($iptocheck, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4 | FILTER_FLAG_IPV6)) { // This is not an IP, we clean data
2010 $iptocheck = '0'; // will disabled check on IP
2011 }
2012
2013 if ($iptocheck && !in_array($iptocheck, array('127.0.0.1', '::1'))) {
2014 $localurl = 0;
2015 $tmpresult = isIPAllowed($iptocheck, $localurl);
2016
2017 if ($tmpresult) {
2018 $info = array();
2019 $info['http_code'] = 400;
2020 $info['content'] = $tmpresult;
2021 return $info;
2022 }
2023 }
2024
2025 if (function_exists('fsockopen')) {
2026 $keyforsmtpserver = 'MAIN_MAIL_SMTP_SERVER';
2027 $keyforsmtpport = 'MAIN_MAIL_SMTP_PORT';
2028 $keyforsmtpid = 'MAIN_MAIL_SMTPS_ID';
2029 $keyforsmtppw = 'MAIN_MAIL_SMTPS_PW';
2030 $keyforsmtpauthtype = 'MAIN_MAIL_SMTPS_AUTH_TYPE';
2031 $keyforsmtpoauthservice = 'MAIN_MAIL_SMTPS_OAUTH_SERVICE';
2032 $keyfortls = 'MAIN_MAIL_EMAIL_TLS';
2033 $keyforstarttls = 'MAIN_MAIL_EMAIL_STARTTLS';
2034 $keyforsslseflsigned = 'MAIN_MAIL_EMAIL_SMTP_ALLOW_SELF_SIGNED';
2035
2036 if (!empty($this->sendcontext)) {
2037 $smtpContextKey = strtoupper($this->sendcontext);
2038 $smtpContextSendMode = getDolGlobalString('MAIN_MAIL_SENDMODE_'.$smtpContextKey);
2039 if (!empty($smtpContextSendMode) && $smtpContextSendMode != 'default') {
2040 $keyforsmtpserver = 'MAIN_MAIL_SMTP_SERVER_'.$smtpContextKey;
2041 $keyforsmtpport = 'MAIN_MAIL_SMTP_PORT_'.$smtpContextKey;
2042 $keyforsmtpid = 'MAIN_MAIL_SMTPS_ID_'.$smtpContextKey;
2043 $keyforsmtppw = 'MAIN_MAIL_SMTPS_PW_'.$smtpContextKey;
2044 $keyforsmtpauthtype = 'MAIN_MAIL_SMTPS_AUTH_TYPE_'.$smtpContextKey;
2045 $keyforsmtpoauthservice = 'MAIN_MAIL_SMTPS_OAUTH_SERVICE_'.$smtpContextKey;
2046 $keyfortls = 'MAIN_MAIL_EMAIL_TLS_'.$smtpContextKey;
2047 $keyforstarttls = 'MAIN_MAIL_EMAIL_STARTTLS_'.$smtpContextKey;
2048 $keyforsslseflsigned = 'MAIN_MAIL_EMAIL_SMTP_ALLOW_SELF_SIGNED_'.$smtpContextKey;
2049 }
2050 }
2051
2052 // If we use SSL/TLS
2053 if (getDolGlobalString($keyfortls) && function_exists('openssl_open')) {
2054 $host = 'ssl://'.$host;
2055 }
2056 // tls smtp start with no encryption
2057 //if (getDolGlobalString('MAIN_MAIL_EMAIL_STARTTLS') && function_exists('openssl_open')) $host='tls://'.$host;
2058
2059 dol_syslog("Try socket connection to host=".$host." port=".$port." timeout=".$timeout);
2060 //See if we can connect to the SMTP server
2061 $errno = 0;
2062 $errstr = '';
2063 if ($socket = @fsockopen(
2064 $host, // Host to test, IP or domain. Add ssl:// for SSL/TLS.
2065 $port, // which Port number to use
2066 $errno, // actual system level error
2067 $errstr, // and any text that goes with the error
2068 $timeout // timeout for reading/writing data over the socket
2069 )) {
2070 // Windows still does not have support for this timeout function
2071 if (function_exists('stream_set_timeout')) {
2072 stream_set_timeout($socket, $timeout, 0);
2073 }
2074
2075 dol_syslog("Now we wait for answer 220");
2076
2077 // Check response from Server
2078 if ($_retVal = $this->server_parse($socket, "220")) {
2079 $_retVal = $socket;
2080 } else {
2081 $this->error = ($this->error ? $this->error." - " : "")."Succeed in opening socket but answer 220 not received";
2082 }
2083 } else {
2084 $this->error = utf8_check('Error '.$errno.' - '.$errstr) ? 'Error '.$errno.' - '.$errstr : mb_convert_encoding('Error '.$errno.' - '.$errstr, 'UTF-8', 'ISO-8859-1');
2085 }
2086 }
2087
2088 sleep(1);
2089
2090 return $_retVal;
2091 }
2092
2093 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
2102 public function server_parse($socket, $response)
2103 {
2104 // phpcs:enable
2105 $_retVal = true; // Indicates if Object was created or not
2106 $server_response = '';
2107
2108 while (substr($server_response, 3, 1) != ' ') {
2109 if (!($server_response = fgets($socket, 256))) {
2110 $this->error = "Couldn't get mail server response codes";
2111 return false;
2112 }
2113 }
2114
2115 if (!(substr($server_response, 0, 3) == $response)) {
2116 $this->error = "Ran into problems sending Mail.\r\nResponse: $server_response";
2117 $_retVal = false;
2118 }
2119
2120 return $_retVal;
2121 }
2122
2130 private function findHtmlImages($images_dir)
2131 {
2132 // Build the array of image extensions
2133 $extensions = array_keys($this->image_types);
2134
2135 // We search (into mail body this->html), if we find some strings like "... .imgext" or '... .imgext' to detect strings like "...file=xxx.img"
2136 // For example to detect:
2137 // <img alt="" src="/viewimage.php?modulepart=medias&amp;entity=1&amp;file=image/picture.jpg" style="height:356px; width:1040px" />
2138 $matches = array();
2139 preg_match_all('/(?:"|\')([^"\']+\.('.implode('|', $extensions).'))(?:"|\')/Ui', $this->html, $matches); // If "xxx.ext" or 'xxx.ext' found
2140
2141 if (!empty($matches) && !empty($matches[1])) {
2142 $i = 0;
2143 // We are interested in $matches[1] only (the second set of parenthesis into regex)
2144 foreach ($matches[1] as $full) {
2145 $full = urldecode($full);
2146
2147 $regs = array();
2148 if (preg_match('/file=([A-Za-z0-9_\-\/ ]+[\.]?[A-Za-z0-9]+)?$/i', $full, $regs)) { // If xxx is 'file=aaa'
2149 $img = $regs[1];
2150
2151 if (file_exists($images_dir.'/'.$img)) {
2152 // Image path in src
2153 $src = preg_quote($full, '/');
2154 // Image full path
2155 $this->html_images[$i]["fullpath"] = $images_dir.'/'.$img;
2156 // Image name
2157 $this->html_images[$i]["name"] = $img;
2158 // Content type
2159 $regext = array();
2160 if (preg_match('/^.+\.(\w{3,4})$/', $img, $regext)) {
2161 $ext = strtolower($regext[1]);
2162 $this->html_images[$i]["content_type"] = $this->image_types[$ext];
2163 }
2164 // cid
2165 $this->html_images[$i]["cid"] = dol_hash($this->html_images[$i]["fullpath"], 'md5'); // Force md5 hash (does not contain special chars)
2166 // type
2167 $this->html_images[$i]["type"] = 'cidfromurl';
2168
2169 $this->html = preg_replace("/src=\"$src\"|src='$src'/i", "src=\"cid:".$this->html_images[$i]["cid"]."\"", $this->html);
2170 }
2171 $i++;
2172 }
2173 }
2174
2175 if (!empty($this->html_images)) {
2176 $inline = array();
2177
2178 $i = 0;
2179
2180 foreach ($this->html_images as $img) {
2181 $fullpath = $images_dir.'/'.$img["name"];
2182
2183 // 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
2184 if (!in_array($fullpath, $inline)) {
2185 // Read image file
2186 if ($image = file_get_contents($fullpath)) {
2187 // On garde que le nom de l'image
2188 $regs = array();
2189 preg_match('/([A-Za-z0-9_-]+[\.]?[A-Za-z0-9]+)?$/i', $img["name"], $regs);
2190 $imgName = $regs[1];
2191 $this->images_encoded[$i]['name'] = $imgName;
2192 $this->images_encoded[$i]['fullpath'] = $fullpath;
2193 $this->images_encoded[$i]['content_type'] = $img["content_type"];
2194 $this->images_encoded[$i]['cid'] = $img["cid"];
2195 // Encodage de l'image
2196 $this->images_encoded[$i]["image_encoded"] = chunk_split(base64_encode($image), 68, $this->eol);
2197 $inline[] = $fullpath;
2198 }
2199 }
2200 $i++;
2201 }
2202 } else {
2203 return -1;
2204 }
2205
2206 return 1;
2207 } else {
2208 return 0;
2209 }
2210 }
2211
2220 private function findHtmlImagesIsSrcData($images_dir)
2221 {
2222 global $conf;
2223
2224 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
2225
2226 // Build the array of image extensions
2227 $extensions = array_keys($this->image_types);
2228
2229 if (empty($images_dir)) {
2230 //$images_dir = $conf->admin->dir_output.'/temp/'.uniqid('cmailfile');
2231 $images_dir = $conf->admin->dir_output.'/temp/cmailfile';
2232 }
2233
2234 if ($images_dir && !dol_is_dir($images_dir)) {
2235 dol_mkdir($images_dir, DOL_DATA_ROOT);
2236 }
2237
2238 // Uncomment this for debug
2239 /*
2240 global $dolibarr_main_data_root;
2241 $outputfile = $dolibarr_main_data_root."/dolibarr_mail.log";
2242 $fp = fopen($outputfile, "w+");
2243 fwrite($fp, $this->html);
2244 fclose($fp);
2245 */
2246
2247 // We search (into mail body this->html), if we find some strings like "... file=xxx.img"
2248 // For example when:
2249 // <img alt="" src="/src="data:image....;base64,...." />
2250 $matches = array();
2251 preg_match_all('/src="data:image\/('.implode('|', $extensions).');base64,([^"]+)"/Ui', $this->html, $matches); // If "xxx.ext" or 'xxx.ext' found
2252
2253 if (!empty($matches) && !empty($matches[1])) {
2254 if (empty($images_dir)) {
2255 // No temp directory provided, so we are not able to support conversion of data:image into physical images.
2256 $this->errors[] = 'NoTempDirProvidedInCMailConstructorSoCantConvertDataImgOnDisk';
2257 return -1;
2258 }
2259
2260 $i = count($this->html_images);
2261 foreach ($matches[1] as $key => $ext) {
2262 // We save the image to send in disk
2263 $filecontent = $matches[2][$key];
2264
2265 $cid = 'cid000'.dol_hash($filecontent, 'md5'); // The id must not change if image is same
2266
2267 $destfiletmp = $images_dir.'/'.$cid.'.'.$ext;
2268
2269 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)
2270 dol_syslog("write the cid file ".$destfiletmp);
2271 $fhandle = @fopen($destfiletmp, 'w');
2272 if ($fhandle) {
2273 $nbofbyteswrote = fwrite($fhandle, base64_decode($filecontent));
2274 fclose($fhandle);
2275 dolChmod($destfiletmp);
2276 } else {
2277 $this->errors[] = "Failed to open file '".$destfiletmp."' for write";
2278 return -2;
2279 }
2280 }
2281
2282 if (file_exists($destfiletmp)) {
2283 // Image full path
2284 $this->html_images[$i]["fullpath"] = $destfiletmp;
2285 // Image name
2286 $this->html_images[$i]["name"] = basename($destfiletmp);
2287 // Content type
2288 $this->html_images[$i]["content_type"] = $this->image_types[strtolower($ext)];
2289 // cid
2290 $this->html_images[$i]["cid"] = $cid;
2291 // type
2292 $this->html_images[$i]["type"] = 'cidfromdata';
2293
2294 $this->html = str_replace('src="data:image/'.$ext.';base64,'.$filecontent.'"', 'src="cid:'.$this->html_images[$i]["cid"].'"', $this->html);
2295 }
2296 $i++;
2297 }
2298
2299 // Also add cidfromdata images to images_encoded array so they are sent as inline images
2300 foreach ($this->html_images as $img) {
2301 if ($img['type'] == 'cidfromdata') {
2302 $image_content = file_get_contents($img['fullpath']);
2303 if ($image_content !== false) {
2304 $idx = count($this->images_encoded);
2305 $this->images_encoded[$idx]['name'] = $img['name'];
2306 $this->images_encoded[$idx]['fullpath'] = $img['fullpath'];
2307 $this->images_encoded[$idx]['content_type'] = $img['content_type'];
2308 $this->images_encoded[$idx]['cid'] = $img['cid'];
2309 $this->images_encoded[$idx]['type'] = 'cidfromdata';
2310 $this->images_encoded[$idx]['image_encoded'] = chunk_split(base64_encode($image_content), 68, $this->eol);
2311 }
2312 }
2313 }
2314
2315 return 1;
2316 } else {
2317 return 0;
2318 }
2319 }
2320
2336 public static function getValidAddress($address, $format, $encode = 0, $maxnumberofemail = 0)
2337 {
2338 $ret = '';
2339
2340 $arrayaddress = (!empty($address) ? explode(',', $address) : array());
2341
2342 // Loop over every component of the address
2343 $i = 0;
2344 foreach ($arrayaddress as $val) {
2345 $regs = array();
2346 if (preg_match('/^(.*)<(.*)>$/i', trim($val), $regs)) {
2347 $name = trim($regs[1]);
2348 $email = trim($regs[2]);
2349 } else {
2350 $name = '';
2351 $email = trim($val);
2352 }
2353
2354 if ($email) {
2355 $i++;
2356
2357 $newemail = '';
2358 if ($format == 5) {
2359 $newemail = $name ? $name : $email;
2360 $newemail = '<a href="mailto:'.$email.'">'.$newemail.'</a>';
2361 }
2362 if ($format == 4) {
2363 $newemail = $name ? $name : $email;
2364 }
2365 if ($format == 2) {
2366 $newemail = $email;
2367 }
2368 if ($format == 1 || $format == 3) {
2369 $newemail = '<'.$email.'>';
2370 }
2371 if ($format == 0 || $format == 3) {
2372 if (getDolGlobalString('MAIN_MAIL_NO_FULL_EMAIL')) {
2373 $newemail = '<'.$email.'>';
2374 } elseif (!$name) {
2375 $newemail = '<'.$email.'>';
2376 } else {
2377 $newemail = ($format == 3 ? '"' : '').($encode ? self::encodetorfc2822($name) : $name).($format == 3 ? '"' : '').' <'.$email.'>';
2378 //$newemail = (($format == 3 && !$encode) ? '"' : '').($encode ? self::encodetorfc2822($name) : $name).(($format == 3 && !$encode) ? '"' : '').' <'.$email.'>';
2379 }
2380 }
2381
2382 $ret = ($ret ? $ret.',' : '').$newemail;
2383
2384 // Stop if we have too much records
2385 if ($maxnumberofemail && $i >= $maxnumberofemail) {
2386 if (count($arrayaddress) > $maxnumberofemail) {
2387 $ret .= '...';
2388 }
2389 break;
2390 }
2391 }
2392 }
2393
2394 return $ret;
2395 }
2396
2404 public static function getArrayAddress($address)
2405 {
2406 $ret = array();
2407
2408 $arrayaddress = explode(',', $address);
2409
2410 // Loop over every component of the address
2411 foreach ($arrayaddress as $val) {
2412 $regs = array();
2413 if (preg_match('/^(.*)<(.*)>$/i', trim($val), $regs)) {
2414 $name = trim($regs[1]);
2415 $email = trim($regs[2]);
2416 } else {
2417 $name = null;
2418 $email = trim($val);
2419 }
2420
2421 $ret[$email] = getDolGlobalString('MAIN_MAIL_NO_FULL_EMAIL') ? null : $name;
2422 }
2423
2424 return $ret;
2425 }
2426}
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.