|
dolibarr 25.0.0-alpha
|
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') | |
| checkSmtpTargetAllowed ($host, $port) | |
| Check that the SMTP target (host and port) is allowed. | |
| 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. | |
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 This is called in the CMailFile constructor but only if MAIN_MAIL_ADD_INLINE_IMAGES_IF_IN_MEDIAS is set (Off by default) | |
| findHtmlImagesIsSrcData ($images_dir) | |
| Search images with src="data:image..." format into html message. | |
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.
| 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 = '' ) |
| string | $subject | Topic/Subject of mail |
| string | $to | Recipients 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 | $from | Sender email (RFC 2822: "Name firstname <email>[, ...]" or "email[, ...]" or "<email>[, ...]") |
| string | $msg | Message |
| ?string[] | $filename_list | List of files to attach (full path of filename on file system) |
| ?string[] | $mimetype_list | List of MIME type of attached files |
| ?string[] | $mimefilename_list | List of attached file name in message |
| string | $addr_cc | Email cc (Example: 'abc@d.nosp@m.ef.c.nosp@m.om, ghk@l.nosp@m.mn.c.nosp@m.om') |
| string | $addr_bcc | Email bcc (Note: This is autocompleted with MAIN_MAIL_AUTOCOPY_TO if defined) |
| int<0,1> | $deliveryreceipt Ask a delivery receipt | |
| int<-1,1> | $msgishtml 1=String IS already html, 0=String IS NOT html, -1=Unknown make autodetection (with fast mode, not reliable) | |
| string | $errors_to | Email for errors-to |
| string|array<string,string> | $css Css option (should be array, legacy: empty string if none) | |
| string | $trackid | Tracking string (contains type and id of related element) |
| string | $moreinheader | More 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 | $replyto | Reply-to email (will be set to the same value than From by default if not provided) |
| string | $upload_dir_tmp | Temporary directory (used to convert images embedded as img src=data:image) |
| string | $in_reply_to | Message-ID of the message we reply to |
| string | $references | String with list of Message-ID of the thread ('<123> <456> ...') |
Definition at line 229 of file CMailFile.class.php.
References $conf, $dolibarr_main_url_root, 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().
|
private |
Read a file on disk and return encoded content for emails (mode = 'mail')
| string | $sourcefile | Path to file to encode |
Definition at line 1547 of file CMailFile.class.php.
References dol_osencode(), and dol_syslog().
Referenced by write_files().
| CMailFile::buildCSS | ( | ) |
Build a css style (mode = all) into this->styleCSS and this->bodyCSS.
Definition at line 1685 of file CMailFile.class.php.
Referenced by __construct().
| CMailFile::check_server_port | ( | $host, | |
| $port ) |
Try to create a socket connection.
| string | $host | Add ssl:// for SSL/TLS. |
| int | $port | Example: 25, 465 |
Definition at line 2068 of file CMailFile.class.php.
References checkSmtpTargetAllowed(), dol_syslog(), getDolGlobalString(), server_parse(), and utf8_check().
| CMailFile::checkIfHTML | ( | $msg | ) |
Correct an incomplete html string.
| string | $msg | String |
Definition at line 1659 of file CMailFile.class.php.
Referenced by __construct(), and write_body().
| CMailFile::checkSmtpTargetAllowed | ( | $host, | |
| $port ) |
Check that the SMTP target (host and port) is allowed.
Only standard SMTP ports are allowed and private or reserved IPs are refused, unless the variable $dolibarr_mail_allow_unrestricted_smtp_target is defined into the conf.php file (for example to use an internal SMTP relay). This is used to prevent the email setup to be used to scan the internal network.
| string | $host | Host name or IP. Can contain a protocol prefix like ssl:// and a port is not expected here. |
| int | string | $port | Port number, example: 25, 465 |
Definition at line 2004 of file CMailFile.class.php.
References isIPAllowed(), and resolveDns().
Referenced by check_server_port(), and sendfile().
| 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"
Definition at line 1571 of file CMailFile.class.php.
References archiveOrBackupFile(), dolChmod(), and getDolGlobalInt().
Referenced by sendfile().
|
static |
Encode subject according to RFC 2822 - http://en.wikipedia.org/wiki/MIME#Encoded-Word.
| string | $stringtoencode | String to encode |
Definition at line 1534 of file CMailFile.class.php.
References $conf.
Referenced by __construct(), and sendfile().
|
private |
Search images into html message and init array this->images_encoded if found This is called in the CMailFile constructor but only if MAIN_MAIL_ADD_INLINE_IMAGES_IF_IN_MEDIAS is set (Off by default)
| string | $images_dir | Path to store physical images files. For example $dolibarr_main_data_root.'/medias' |
Definition at line 2187 of file CMailFile.class.php.
References dol_hash().
Referenced by __construct().
|
private |
Search images with src="data:image..." format into html message.
If we find some, we create them on disk. This is called in the CMailFile constructor.
| string | $images_dir | Location of where to store physically images files. For example $dolibarr_main_data_root.'/medias' |
Definition at line 2277 of file CMailFile.class.php.
References $conf, dol_is_dir(), dol_is_file(), dol_mkdir(), dol_syslog(), and dolChmod().
Referenced by __construct().
|
static |
Return a formatted array of address string for SMTP protocol.
| string | $address | Example: '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' |
Definition at line 2462 of file CMailFile.class.php.
References getDolGlobalString().
Referenced by __construct().
|
static |
Return a formatted address string for SMTP protocol.
| string | $address | Example: '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 | $format | Set to 0 = auto, 1 = emails with <>, 2 = emails without <>, 3 = auto + label between "", 4 label or email, 5 mailto link |
| int | $encode | Set to 0 = No encode name, 1 = Encode name to RFC2822 |
| int | $maxnumberofemail | Set to 0 = No limit. Otherwise, maximum number of emails returned ($address may contains several email separated with ','). Add '...' if there is more. |
Definition at line 2393 of file CMailFile.class.php.
References getDolGlobalString().
Referenced by __construct(), sendfile(), Contrat\sendReminderForExpiredServices(), Adherent\sendReminderForExpiredSubscription(), and showDirectPublicLink().
| CMailFile::save_dump_mail_in_err | ( | $message = '' | ) |
Save content if mail is in error Used for debugging.
| string | $message | Add also a message |
Definition at line 1618 of file CMailFile.class.php.
References dol_move(), dol_now(), dol_print_date(), dolChmod(), and getDolGlobalString().
Referenced by sendfile().
| CMailFile::sendfile | ( | ) |
Send mail that was prepared by constructor.
@phan-suppress PhanTypeMismatchReturnNullable False positif by phan for unclear reason.
Definition at line 858 of file CMailFile.class.php.
References $conf, ascii_check(), checkSmtpTargetAllowed(), dol_syslog(), dump_mail(), encodetorfc2822(), getDolGlobalInt(), getDolGlobalString(), getSupportedOauth2Array(), getValidAddress(), and save_dump_mail_in_err().
| CMailFile::server_parse | ( | $socket, | |
| $response ) |
This function has been modified as provided by SirSir to allow multiline responses when using SMTP Extensions.
| resource | $socket | Socket |
| string | $response | Response string |
Definition at line 2159 of file CMailFile.class.php.
Referenced by check_server_port().
| CMailFile::write_body | ( | $msgtext | ) |
Return email content (mode = 'mail')
| string | $msgtext | Message string |
Definition at line 1824 of file CMailFile.class.php.
References $conf, checkIfHTML(), getDolGlobalString(), and write_images().
Referenced by __construct().
|
private |
Attach file to email (mode = 'mail')
| string[] | $filename_list | Tableau |
| string[] | $mimetype_list | Tableau |
| string[] | $mimefilename_list | Tableau |
| ?string[] | $cidlist | Array of CID if file must be completed with CID code |
Definition at line 1920 of file CMailFile.class.php.
References _encode_file(), and dol_syslog().
Referenced by __construct().
| CMailFile::write_images | ( | $images_list | ) |
Attach an image to email (mode = 'mail')
| array<array{name:string,fullpath:string,content_type:string,cid:string,image_encoded:string}> | $images_list Array of array image |
Definition at line 1970 of file CMailFile.class.php.
References dol_syslog().
Referenced by write_body().
| CMailFile::write_mimeheaders | ( | $filename_list, | |
| $mimefilename_list ) |
Create header MIME (mode = 'mail')
| ?string[] | $filename_list | Array of filenames |
| ?string[] | $mimefilename_list | Array of mime types |
Definition at line 1796 of file CMailFile.class.php.
References dol_syslog().
Referenced by __construct().
| CMailFile::write_smtpheaders | ( | ) |
Create SMTP headers (mode = 'mail')
Definition at line 1711 of file CMailFile.class.php.
References dol_syslog(), and getDolGlobalString().
Referenced by __construct().