dolibarr 20.0.0
CMailFile Class Reference

Class to send emails (with attachments or not) Usage: $mailfile = new CMailFile($subject,$sendto,$replyto,$message,$filepath,$mimetype,$filename,$cc,$ccc,$deliveryreceipt,$msgishtml,$errors_to,$css,$trackid,$moreinheader,$sendcontext,$replyto); $mailfile->sendfile();. More...

Public Member Functions

 __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.
 
 sendfile ()
 Send mail that was prepared by constructor.
 
 dump_mail ()
 Write content of a SMTP request into a dump file (mode = all) Used for debugging.
 
 save_dump_mail_in_err ($message='')
 Save content if mail is in error Used for debugging.
 
 checkIfHTML ($msg)
 Correct an incomplete html string.
 
 buildCSS ()
 Build a css style (mode = all) into this->styleCSS and this->bodyCSS.
 
 write_smtpheaders ()
 Create SMTP headers (mode = 'mail')
 
 write_mimeheaders ($filename_list, $mimefilename_list)
 Create header MIME (mode = 'mail')
 
 write_body ($msgtext)
 Return email content (mode = 'mail')
 
 write_images ($images_list)
 Attach an image to email (mode = 'mail')
 
 check_server_port ($host, $port)
 Try to create a socket connection.
 
 server_parse ($socket, $response)
 This function has been modified as provided by SirSir to allow multiline responses when using SMTP Extensions.
 

Static Public Member Functions

static encodetorfc2822 ($stringtoencode)
 Encode subject according to RFC 2822 - http://en.wikipedia.org/wiki/MIME#Encoded-Word.
 
static getValidAddress ($address, $format, $encode=0, $maxnumberofemail=0)
 Return a formatted address string for SMTP protocol.
 
static getArrayAddress ($address)
 Return a formatted array of address string for SMTP protocol.
 

Public Attributes

 $styleCSS
 Defined css style for body background.
 
 $bodyCSS
 Defined background directly in body tag.
 

Private Member Functions

 _encode_file ($sourcefile)
 Read a file on disk and return encoded content for emails (mode = 'mail')
 
 write_files ($filename_list, $mimetype_list, $mimefilename_list, $cidlist)
 Attach file to email (mode = 'mail')
 
 findHtmlImages ($images_dir)
 Search images into html message and init array this->images_encoded if found.
 
 findHtmlImagesIsSrcData ($images_dir)
 Seearch images with data:image format into html message.
 

Detailed Description

Class to send emails (with attachments or not) Usage: $mailfile = new CMailFile($subject,$sendto,$replyto,$message,$filepath,$mimetype,$filename,$cc,$ccc,$deliveryreceipt,$msgishtml,$errors_to,$css,$trackid,$moreinheader,$sendcontext,$replyto); $mailfile->sendfile();.

Definition at line 43 of file CMailFile.class.php.

Constructor & Destructor Documentation

◆ __construct()

CMailFile::__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.

Parameters
string$subjectTopic/Subject of mail
string$toRecipients emails (RFC 2822: "Name firstname <email>[, ...]" or "email[, ...]" or "<email>[, ...]"). Note: the keyword 'SUPERVISOREMAIL' is not allowed here and must be replaced by caller.
string$fromSender email (RFC 2822: "Name firstname <email>[, ...]" or "email[, ...]" or "<email>[, ...]")
string$msgMessage
array$filename_listList of files to attach (full path of filename on file system)
array$mimetype_listList of MIME type of attached files
array$mimefilename_listList of attached file name in message
string$addr_ccEmail cc (Example: 'abc@d.nosp@m.ef.c.nosp@m.om, ghk@l.nosp@m.mn.c.nosp@m.om')
string$addr_bccEmail bcc (Note: This is autocompleted with MAIN_MAIL_AUTOCOPY_TO if defined)
int$deliveryreceiptAsk a delivery receipt
int$msgishtml1=String IS already html, 0=String IS NOT html, -1=Unknown make autodetection (with fast mode, not reliable)
string$errors_toEmail for errors-to
string$cssCss option
string$trackidTracking string (contains type and id of related element)
string$moreinheaderMore in header. $moreinheader must contains the "\r\n" at end of each line
string$sendcontext'standard', 'emailing', 'ticket', 'password', ... (used to define which sending mode and parameters to use)
string$replytoReply-to email (will be set to the same value than From by default if not provided)
string$upload_dir_tmpTemporary directory (used to convert images embedded as img src=data:image)
string$in_reply_toMessage-ID of the message we reply to
string$referencesString with list of Message-ID of the thread ('<123> <456> ...')

