Changes between Initial Version and Version 1 of Email2tracParse

Timestamp:

01/16/09 15:51:40 (15 years ago)

Author:

bas

Comment:

--

Email2tracParse

@@ +1 @@
+[[PageOutline]]
+
+= How an email is being parsed =
+
+An email has a header and a body. The email header fields are used to set the ticket fields and the body is used for the description and attachments. See section below how the header and body are parsed.
+
+== Header ==
+
+Must be written
+
+== Body == 
+
+If a message's body is broken up into several pieces (by attachments in the middle of the message), the ticket's description is set to the entire body, not just the first part
+
+For example, from an email like this:
+
+{{{
+some text
+<some binary>
+more text
+}}}
+
+the ticket that is created will have "some text" and "more text" in its description
+
+=== Links to attachments inside the ticket description ===
+
+![attachment:filename] links are automatically placed inside the ticket description, so that message text can clearly refer to them. 
+
+For example, an email like
+
+{{{
+I opened this file in your app:
+<my file>
+and I got the following error dialog:
+<image>
+}}}
+
+will generate a ticket like this:
+
+{{{
+I opened this file in your app:
+
+[attachment:"my file"]
+
+and I got the following error dialog:
+
+[attachment:"image"]
+}}}
+
+=== Inline image attachments ===
+
+If an attachment is of type image/* and its Content-Disposition is inline, then a Trac Image macro is placed inside the ticket description in the appropriate place, so that the resulting ticket has the image inline where it belongs in the text.
+
+The same email as in the previous example, if the image is inline, will result in:
+
+{{{
+I opened this file in your app
+
+[attachment:"my file"]
+
+and I got the following error dialog:
+
+[[Image(image)]]
+}}}