Differences

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

--- extensions:ticket-from-email [2019/10/08 10:37]
vdumas
+++ extensions:ticket-from-email [2020/07/02 09:59] (current)
@@ Line 4: / Line 4: @@
 description_wiki : Scan several mailboxes to create or update tickets.
 index_hidden     : yes
-version          : 3.1.0
+version          : 3.1.1
-release_dt       : 2019-05-21
+release_dt       : 2019-11-22
 itop-version-min : 2.3.0
-download_url     : http://www.combodo.com/itop-extensions/
+download_hidden  : http://www.combodo.com/itop-extensions/combodo-mail-to-ticket-automation-3.1.1-520.zip
 code             : combodo-mail-to-ticket-automation
 state            : stable
@@ Line 13: / Line 13: @@
 alias-code_hidden : ticket-from-email
 alternate-name   : Ticket Creation from eMails
-module-lists_hidden : combodo-email-synchro/3.2.0, itop-standard-email-synchro/3.1.0
+module-lists_hidden : combodo-email-synchro/3.2.1, itop-standard-email-synchro/3.1.1
 diffusion        : iTop Hub
 ----
@@ Line 61: / Line 61: @@
 ^  Release Date  ^  Version  ^  Comments  ^
+|  2019-11-22  |  3.1.1  | * Compatibility with iTop 2.7 \\                 * Fix bad encoded non breaking space by outlook \\ 		* Update DE translations \\ 		* ID for incoming email are checked from reference |
 |  2019-05-21  |  3.1.0  | * Contacts in To/cc with the same email as current mailbox are not added to the ticket anymore \\                 * Handle signed emails with an "enveloped format" \\                 * Store eml for all the messages |
 |  2019-03-19  |  3.0.17  | Dictionnaries internal updates |
@@ Line 95: / Line 96: @@
 |  2013-07-22  |  2.2  | "Legacy" version supporting only one mailbox (configured from the iTop configuration file). The documentation for this version is available here: [[ticket_creation_from_emails|Ticket Creation from eMails (legacy)]]|
