add option to get for html body as attachment

pyotrs/lib.py

@@ -1128,7 +1128,8 @@ class Client(object):
                          ticket_id,
                          articles=False,
                          attachments=False,
-                         dynamic_fields=True):
+                         dynamic_fields=True,
+                         html_body_as_attachment=False):
         """ticket_get_by_id
 
         Args:
@@ -1138,6 +1139,8 @@ class Client(object):
                     Articles (*default: False*)
             dynamic_fields (bool): will request OTRS to include all
                     Dynamic Fields (*default: True*)
+            html_body_as_attachment (bool): Optional, If enabled the HTML body version of
+                    each article is added to the attachments list
 
         Returns:
             **Ticket** or **False**: Ticket object if successful, otherwise **False**.
@@ -1153,7 +1156,8 @@ class Client(object):
             "TicketID": "{0}".format(ticket_id),
             "AllArticles": int(articles),
             "Attachments": int(attachments),
-            "DynamicFields": int(dynamic_fields)
+            "DynamicFields": int(dynamic_fields),
+            "HTMLBodyAsAttachment": int(html_body_as_attachment),
         }
 
         if not self._parse_and_validate_response(self._send_request(payload)):
@@ -1165,7 +1169,8 @@ class Client(object):
                            ticket_id_list,
                            articles=False,
                            attachments=False,
-                           dynamic_fields=True):
+                           dynamic_fields=True,
+                           html_body_as_attachment=False):
         """ticket_get_by_list
 
         Args:
@@ -1175,6 +1180,8 @@ class Client(object):
                     Articles (*default: False*)
             dynamic_fields (bool): will request OTRS to include all
                     Dynamic Fields (*default: True*)
+            html_body_as_attachment (bool): Optional, If enabled the HTML body version of
+                    each article is added to the attachments list
 
         Returns:
             **list**: Ticket objects (as list) if successful, otherwise **False**.
@@ -1193,7 +1200,8 @@ class Client(object):
             "TicketID": ','.join([str(item) for item in ticket_id_list]),
             "AllArticles": int(articles),
             "Attachments": int(attachments),
-            "DynamicFields": int(dynamic_fields)
+            "DynamicFields": int(dynamic_fields),
+            "HTMLBodyAsAttachment": int(html_body_as_attachment),
         }
 
         if not self._parse_and_validate_response(self._send_request(payload)):
@@ -1205,7 +1213,8 @@ class Client(object):
                              ticket_number,
                              articles=False,
                              attachments=False,
-                             dynamic_fields=True):
+                             dynamic_fields=True,
+                             html_body_as_attachment=False):
         """ticket_get_by_number
 
         Args:
@@ -1215,6 +1224,8 @@ class Client(object):
                     Articles (*default: False*)
             dynamic_fields (bool): will request OTRS to include all
                     Dynamic Fields (*default: True*)
+            html_body_as_attachment (bool): Optional, If enabled the HTML body version of
+                    each article is added to the attachments list
 
         Raises:
             ValueError
@@ -1235,7 +1246,8 @@ class Client(object):
             result = self.ticket_get_by_id(result_list[0],
                                            articles=articles,
                                            attachments=attachments,
-                                           dynamic_fields=dynamic_fields)
+                                           dynamic_fields=dynamic_fields,
+                                           html_body_as_attachment=html_body_as_attachment)
             if not result:
                 return False
             else: