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 revision Previous revision
Next revision
Previous revision
mantisbt:plugins:emailreporting [2018/03/07 07:24]
anonymous ↷ Links adapted because of a move operation
mantisbt:plugins:emailreporting [2019/09/08 01:33] (current)
SL-Gundam [Configuration options]
Line 5: Line 5:
 ===== Overview ===== ===== Overview =====
  
-The **EmailReporting** [[.plugins:start|plugin]] allows you to report an issue in Mantis by sending an email to a particular mail account.+The **EmailReporting** [[start|plugin]] allows you to report an issue in Mantis by sending an email to a particular mail account.
  
 ===== Features ===== ===== Features =====
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 ===
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 383: Line 406:
  
 === 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 453: Line 476:
 Name: Authentication method Name: Authentication method
  
-Description:​ Supports various authentication methods that might be required for authentication to your mail server. Usually the default will suffice. Below you can find a table of which authentication methods ​are supported towards POP3 and IMAP+Description:​ Supports various authentication methods that might be required for authentication to your mail server. Usually the default will suffice. Below you will find a table with the authentication methods supported towards POP3 and IMAP
 ^ Mailbox type   ^ DIGEST-MD5 ​   ^ CRAM-MD5 ​  ^ APOP     ^ PLAIN      ^ LOGIN        ^ USER         ^ ^ Mailbox type   ^ DIGEST-MD5 ​   ^ CRAM-MD5 ​  ^ APOP     ^ PLAIN      ^ LOGIN        ^ USER         ^
 | POP3           | Disabled ​     | Yes        | Yes      | Yes        | Yes          | Yes          | | POP3           | Disabled ​     | Yes        | Yes      | Yes        | Yes          | Yes          |
Line 501: Line 524:
 ===== References ===== ===== References =====
  
-  - [[reporting_via_email]]+  - [[..:reporting_via_email]]
mantisbt/plugins/emailreporting.1520425485.txt.gz · Last modified: 2018/03/07 07:24 by anonymous