Definition at line 192 of file CMailFile.class.php.

References ascii_check(), buildCSS(), checkIfHTML(), dol_nl2br(), dol_sanitizeEmail(), dol_string_unaccent(), dol_syslog(), dol_textishtml(), encodetorfc2822(), findHtmlImages(), findHtmlImagesIsSrcData(), getArrayAddress(), getDolGlobalString(), getValidAddress(), write_body(), write_files(), write_mimeheaders(), and write_smtpheaders().

Member Function Documentation

◆ _encode_file()

CMailFile::_encode_file ( $sourcefile)
private

Read a file on disk and return encoded content for emails (mode = 'mail')

Parameters
string$sourcefilePath to file to encode
Returns
int|string Return integer <0 if KO, encoded string if OK

Definition at line 1400 of file CMailFile.class.php.

References dol_osencode(), and dol_syslog().

Referenced by write_files().

◆ buildCSS()

CMailFile::buildCSS ( )

Build a css style (mode = all) into this->styleCSS and this->bodyCSS.

Returns
void

Definition at line 1534 of file CMailFile.class.php.

Referenced by __construct().

◆ check_server_port()

CMailFile::check_server_port ( $host,
$port )

Try to create a socket connection.

Parameters
string$hostAdd ssl:// for SSL/TLS.
int$portExample: 25, 465
Returns
int Socket id if ok, 0 if KO

Definition at line 1847 of file CMailFile.class.php.

References dol_syslog(), getDolGlobalString(), server_parse(), and utf8_check().

◆ checkIfHTML()

CMailFile::checkIfHTML ( $msg)

Correct an incomplete html string.

Parameters
string$msgString
Returns
string Completed string

Definition at line 1508 of file CMailFile.class.php.

References $bodyCSS, and $styleCSS.

Referenced by __construct(), and write_body().

◆ dump_mail()

CMailFile::dump_mail ( )

Write content of a SMTP request into a dump file (mode = all) Used for debugging.

Note that to see full SMTP protocol, you can use tcpdump -w /tmp/smtp -s 2000 port 25"

Returns
void

Definition at line 1425 of file CMailFile.class.php.

References dol_move(), dol_now(), dol_print_date(), dolChmod(), and getDolGlobalString().

Referenced by sendfile().

◆ encodetorfc2822()

static CMailFile::encodetorfc2822 ( $stringtoencode)
static

Encode subject according to RFC 2822 - http://en.wikipedia.org/wiki/MIME#Encoded-Word.

Parameters
string$stringtoencodeString to encode
Returns
string string encoded

Definition at line 1387 of file CMailFile.class.php.

Referenced by __construct(), and sendfile().

◆ findHtmlImages()

CMailFile::findHtmlImages ( $images_dir)
private

Search images into html message and init array this->images_encoded if found.

Parameters
string$images_dirPath to store physical images files. For example $dolibarr_main_data_root.'/medias'
Returns
int >0 if OK, <0 if KO

Definition at line 1954 of file CMailFile.class.php.

References dol_hash().

Referenced by __construct().

◆ findHtmlImagesIsSrcData()

CMailFile::findHtmlImagesIsSrcData ( $images_dir)
private

Seearch images with data:image format into html message.

If we find some, we create it on disk.

Parameters
string$images_dirLocation of where to store physically images files. For example $dolibarr_main_data_root.'/medias'
Returns
int >0 if OK, <0 if KO

Definition at line 2042 of file CMailFile.class.php.

References dol_is_dir(), dol_is_file(), dol_mkdir(), dol_syslog(), and dolChmod().

Referenced by __construct().

◆ getArrayAddress()

static CMailFile::getArrayAddress ( $address)
static

Return a formatted array of address string for SMTP protocol.

Parameters
string$addressExample: 'John Doe john@.nosp@m.doe..nosp@m.com, Alan Smith alan@.nosp@m.smit.nosp@m.h.com' or 'john@.nosp@m.doe..nosp@m.com, alan@.nosp@m.smit.nosp@m.h.com'
Returns
array array(email => name)
See also
getValidAddress()

Definition at line 2211 of file CMailFile.class.php.

References getDolGlobalString().

Referenced by __construct().

◆ getValidAddress()

static CMailFile::getValidAddress ( $address,
$format,
$encode = 0,
$maxnumberofemail = 0 )
static

Return a formatted address string for SMTP protocol.

