User Tools

  • Logged in as: anonymous (anonymous)
  • Log Out

Site Tools


mantisbt:plugins:emailreporting

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
mantisbt:plugins:emailreporting [2018/03/25 01:06] SL-Gundammantisbt:plugins:emailreporting [2022/10/23 09:12] (current) – [mail_add_complete_email] SL-Gundam
Line 41: Line 41:
  
 ==== PEAR ==== ==== PEAR ====
-   * [[https://pear.php.net | core pear files (pear.php and pear5.php)]]+   * [[https://pear.php.net | core pear files]]
    * [[https://pear.php.net/package/Auth_SASL | Auth_SASL]]    * [[https://pear.php.net/package/Auth_SASL | Auth_SASL]]
    * [[https://pear.php.net/package/Mail_mimeDecode | Mail_mimeDecode]]    * [[https://pear.php.net/package/Mail_mimeDecode | Mail_mimeDecode]]
Line 102: Line 102:
 It's possible to run into database query errors if you've incorrectly setup some maximum size settings in PHP, and MantisBT It's possible to run into database query errors if you've incorrectly setup some maximum size settings in PHP, and MantisBT
  
-EmailReporting and MantisBT uses the following to decide what the maximum attachment size is that should be supported (MySQL variable is not used for this decision)+EmailReporting and MantisBT use the following to decide what the maximum attachment size is that should be supported (MySQL variable is not used for this decision)
  
 ^ Where    ^ Configuration option     ^ Help information                                                ^ ^ Where    ^ Configuration option     ^ Help information                                                ^
Line 112: Line 112:
 The PHP variables should not affect EmailReporting but we wanted to make EmailReporting behave the same as MantisBT as much as possible so we included them. The PHP variables should not affect EmailReporting but we wanted to make EmailReporting behave the same as MantisBT as much as possible so we included them.
  
-As for the MantisBT $g_max_file_size. That one is very important if you've setup EmailReporting to save attachments in the database instead of on the disk. MySQL/MariaDB for example also have limits on the amount of data that is allowed in one insert statement which could generate an error (see max_allowed_packet above). +As for the MantisBT $g_max_file_size. That one is very important if you've setup EmailReporting to save attachments in the database instead of on the disk. MySQL/MariaDB for example also have limits on the amount of data that is allowed in one insert statement which could generate an error (see max_allowed_packet above). If max_allowed_packet is set too low, this could result in the error [[https://dev.mysql.com/doc/refman/8.0/en/gone-away.html|"MySQL server has gone away"]]. 
-Make sure you set $g_max_file_size to a slightly lower value then your server setup supports. + 
-If you need to handle big attachments, make sure MantisBT stores them on the disk, not in the database+Make sure you set $g_max_file_size to a slightly lower value then your server setup supports (alternatively increase the other mentioned values to be higher then $g_max_file_size and adjust any not mentioned requirements for your setup to handle the increased size). If you need to handle big attachments, make sure MantisBT stores them on the disk, not in the database.
  
 === "From" address for MantisBT Notification emails === === "From" address for MantisBT Notification emails ===
Line 149: Line 149:
  
 Description: Whether or not to delete processed emails from the mailbox. See "[[#mailbox_type|Mailbox type]]" for some more info about its effects Description: Whether or not to delete processed emails from the mailbox. See "[[#mailbox_type|Mailbox type]]" for some more info about its effects
 +
 +Do keep in mind that this option was not meant for archiving purposes. The more emails there are in the mailbox, the higher the run-time for the script everytime it is run. This is especially true for IMAP
  
 === mail_max_email_body === === mail_max_email_body ===
 Name: Maximum size of the description or note being added to the issue Name: Maximum size of the description or note being added to the issue
  
-Description: This is the maximum size allowed for the description or a note. The choice was made to make the default 65535 bytes because that used to be the default for old MantisBT versions prior to mid 2007 using MySQL. __New__ MantisBT installations after mid 2007 will be able to store upwards of 1 million bytes. Even more depending on which database backend you use. As updating the schema does __not__ update the column size in question this would be a good default that would not cause problematic issues+Description: This is the maximum size allowed for the description or a note. The choice was made to make the default 60000 bytes because 65535 used to be the default column length for old MantisBT versions prior to mid 2007 using MySQL. Since we need some overhead we lowered 65535 to 60000. __New__ MantisBT installations after mid 2007 will be able to store upwards of 1 million bytes. Even more depending on which database backend you use. As updating the schema does __not__ update the column size in question this would be a good default that would not cause problematic issues
  
-Of course you can increase this if you want. Just make sure that your MantisBT database is using a column type in which this will fit+Of course you can increase this if you want. Just make sure that your MantisBT database is using a column type in which this will fit. This is usually the case if you MantisBT installation was created using MantisBT 1.1.x or later
  
 === mail_max_email_body_text === === mail_max_email_body_text ===
Line 165: Line 167:
 Name: Add the complete description or note as an attachment incase it was truncated Name: Add the complete description or note as an attachment incase it was truncated
  
-Description: Enable this and if a description or note is truncated, the complete description or note before it was truncated will be added as an attachment to the issue. This might fail if the attachment size is also exceeded. +Description: Enable this and if a description or note is truncated, the complete description or note before it was truncated because of "[[#mail_max_email_body|Maximum size of the description or note being added to the issue]]" will be added as an attachment to the issue. This might fail if the attachment size is also exceeded. 
  
 The filename will be description.txt or note.txt. If the filename already exists it will be prepended with a number The filename will be description.txt or note.txt. If the filename already exists it will be prepended with a number
Line 214: Line 216:
  
 Description: With this you can disable MantisBT internal disposable email checker. This will only be changed for EmailReporting, not for the rest of MantisBT Description: With this you can disable MantisBT internal disposable email checker. This will only be changed for EmailReporting, not for the rest of MantisBT
 +
 +=== mail_respect_permissions ===
 +Name: Check user permissions
 +
 +Description: Whether or not EmailReporting should check the permission of the user for adding new issues, notes or attachments.
 +
 +The email will be ignored if a permission check fails for notes or issues, not for attachments. When processing finishes [[#mail_delete|Delete processed email from the mailbox]] will be respected.
 +
 +The default is to ignore permissions because EmailReporting works with the intend to "Process at all costs". If you turn this on it is possible that you will lose emails so should only consciously be turned on.
  
 === mail_add_bug_reports === === mail_add_bug_reports ===
-Name: Create new issues+Name: Add new issues
  
-Description: Whether or not to allow the creation of new issues by EmailReporting. If this is disabled and an email cannot be added as a note, the email will be deleted from the mailbox without further processing+Description: Whether or not to allow the creation of new issues by EmailReporting. If an email cannot be added as a new issue, the email will be ignored without further processing and respect [[#mail_delete|Delete processed email from the mailbox]]
  
 === mail_add_bugnotes === === mail_add_bugnotes ===
Line 320: Line 331:
 Name: Strip signature from email body Name: Strip signature from email body
  
-Description: Strip an email signature from the issues and notes. It will search for a delimiter (see "[[#mail_strip_signature_delim|Delimited by]]") which will mark the start of the signature. Anything below it will be deleted (this includes any other email parts)+Description: Strip an email signature from notes. It will search for a delimiter (see "[[#mail_strip_signature_delim|Delimited by]]") which will mark the start of the signature. Anything below it will be deleted (this includes any other email parts)
  
 === mail_strip_signature_delim === === mail_strip_signature_delim ===
Line 338: Line 349:
  
 Description: Self explanatory i believe. Some users just want to add some attachments to an existing issue. In that case a note is not added but the attachments are. But if this happens for a newly created issue you might wonder what caused it since you would expect the user to inform you of what the problem... maybe he wrote it all in the subject line? Description: Self explanatory i believe. Some users just want to add some attachments to an existing issue. In that case a note is not added but the attachments are. But if this happens for a newly created issue you might wonder what caused it since you would expect the user to inform you of what the problem... maybe he wrote it all in the subject line?
 +
 +=== mail_ignore_auto_replies ===
 +Name: Ignore auto-reply emails
 +
 +Description: Ignore auto-reply emails like out-of-office replies.
 +
 +Check if the email is an out of the office auto reply by checking the following fields:
 +   * X-Autoreply
 +   * X-Autorespond
 +   * auto-submitted with a value of "auto-replied"
 +
 +Based on: https://www.jitbit.com/maxblog/18-detecting-outlook-autoreplyout-of-office-emails-and-x-auto-response-suppress-header/
  
 === mail_remove_replies === === mail_remove_replies ===
Line 381: Line 404:
  
 Description: This will add the raw MIME content (see "[[#mail_debug_directory|Save email contents to this directory if debug mode is activated]]") as an attachment to the issue in question Description: This will add the raw MIME content (see "[[#mail_debug_directory|Save email contents to this directory if debug mode is activated]]") as an attachment to the issue in question
 +
 +=== mail_add_complete_email_ext ===
 +Name: Extension used for the complete email attachment
 +
 +Description: This will allow you to change the extension used for the attachment (see "[[#mail_add_complete_email|Add the complete email into the attachments]]"). Popular extensions are "txt" and "eml".
  
 === mail_debug_show_memory_usage === === mail_debug_show_memory_usage ===
-Name: Show the memory usage in different stages of the email processing process+Name: Show the memory usage at various stages of the email processing process
  
 Description: This will show memory usage during several stages of the email processing. This was mostly added to improve memory usage and should normally be disabled Description: This will show memory usage during several stages of the email processing. This was mostly added to improve memory usage and should normally be disabled
Line 439: Line 467:
  
 Description: PHP 5.6 enables by default SSL verification when encryption is applied to the connection. With this you can manipulate that behavior as its not guaranteed that this works properly. Most likely reason that it does not work is if PHP is unable to access the OS-managed cert stores and the OpenSSL variables (openssl.cafile OR openssl.capath) in PHP configuration file are not properly set Description: PHP 5.6 enables by default SSL verification when encryption is applied to the connection. With this you can manipulate that behavior as its not guaranteed that this works properly. Most likely reason that it does not work is if PHP is unable to access the OS-managed cert stores and the OpenSSL variables (openssl.cafile OR openssl.capath) in PHP configuration file are not properly set
 +
 +Please read this "[[https://www.saotn.org/dont-turn-off-curlopt_ssl_verifypeer-fix-php-configuration/|Don’t turn off CURLOPT_SSL_VERIFYPEER, fix your PHP configuration]]"
  
 === erp_username === === erp_username ===
mantisbt/plugins/emailreporting.1521954389.txt.gz · Last modified: 2018/03/25 01:06 by SL-Gundam

Driven by DokuWiki