-===== Limitations =====
-  * Each mail inbox configured corresponds to one type of Ticket (i.e. User Requests or Incidents, but not both).
-  * Connecting to a POP3 mailbox via the php IMAP extension does **not** work. You **must** use the POP3 configuration via PEAR::NetSocket for such a case.
-  * There is no validation that the target class of the Mail Inbox is an existing class in iTop. (i.e. don't try to create incidents if the Incident Management module is not installed).
-  * The support of inline images works only if the preferred order for email parts is configured as "text/html,text/plain" (i.e. HTML first), which is now the default for all new installations.
-<note important>When processing an email considered as an update to a ticket, the extensions tries to extract the "new part" of the message (excluding the content from previous messages). However, depending on the format of the reply (which itself depends on the email client software used) it may not be possible to extract this information in a reliable manner. In such a case the whole text of the email will be used. Unfortunately, the widely used MS Outlook is an example of such client software where the replies cannot reliably be identified. Refer to the configuration parameter ''html-tags-to-remove'' for explanations about how to adjust this behavior.</note>
 ===== Requirements =====
@@ Line 109: / Line 101: @@
   * A connection to a POP3 or IMAP server with a valid mailbox.
   * [[latest:admin:cron|cron.php]] must be running to enable the processing of incoming eMails.
-  * For resizing big images, [[http://php.net/manual/en/book.image.php|PHP GD]] must be installed.
+  * For the debug trace, [[https://www.php.net/manual/en/book.mbstring.php|PHP MBString]] must be installed.
-  *
+  * For resizing big images, [[https://php.net/manual/en/book.image.php|PHP GD]] must be installed.
 <note important>On Ubuntu 16.04 the prerequisites can be installed using the ''php-pear'', ''php-net-socket'' and ''php-imap'' packages:
 <code>
@@ Line 140: / Line 133: @@
 </note>
+====== Usage ======
 ===== Data Mapping =====
@@ Line 183: / Line 177: @@
 | Login | The name of the mail account used for connecting to the mailbox | test@mycompany.com |
 | Password | The password for the above mentioned account | |
-| Protocol | The protocol to connect to the mail server: either POP3 or IMAP. | POP3 |
+| Protocol | The protocol to connect to the mail server: either POP3 or IMAP. \\ If you need to use IMAP with SSL or TLS, refer to the imap_options configuration parameter below. | POP3 |
 | Port | The TCP port to connect to the server. The standard values are 110 (secured: 995) for POP3 and 143 (secured: 993) for IMAP | 110 |
 | Mailbox (for IMAP) | The IMAP mailbox (folder) to scan for incoming messages. If omitted the default (root) mailbox will be scanned. This option is ignored when using the POP3 protocol. | INBOX.Folder.Subfolder |
@@ Line 232: / Line 226: @@
 <note important>The parameters listed below apply to **all** the Mail Inboxes</note>
-<note warning>Starting with Mail to ticket automation **version 2.6.6**, the recommended value for the configuration parameter ''body_parts_order'' is ''text/html,text/plain''. Indeed in order to properly import the images embedded inside an HTML email, the HTML version of the email must be processed instead of the plain text version.</note>
+<note>The recommended value for the configuration parameter ''body_parts_order'' is ''text/html,text/plain''. Indeed in order to properly import the images embedded inside an HTML email, the HTML version of the email must be processed instead of the plain text version.</note>
 <code php>
@@ Line 262: / Line 256: @@
 => '/\\RDe : .+\\RDate : /m',
 => '/\\TO:.+\\RCC:/m',
+      ),
+      'delimiter-patterns' => array (
+            '/^>.*$/' => false,  // "false" remove only the line, "true" remove the rest of the message
       ),
       'big_files_dir' => '',
@@ Line 279: / Line 276: @@
            'pre' => array('moz-signature'),
       );
    ),
 </code>
@@ Line 285: / Line 283: @@
 | debug | Set to true to turn on debug output | false |
 | periodicity | Interval (in seconds) at which to check for incoming messages | 30 |
-| body_parts_order | Comma separated, ordered, list of MIME types, determining the preferred part of the message to retrieve for populating the ''description'' or ''public_log'' of the Ticket. **Note: new since 2.6.6** In order to import as inline images the images embedded in HTML, the HTML part of the email must be processed in priority over the text part. Therefore the recommended configuration is ''text/html,text/plain''. | text/html,text/plain |
+| body_parts_order | Comma separated, ordered, list of MIME types, determining the preferred part of the message to retrieve for populating the ''description'' or ''public_log'' of the Ticket. In order to import as inline images the images embedded in HTML, the HTML part of the email must be processed in priority over the text part. Therefore the recommended configuration is ''text/html,text/plain''. | text/html,text/plain |
 | pop3_auth_options | POP3 authentication options. Possible values are: 'CRAM-MD5', 'APOP' , 'PLAIN' , 'LOGIN', 'USER' | USER |
-| imap_options | Additional IMAP options. Possible values are listed here: [[http://www.php.net/manual/en/function.imap-open.php|IMAP flags]]. **Warning**: Do NOT use the ''pop3'' flag to connect to a POP3 mailbox using the PHP IMAP extension. Due to a limitation of the IMAP extension this will not work! If you want to connect to a POP3 server, use the POP3 protocol instead. | array('imap', 'novalidate-cert') |
+| imap_options | Additional IMAP options. Possible values are listed here: [[http://www.php.net/manual/en/function.imap-open.php|IMAP flags]]. \\ For example to use SSL you could specify : ''array(0 => 'imap', 2 => 'ssl')'' \\ **Warning**: Do NOT use the ''pop3'' flag to connect to a POP3 mailbox using the PHP IMAP extension. Due to a limitation of the IMAP extension this will not work! If you want to connect to a POP3 server, use the POP3 protocol instead. | array('imap') |
 | exclude_attachment_types | Array of MIME types to exclude when retrieving attachments | array('application/attachment') |
 | html-tags-to-remove | ** new in 3.0.0 ** Used for computing the "new part" of HTML messages by removing the specified tags. The syntax is an array of ''tag_name'' <nowiki>=></nowiki> array of CSS class names. | //see above// |
 | maximum_email_size | If an incoming email is bigger than the specified size, the message will saved to the ''big_files_dir'' if it is configured and deleted from the inbox. A notification message will be sent to the administrator as for other "errors" happening when processing the mail inbox. The size can be specified using the 'short' notation: 100K, 3M, 2G... If set to zero, no limit will be enforced...  with the risk of a PHP crash if there is not enough memory to decode an incoming email. | 10M |
 | introductory-patterns | **only for plain text emails** When computing the "new part" of a message, lines matching this pattern and preceding what looks like an "old part" of the message, are removed. Adapt this list to your localization… and favorite email client dialect. The pattern specified here must follow the [[http://www.php.net/manual/en/reference.pcre.pattern.syntax.php|PCRE]] syntax. | //see above// |
-| multiline-delimiter-patterns | **only for plain text emails** Multi-line regular expression patterns used for computing the "new part" of a message. each of theses patterns determine the beginning of the "old part" of a message, when a message is a "Reply" to another message. Everything that matches this pattern (and all the text that follows this match) will be removed for the "new part". All patterns are tested successively. The pattern that provides a match closer to the beginning of the text will be used. Adapt this list to your localization and to the dialect of your favorite email clients... The pattern specified here must follow the [[http://www.php.net/manual/en/reference.pcre.pattern.syntax.php|PCRE]] syntax.| //see above// |
+| multiline-delimiter-patterns | **only for plain text emails** and **only for mail for ticket update** Multi-line regular expression patterns used for computing the "new part" of a message. each of theses patterns determine the beginning of the "old part" of a message, when a message is a "Reply" to another message. Everything that matches this pattern (and all the text that follows this match) will be removed for the "new part". All patterns are tested successively. The pattern that provides a match closer to the beginning of the text will be used. Adapt this list to your localization and to the dialect of your favorite email clients... Patterns must follow the [[http://www.php.net/manual/en/reference.pcre.pattern.syntax.php|PCRE]] syntax.| //see above// |
+| delimiter-patterns | **only for plain text emails** and **only for mail for ticket update** this regular expression patterns are used for detecting the lines beginning "old part" of a message, in case none of the multiline-delimiter-patterns did match. Patterns must follow the [[http://www.php.net/manual/en/reference.pcre.pattern.syntax.php|PCRE]] syntax. | //see above// |
 | big_files_dir | The path to a directory where to store emails bigger than ''maximum_email_size''. If this directory is not configured, the emails are simply deleted before notifying the administrator. |  |
 | use_message_id_as_uid | Boolean. For IMAP connections only. Whether or not to use the identifier from the message (MessageID) instead of the Mailbox' unique identifier (UID) to uniquely identify the already processed messages. This can be useful to workaround problems when the UID of the messages on the server changes between sessions (like with Gmail). If you toggle this value, make sure that you first empty the mailbox (and stop the cron job), since all messages present in the mailbox when the setting is changed will be considered as new and processed again. | false |
-| images_minimum_size | **new in 2.6.6** Minimum dimensions for importing images. Images smaller than the given dimensions will be ignored and not imported as attachments. The dimensions are expressed as a string //width//''x''//height// (where //width// and //height// are integer numbers, in pixels). | 100x20 |
+| images_minimum_size | Minimum dimensions for importing images. Images smaller than the given dimensions will be ignored and not imported as attachments. The dimensions are expressed as a string //width//''x''//height// (where //width// and //height// are integer numbers, in pixels). | 100x20 |
-| images_maximum_size | **new in 2.6.6** Images bigger than these dimensions (for example ''1000x1000'') will be resized to fit in the given dimensions. The dimensions are expressed as a string //width//''x''//height// (where //width// and //height// are integer numbers, in pixels). **Note** this feature is available only if PHP GD is installed. If no dimensions are given, the images are never resized. | |
+| images_maximum_size | Images bigger than these dimensions (for example ''1000x1000'') will be resized to fit in the given dimensions. The dimensions are expressed as a string //width//''x''//height// (where //width// and //height// are integer numbers, in pixels). **Note** this feature is available only if PHP GD is installed. If no dimensions are given, the images are never resized. | |
 | undesired-subject-patterns | An array of regular expression patterns (as PHP text strings) that will be used to test the subject of the incoming email. If any of these pattern matches, the email will be considered as "undesirable" and rejected (the same processing as for any other error case will then be applied). The patterns specified here must follow the [[http://www.php.net/manual/en/reference.pcre.pattern.syntax.php|PCRE]] syntax. | array() |
 | undesired-purge-delay | Delay in days to remove automatically the undesired messages (0 means that the messages are removed immediately) | 7 |
 | recommended_max_allowed_packet | Display a warning on the 'Mailbox Content' screen if the database parameter 'max_allowed_packet' is less than the one configured | 10*1024*1024 |
 <note important>When specifying PCRE patterns inside the configuration file, make sure that you double the backslash characters, since backslashes must be escaped inside PHP litteral text strings.</note>
@@ Line 315: / Line 315: @@
 | ticket_log| An associative array (hash) defining, for each class of Ticket, the code of the attribute to set when updating a ticket from an incoming message. You don't need to change this value unless you modified the Data Model. | //see above// |
-====== Checking the connection ======
+====== Troubleshooting ======
+===== Limitations =====
+  * Each mail inbox configured corresponds to one type of Ticket (i.e. User Requests or Incidents, but not both).
+  * Connecting to a POP3 mailbox via the php IMAP extension does **not** work. You **must** use the POP3 configuration via PEAR::NetSocket for such a case.
+  * There is no validation that the target class of the Mail Inbox is an existing class in iTop. (i.e. don't try to create incidents if the Incident Management module is not installed).
+  * The support of inline images works only if the preferred order for email parts is configured as "text/html,text/plain" (i.e. HTML first), which is now the default for all new installations.
+<note important>When processing an email considered as an update to a ticket, the extensions tries to extract the "new part" of the message (excluding the content from previous messages). However, depending on the format of the reply (which itself depends on the email client software used) it may not be possible to extract this information in a reliable manner. In such a case the whole text of the email will be used. Unfortunately, the widely used MS Outlook is an example of such client software where the replies cannot reliably be identified. Refer to the configuration parameter ''html-tags-to-remove'' for explanations about how to adjust this behavior.</note>
+===== Checking the connection =====
 Once the Mail Inbox object has been created, you can use the tab "Mailbox Content" in the details of the object to check that the application can properly connect to the mail server and retrieve messages from it.
@@ Line 329: / Line 340: @@
   * "Ignore eMail": mark new messages as "ignored" to avoid processing them.
-====== Debugging ======
+===== Debugging =====
 **New in 3.0.15**: Access to the eml used and to the message specific logs without activating the debug mode for every processed message.
@@ Line 362: / Line 375: @@
 **Question: a particular mail is in error, why?** \\
 Answer: There can be multiple reasons, which leads to flagging a mail in error. When browsing the ''Mailbox Content'' tab on the ''Incoming eMail Inboxes'' the error message should explain you the reason. Attachment too big, mail in an unkown format (encrypted for eg.),...

iTop Documentation

User Tools

Site Tools

Differences

Page Tools