Parameters
string$addressExample: 'John Doe john@.nosp@m.doe..nosp@m.com, Alan Smith alan@.nosp@m.smit.nosp@m.h.com' or 'john@.nosp@m.doe..nosp@m.com, alan@.nosp@m.smit.nosp@m.h.com'
int$format0=auto, 1=emails with <>, 2=emails without <>, 3=auto + label between ", 4 label or email, 5 mailto link @param int $encode 0=No encode name, 1=Encode name to RFC2822 @param int $maxnumberofemail 0=No limit. Otherwise, maximum number of emails returned ($address may contains several email separated with ','). Add '...' if there is more. @return string If format 0: '<john@doe.com>' or 'John Doe <john@doe.com>' or '=?UTF-8?B?Sm9obiBEb2U=?= <john@doe.com>' If format 1: '<john@doe.com>' If format 2: 'john@doe.com' If format 3: '<john@doe.com>' or '"John Doe" <john@doe.com>' or '"=?UTF-8?B?Sm9obiBEb2U=?=" <john@doe.com>' If format 4: 'John Doe' or 'john@doe.com' if no label exists If format 5: <a href="john@.nosp@m.doe..nosp@m.com">John Doe</a> or <a href="john@.nosp@m.doe..nosp@m.com">john@.nosp@m.doe..nosp@m.com if no label exists
See also
getArrayAddress()

Definition at line 2142 of file CMailFile.class.php.

References getDolGlobalString().

Referenced by __construct(), sendfile(), Adherent\sendReminderForExpiredSubscription(), and showDirectPublicLink().

◆ save_dump_mail_in_err()

CMailFile::save_dump_mail_in_err ( $message = '')

Save content if mail is in error Used for debugging.

Parameters
string$messageAdd also a message
Returns
void

Definition at line 1466 of file CMailFile.class.php.

References dol_move(), dol_now(), dol_print_date(), dolChmod(), and getDolGlobalString().

Referenced by sendfile().

◆ sendfile()

CMailFile::sendfile ( )

Send mail that was prepared by constructor.

Returns
bool True if mail sent, false otherwise. Negative int if error in hook. String if incorrect send mode.

@phan-suppress PhanTypeMismatchReturnNullable False positif by phan for unclear reason.

Definition at line 787 of file CMailFile.class.php.

References ascii_check(), dol_syslog(), dump_mail(), encodetorfc2822(), getDolGlobalInt(), getDolGlobalString(), getSupportedOauth2Array(), getValidAddress(), and save_dump_mail_in_err().

◆ server_parse()

CMailFile::server_parse ( $socket,
$response )

This function has been modified as provided by SirSir to allow multiline responses when using SMTP Extensions.

Parameters
resource$socketSocket
string$responseResponse string
Returns
boolean true if success

Definition at line 1927 of file CMailFile.class.php.

Referenced by check_server_port().

◆ write_body()

CMailFile::write_body ( $msgtext)

Return email content (mode = 'mail')

Parameters
string$msgtextMessage string
Returns
string String content

Definition at line 1671 of file CMailFile.class.php.

References checkIfHTML(), getDolGlobalString(), and write_images().

Referenced by __construct().

◆ write_files()

CMailFile::write_files ( $filename_list,
$mimetype_list,
$mimefilename_list,
$cidlist )
private

Attach file to email (mode = 'mail')

Parameters
array$filename_listTableau
array$mimetype_listTableau
array$mimefilename_listTableau
array$cidlistArray of CID if file must be completed with CID code
Returns
string|int String with files encoded

Definition at line 1767 of file CMailFile.class.php.

References _encode_file(), and dol_syslog().

Referenced by __construct().

◆ write_images()

CMailFile::write_images ( $images_list)

Attach an image to email (mode = 'mail')

Parameters
array$images_listArray of array image
Returns
string Chaine images encodees

Definition at line 1815 of file CMailFile.class.php.

References dol_syslog().

Referenced by write_body().

◆ write_mimeheaders()

CMailFile::write_mimeheaders ( $filename_list,
$mimefilename_list )

Create header MIME (mode = 'mail')

Parameters
array$filename_listArray of filenames
array$mimefilename_listArray of mime types
Returns
string mime headers

Definition at line 1642 of file CMailFile.class.php.

References dol_syslog().

Referenced by __construct().

◆ write_smtpheaders()

CMailFile::write_smtpheaders ( )

Create SMTP headers (mode = 'mail')

Returns
string headers

Definition at line 1561 of file CMailFile.class.php.

References dol_syslog(), and getDolGlobalString().

Referenced by __construct().


The documentation for this class was generated from the following file: