Changes

Jump to navigation Jump to search
Reformatted 'Email and SMS' section for easier reading, other sections to follow
Line 162: Line 162:     
== '''Email and SMS''' ==
 
== '''Email and SMS''' ==
* MAIN_MAILFORM_DISABLE_ENTERKEY (>= 8.0.1) =>  Activate javascript code to disable the enter key in the MAIL form.
+
* '''MAIN_MAILFORM_DISABLE_ENTERKEY''' ► Activate javascript code to disable the enter key in the MAIL form. ► (>= 8.0.1)
   −
* MAIL_PREFIX_FOR_EMAIL_ID (>= 8.0.1) =>  Prefix for the mails ID. Default value is $_SERVER["SERVER_NAME"]
+
* '''MAIL_PREFIX_FOR_EMAIL_ID''' ► Prefix for the mails ID. Default value is <code>$_SERVER["SERVER_NAME"]</code> ► (>= 8.0.1)
   −
* MAIN_MAIL_DEBUG => Write content with header of last mail into file dolibarr_mail.log into directory dolibarr_main_data_root.
+
* '''MAIN_MAIL_DEBUG''' ► Write content with header of last mail into file <code>dolibarr_mail.log</code> into directory <code>dolibarr_main_data_root</code>.
   −
* MAIN_SMS_DEBUG => Write content of SMS sent into file dolibarr_sms.log into directory dolibarr_main_data_root.
+
* '''MAIN_SMS_DEBUG''' ► Write content of SMS sent into file <code>dolibarr_sms.log</code> into directory <code>dolibarr_main_data_root</code>.
   −
* MAIN_MAIL_ALLOW_SENDMAIL_F => On Linux or BSD system, PHP email function use the command sendmail local to server. In some cases, the sender email must be provided on command line of sendmail with option -f. This option is here to ask Dolibarr to call the function '''mail''' of PHP by adding value for the option -f. Note that in most cases, even with sendmail, sender email is correctly managed as it is added in the email technical header. This option is here only for rare setup of sendmail that ask the '''-f''' option to be mandatory or for sendmail setup that does not use by default the Return-path of header email to define the sender (with this option, the return-path will be provided also on command line and not lost by sendmail).
+
* '''MAIN_MAIL_ALLOW_SENDMAIL_F''' ► On Linux or BSD system, PHP email function use the command sendmail local to server. In some cases, the sender email must be provided on command line of sendmail with option <code>-f</code>. This option is here to ask Dolibarr to call the function '''mail''' of PHP by adding value for the option <code>-f</code>. Note that in most cases, even with sendmail, sender email is correctly managed as it is added in the email technical header. This option is here only for rare setup of sendmail that ask the '''-f''' option to be mandatory or for sendmail setup that does not use by default the Return-path of header email to define the sender (with this option, the return-path will be provided also on command line and not lost by sendmail).
   −
* MAIN_MAIL_SENDMAIL_FORCE_BA => On Linux or BSD system, PHP email function use the command sendmail local to server. In some case, we want to recipient to be provided to sendmail into the email content instead of its command line parameter. For this we must add the '''-ba''' parameter to sendmail. This option ask PHP to provide this parameter when sending a mail. Note that another solution is to edit the '''mail.force_extra_parameters=-ba''' into '''php.ini''' file.
+
* '''MAIN_MAIL_SENDMAIL_FORCE_BA''' ► On Linux or BSD system, PHP email function use the command sendmail local to server. In some case, we want to recipient to be provided to sendmail into the email content instead of its command line parameter. For this we must add the '''-ba''' parameter to sendmail. This option ask PHP to provide this parameter when sending a mail. Note that another solution is to edit the '''mail.force_extra_parameters=-ba''' into '''<code>php.ini</code>''' file.
   −
* MAIN_MAIL_NO_FULL_EMAIL => Recipient email and sender are cleaned to be on form "<email>" instead of "Name <email>". This might solve problem of compatibility with very old mailers.
+
* '''MAIN_MAIL_NO_FULL_EMAIL''' ► Recipient email and sender are cleaned to be on form "<email>" instead of "Name <email>". This might solve problem of compatibility with very old mailers.
   −
* MAIN_FIX_FOR_BUGGED_MTA => Some MTA agent are bugged and add some CR chars each time they saw a LF. Because Dolibarr emails are forged to be already cleaned, if MTA agent do that, you will send an email with two CR chars. This may result in having recipient not able to read your email. To fix this, add this constant to 1. Dolibarr will then create an email that is not RFC compliant but because the MTA agent is bugged, the email will be modified and become correct during sending, solving the problem of bad email received. Add this constant if your recipient experience problems when opening email for example users using webmail of orange.fr or hotmail.com
+
* '''MAIN_FIX_FOR_BUGGED_MTA''' ► Some MTA agent are bugged and add some CR chars each time they saw a LF. Because Dolibarr emails are forged to be already cleaned, if MTA agent do that, you will send an email with two CR chars. This may result in having recipient not able to read your email. To fix this, add this constant to 1. Dolibarr will then create an email that is not RFC compliant but because the MTA agent is bugged, the email will be modified and become correct during sending, solving the problem of bad email received. Add this constant if your recipient experience problems when opening email for example users using webmail of <code>orange.fr</code> or <code>hotmail.com</code>
   −
* MAIN_MAIL_DO_NOT_USE_SIGN => Do not add user signature at end of suggested pre-defined email
+
* '''MAIN_MAIL_DO_NOT_USE_SIGN''' ► Do not add user signature at end of suggested pre-defined email
   −
* MAIL_FORCE_DELIVERY_RECEIPT_INVOICE => Set default as "Yes" on requesting delivery receipt when sending email through the ''Customer Invoice'' module.
+
* '''MAIL_FORCE_DELIVERY_RECEIPT_INVOICE''' ► Set default as "Yes" on requesting delivery receipt when sending email through the ''Customer Invoice'' module.
   −
* MAIL_FORCE_DELIVERY_RECEIPT_ORDER => Set default as "Yes" on requesting delivery receipt when sending email through the ''Customer Order'' module.  
+
* '''MAIL_FORCE_DELIVERY_RECEIPT_ORDER''' ► Set default as "Yes" on requesting delivery receipt when sending email through the ''Customer Order'' module.  
   −
* MAIL_FORCE_DELIVERY_RECEIPT_PROPAL => Set default as "Yes" on requesting delivery receipt when sending email through the ''Customer Proposal'' module.
+
* '''MAIL_FORCE_DELIVERY_RECEIPT_PROPAL''' ► Set default as "Yes" on requesting delivery receipt when sending email through the ''Customer Proposal'' module.
   −
* MAIN_EMAIL_USECCC => 1 = Show field BCC into email forms, If email = Show BCC prefilled with email.
+
* '''MAIN_EMAIL_USECCC''' ► 1 = Show field BCC into email forms, If email = Show BCC prefilled with email.
   −
* MAIN_MAIL_AUTOCOPY_PROPOSAL_TO, MAIN_MAIL_AUTOCOPY_ORDER_TO, MAIN_MAIL_AUTOCOPY_INVOICE_TO => Email to use as a BCC recipients when sending email for proposal, order or invoice. You can make this value visible by setting MAIN_EMAIL_USECCC (to 1 or to another email, see previous point)
+
* '''MAIN_MAIL_AUTOCOPY_PROPOSAL_TO''', '''MAIN_MAIL_AUTOCOPY_ORDER_TO''', '''MAIN_MAIL_AUTOCOPY_INVOICE_TO''' ► Email to use as a BCC recipients when sending email for proposal, order or invoice. You can make this value visible by setting MAIN_EMAIL_USECCC (to 1 or to another email, see previous point)
   −
* MAIN_EMAIL_ADD_TRACK_ID => When value is 1 (this is also default value if option is not set): The record "Message-id" added into smtp header includes a tracking id to define where the email was sent from. When value is 2: you send an email from third party card, the sender email is completed with the email source tracking string  "+thiXXX" on email (your email will be sent with the "From" that is myname+thi123@mycompany.com). So when user receiving email will make "Answer", email will be sent to myname@mycompany.com but with the tracking id included (into header or into target email), allowing you to know to which third party or object, the email exchange is related to.
+
* '''MAIN_EMAIL_ADD_TRACK_ID''' ► When value is '''1''' (this is also default value if option is not set): The record "Message-id" added into smtp header includes a tracking id to define where the email was sent from. When value is '''2''': you send an email from third party card, the sender email is completed with the email source tracking string  "+thiXXX" on email (your email will be sent with the "From" that is myname+thi123@mycompany.com). So when user receiving email will make "Answer", email will be sent to myname@mycompany.com but with the tracking id included (into header or into target email), allowing you to know to which third party or object, the email exchange is related to.
   −
* MAIL_MAX_NB_OF_RECIPIENTS_IN_SAME_EMAIL => Restrict sending of 1 email message to x recipients for same email message (x for To: + CC: + BCC:). If not defined, value is 10. Required to fight against spamming that include 1000 recipients in 1 message. Note that MAIL_MAX_NB_OF_RECIPIENTS_TO_IN_SAME_EMAIL, MAIL_MAX_NB_OF_RECIPIENTS_CC_IN_SAME_EMAIL and MAIL_MAX_NB_OF_RECIPIENTS_BCC_IN_SAME_EMAIL are also available.
+
* '''MAIL_MAX_NB_OF_RECIPIENTS_IN_SAME_EMAIL''' ► Restrict sending of 1 email message to <code>x</code> recipients for same email message (x for To: + CC: + BCC:). If not defined, value is <code>10</code>. Required to fight against spamming that include 1000 recipients in 1 message. Note that '''MAIL_MAX_NB_OF_RECIPIENTS_TO_IN_SAME_EMAIL''', '''MAIL_MAX_NB_OF_RECIPIENTS_CC_IN_SAME_EMAIL''' and '''MAIL_MAX_NB_OF_RECIPIENTS_BCC_IN_SAME_EMAIL''' are also available.
   −
* MAIN_MAIL_FORCE_CONTENT_TYPE_TO_HTML => Force to send all email (event with text only content) as HTML formatted email.
+
* '''MAIN_MAIL_FORCE_CONTENT_TYPE_TO_HTML''' ► Force to send all email (event with text only content) as HTML formatted email.
   −
* MAIN_MAIL_USE_MULTI_PART => Forge email content using an alternate text part (for 5.0.2+). By default with 6.0+
+
* '''MAIN_MAIL_USE_MULTI_PART''' ► Forge email content using an alternate text part (for 5.0.2+). By default with 6.0+
   −
* MAIN_MAIL_ADD_INLINE_IMAGES_IF_IN_MEDIAS => If images were stored into the medias directory from CKEditor, then images into emails are replaced with "inline content". This may increase seriously risk of being detected as SPAM.
+
* '''MAIN_MAIL_ADD_INLINE_IMAGES_IF_IN_MEDIAS''' ► If images were stored into the medias directory from CKEditor, then images into emails are replaced with "inline content". This may increase seriously risk of being detected as SPAM.
   −
* MAIN_COPY_FILE_IN_EVENT_AUTO => Add attachement document on event auto generated by sending email from dolibarr. (v6.0+)
+
* '''MAIN_COPY_FILE_IN_EVENT_AUTO''' ► Add attachement document on event auto generated by sending email from dolibarr. (v6.0+)
   −
* MAIN_EXTERNAL_SMTP_CLIENT_IP_ADDRESS => Enter the public ip address of the server, so it will appears into the help on the email setup page.
+
* '''MAIN_EXTERNAL_SMTP_CLIENT_IP_ADDRESS''' ► Enter the public IP address of the server, so it will appears into the help on the email setup page.
 
  −
* MAIN_MAIL_ENABLED_USER_DEST_SELECT => Show also internal users into list of recipients of email in email sending form (v8.0+)
      +
* '''MAIN_MAIL_ENABLED_USER_DEST_SELECT''' ► Show also internal users into list of recipients of email in email sending form ► (v8.0+)
    
== '''Emailing Module''' ==
 
== '''Emailing Module''' ==
75

edits

Navigation menu