Added IMAP support

Author: jordan-wright

gophish/api/api.py

@@ -38,6 +38,7 @@ def _build_url(self, *parts):
 
     def request(self,
                 method,
+                body=None,
                 resource_id=None,
                 resource_action=None,
                 resource_cls=None,
@@ -54,7 +55,7 @@ def request(self,
         if resource_action:
             endpoint = self._build_url(endpoint, resource_action)
 
-        response = self.api.execute(method, endpoint)
+        response = self.api.execute(method, endpoint, json=body)
         if not response.ok:
             raise Error.parse(response.json())
 

gophish/api/imap.py

@@ -0,0 +1,34 @@
+from gophish.models import IMAP, Success
+from gophish.api import APIEndpoint
+
+
+class API(APIEndpoint):
+    def __init__(self, api, endpoint='api/imap/'):
+        super(API, self).__init__(api, endpoint=endpoint, cls=IMAP)
+
+    def get(self):
+        """Gets the configured IMAP settings
+        """
+
+        return super(API, self).get()
+
+    def post(self, imap):
+        """Updates the IMAP settings
+
+        Arguments:
+            imap {gophish.models.IMAP} -- The IMAP settings to configure
+        """
+
+        return super(API, self).post(imap)
+
+    def validate(self, imap):
+        """Sends a validation payload to the webhook specified by the given ID
+
+        Arguments:
+            webhook_id {int} -- The ID of the webhook to validate
+        """
+        return self.request("POST",
+                            body=imap.as_dict(),
+                            resource_action='validate',
+                            resource_cls=Success,
+                            single_resource=True)

gophish/client.py

@@ -1,6 +1,7 @@
 import requests
 
-from gophish.api import (campaigns, groups, pages, smtp, templates, webhooks)
+from gophish.api import (campaigns, groups, imap, pages, smtp, templates,
+                         webhooks)
 
 DEFAULT_URL = 'http://localhost:3333'
 
@@ -37,6 +38,7 @@ def __init__(self,
         self.client = client(api_key, host=host, **kwargs)
         self.campaigns = campaigns.API(self.client)
         self.groups = groups.API(self.client)
+        self.imap = imap.API(self.client)
         self.pages = pages.API(self.client)
         self.smtp = smtp.API(self.client)
         self.templates = templates.API(self.client)

gophish/models.py

@@ -426,6 +426,53 @@ def parse(cls, json):
         return webhook
 
 
+class IMAP(Model):
+    _valid_properties = {
+        'enabled': None,
+        'host': None,
+        'port': None,
+        'username': None,
+        'password': None,
+        'tls': None,
+        'folder': None,
+        'restrict_domain': None,
+        'delete_reported_campaign_email': None,
+        'last_login': None,
+        'modified_date': None,
+        'imap_freq': None
+    }
+
+    def __init__(self, **kwargs):
+        for key, default in IMAP._valid_properties.items():
+            setattr(self, key, kwargs.get(key, default))
+
+    @classmethod
+    def parse(cls, json):
+        imap = cls()
+        for key, val in json.items():
+            if key in cls._valid_properties:
+                setattr(imap, key, val)
+        return imap
+
+
+class Success(Exception, Model):
+    _valid_properties = {'message': None, 'success': None, 'data': None}
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+    def __str__(self):
+        return self.message
+
+    @classmethod
+    def parse(cls, json):
+        success = cls()
+        for key, val in json.items():
+            if key in cls._valid_properties:
+                setattr(success, key, val)
+        return success
+
+
 class Error(Exception, Model):
     _valid_properties = {'message': None, 'success': None, 'data': None}