Module mail2beyond.connectors.slack

Creates the built-in 'slack' connector that can be used to translate SMTP messages into Slack messages.

"""
Creates the built-in 'slack' connector that can be used to translate SMTP messages into Slack messages.
"""

import requests

from mail2beyond import framework


class Connector(framework.BaseConnector):
    """Defines a connector that allows mail2beyond to integrate with Slack."""
    name = "slack"

    def submit(self, parser):
        """Overwrites the submit() method to send a Slack message."""
        # Submit this message to Slack via webhook URL
        try:
            resp = requests.post(
                url=self.config["webhook_url"],
                headers={'Content-Type': 'application/json'},
                json={"text": f"*{parser.subject}*\n\n{parser.content}"}
            )
            self.log.debug(f"connector '{self}' responded with {resp.status_code} status {resp.text}")
        except Exception as slack_req_err:
            self.log.error(f"connector '{self}' failed '{slack_req_err}'")
            raise framework.Error(f"connector '{self}' : {slack_req_err}")

    def pre_submit(self, parser):
        """Overwrites the pre_submit() method to ensure required config values are set."""
        # Ensure ths connector has a config value for 'webhook_url'
        if "webhook_url" not in self.config:
            raise framework.Error(f"connector '{self}' requires config value 'webhook_url'")
        # Ensure the webhook_url config value is a string
        if not isinstance(self.config["webhook_url"], str):
            raise framework.Error(f"connector '{self}' config value 'webhook_url' must be type 'str'")

Classes

class Connector (**kwargs)

Defines a connector that allows mail2beyond to integrate with Slack.

Initialize the object with required attributes.

Notes

Any arguments passed in when this object is created will be stored in the 'config' attribute of the object.

Expand source code

class Connector(framework.BaseConnector):
    """Defines a connector that allows mail2beyond to integrate with Slack."""
    name = "slack"

    def submit(self, parser):
        """Overwrites the submit() method to send a Slack message."""
        # Submit this message to Slack via webhook URL
        try:
            resp = requests.post(
                url=self.config["webhook_url"],
                headers={'Content-Type': 'application/json'},
                json={"text": f"*{parser.subject}*\n\n{parser.content}"}
            )
            self.log.debug(f"connector '{self}' responded with {resp.status_code} status {resp.text}")
        except Exception as slack_req_err:
            self.log.error(f"connector '{self}' failed '{slack_req_err}'")
            raise framework.Error(f"connector '{self}' : {slack_req_err}")

    def pre_submit(self, parser):
        """Overwrites the pre_submit() method to ensure required config values are set."""
        # Ensure ths connector has a config value for 'webhook_url'
        if "webhook_url" not in self.config:
            raise framework.Error(f"connector '{self}' requires config value 'webhook_url'")
        # Ensure the webhook_url config value is a string
        if not isinstance(self.config["webhook_url"], str):
            raise framework.Error(f"connector '{self}' config value 'webhook_url' must be type 'str'")

Ancestors

• BaseConnector

Class variables

var name

Methods

def pre_submit(self, parser)

Overwrites the pre_submit() method to ensure required config values are set.

Expand source code

def pre_submit(self, parser):
    """Overwrites the pre_submit() method to ensure required config values are set."""
    # Ensure ths connector has a config value for 'webhook_url'
    if "webhook_url" not in self.config:
        raise framework.Error(f"connector '{self}' requires config value 'webhook_url'")
    # Ensure the webhook_url config value is a string
    if not isinstance(self.config["webhook_url"], str):
        raise framework.Error(f"connector '{self}' config value 'webhook_url' must be type 'str'")

def submit(self, parser)

Overwrites the submit() method to send a Slack message.

Expand source code

def submit(self, parser):
    """Overwrites the submit() method to send a Slack message."""
    # Submit this message to Slack via webhook URL
    try:
        resp = requests.post(
            url=self.config["webhook_url"],
            headers={'Content-Type': 'application/json'},
            json={"text": f"*{parser.subject}*\n\n{parser.content}"}
        )
        self.log.debug(f"connector '{self}' responded with {resp.status_code} status {resp.text}")
    except Exception as slack_req_err:
        self.log.error(f"connector '{self}' failed '{slack_req_err}'")
        raise framework.Error(f"connector '{self}' : {slack_req_err}")

Inherited members

• BaseConnector:
  • run