Notification Connector

Notification

Instantiate a Notification object.

Parameters:

Name	Type	Description	Default
proxy	str	Proxy address	''

Source code in honeydew/notification.py

class Notification:
    """
    Instantiate a Notification object.

    Args:
        proxy (str): Proxy address
    """    
    def __init__(self, proxy=''):
        self.proxies = {}
        if proxy != '':
            proxies = {
                'http': proxy,
                'https': proxy,
            }


    # Sending message through webhook (Google Chat, Slack, etc)
    def send_google_chat_message(self, webhook_url, message):
        """
        Send message through webhook (Google Chat, Slack, etc).

        Args:
            webhook_url (str): Webhook URL
            message (str): Message to be sent

        Returns:
            result (str): Value is 'OK' when successful
        """
        headers = {'Content-type': 'application/json'}
        data = {'text': message}
        response = requests.post(webhook_url, headers=headers, data=json.dumps(data), proxies=self.proxies)
        return 'OK'


    # Creating Google Chat card as described in https://developers.google.com/chat/how-tos/cards-onclick
    def create_google_chat_card(self, title, subtitle, image_url, image_alt_text, text, button_text, button_url):
        """
        Create Google Chat card.

        Args:
            title (str): Card title
            subtitle (str): Card subtitle
            image_url (str): Image URL
            image_alt_text (str): Image alt text
            text (str): Card text
            button_text (str): Button text
            button_url (str): Button URL

        Returns:
            card (dict): Card to be sent
        """
        card = {
            "cards": [
                {
                    "header": {
                        "title": title,
                        "subtitle": subtitle,
                        "imageUrl": image_url,
                        "imageStyle": "IMAGE"
                    },
                    "sections": [
                        {
                            "widgets": [
                                {
                                    "textParagraph": {
                                        "text": text
                                    }
                                },
                                {
                                    "buttons": [
                                        {
                                            "textButton": {
                                                "text": button_text,
                                                "onClick": {
                                                    "openLink": {
                                                        "url": button_url
                                                    }
                                                }
                                            }
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
            ]
        }
        return card

    # Sending card to Google Chat 
    def send_google_chat_card(self, webhook_url, card):
        """
        Send card to Google Chat.

        Args:
            webhook_url (str): Webhook URL
            card (dict): Card to be sent

        Returns:
            result (str): Value is 'OK' when successful
        """
        headers = {'Content-type': 'application/json'}
        data = card
        response = requests.post(webhook_url, headers=headers, data=json.dumps(data), proxies=self.proxies)
        return 'OK'

    # Sending email through SMTP
    def send_smtp_email(self, smtp_server, smtp_port, smtp_username, smtp_password, sender, recipient, subject, message):
        """
        Send email through SMTP.

        Args:
            smtp_server (str): SMTP server address
            smtp_port (str): SMTP port
            smtp_username (str): SMTP username
            smtp_password (str): SMTP password
            sender (str): Sender email address
            recipient (str): Recipient email address
            subject (str): Email subject
            message (str): Email message

        Returns:
            result (str): Value is 'OK' when successful
        """
        import smtplib
        from email.mime.multipart import MIMEMultipart
        from email.mime.text import MIMEText
        from email.mime.base import MIMEBase
        from email import encoders

        msg = MIMEMultipart()
        msg['From'] = sender
        msg['To'] = recipient
        msg['Subject'] = subject
        msg.attach(MIMEText(message, 'plain'))
        text = msg.as_string()
        server = smtplib.SMTP(smtp_server, smtp_port)
        server.starttls()
        server.login(smtp_username, smtp_password)
        server.sendmail(sender, recipient, text)
        server.quit()
        return 'OK'

    # Sending email through SMTP with attachment
    def send_smtp_email_with_attachment(self, smtp_server, smtp_port, smtp_username, smtp_password, sender, recipient, subject, message, attachment_path):
        """
        Send email through SMTP with attachment.

        Args:
            smtp_server (str): SMTP server address
            smtp_port (str): SMTP port
            smtp_username (str): SMTP username
            smtp_password (str): SMTP password
            sender (str): Sender email address
            recipient (str): Recipient email address
            subject (str): Email subject
            message (str): Email message
            attachment_path (str): Attachment file path

        Returns:
            result (str): Value is 'OK' when successful
        """
        import smtplib
        from email.mime.multipart import MIMEMultipart
        from email.mime.text import MIMEText
        from email.mime.base import MIMEBase
        from email import encoders

        msg = MIMEMultipart()
        msg['From'] = sender
        msg['To'] = recipient
        msg['Subject'] = subject
        msg.attach(MIMEText(message, 'plain'))
        filename = os.path.basename(attachment_path)
        attachment = open(attachment_path, "rb")
        part = MIMEBase('application', 'octet-stream')
        part.set_payload(attachment.read())
        encoders.encode_base64(part)
        part.add_header('Content-Disposition', f"attachment; filename= {filename}")
        msg.attach(part)
        text = msg.as_string()
        server = smtplib.SMTP(smtp_server, smtp_port)
        server.starttls()
        server.login(smtp_username, smtp_password)
        server.sendmail(sender, recipient, text)
        server.quit()
        return 'OK'

    # Sending email through SMTP in HTML format
    def send_smtp_email_html(self, smtp_server, smtp_port, smtp_username, smtp_password, sender, recipient, subject, message):
        """
        Send email through SMTP in HTML format.

        Args:
            smtp_server (str): SMTP server address
            smtp_port (str): SMTP port
            smtp_username (str): SMTP username
            smtp_password (str): SMTP password
            sender (str): Sender email address
            recipient (str): Recipient email address
            subject (str): Email subject
            message (str): Email message

        Returns:
            result (str): Value is 'OK' when successful
        """
        import smtplib
        from email.mime.multipart import MIMEMultipart
        from email.mime.text import MIMEText
        from email.mime.base import MIMEBase
        from email import encoders

        msg = MIMEMultipart()
        msg['From'] = sender
        msg['To'] = recipient
        msg['Subject'] = subject
        msg.attach(MIMEText(message, 'html'))
        text = msg.as_string()
        server = smtplib.SMTP(smtp_server, smtp_port)
        server.starttls()
        server.login(smtp_username, smtp_password)
        server.sendmail(sender, recipient, text)
        server.quit()
        return 'OK'

    # Sending email through SMTP in HTML format with attachment
    def send_smtp_email_html_with_attachment(self, smtp_server, smtp_port, smtp_username, smtp_password, sender, recipient, subject, message, attachment_path):
        """
        Send email through SMTP in HTML format with attachment.

        Args:
            smtp_server (str): SMTP server address
            smtp_port (str): SMTP port
            smtp_username (str): SMTP username
            smtp_password (str): SMTP password
            sender (str): Sender email address
            recipient (str): Recipient email address
            subject (str): Email subject
            message (str): Email message
            attachment_path (str): Attachment file path

        Returns:
            result (str): Value is 'OK' when successful
        """
        import smtplib
        from email.mime.multipart import MIMEMultipart
        from email.mime.text import MIMEText
        from email.mime.base import MIMEBase
        from email import encoders

        msg = MIMEMultipart()
        msg['From'] = sender
        msg['To'] = recipient
        msg['Subject'] = subject
        msg.attach(MIMEText(message, 'html'))
        filename = os.path.basename(attachment_path)
        attachment = open(attachment_path, "rb")
        part = MIMEBase('application', 'octet-stream')
        part.set_payload(attachment.read())
        encoders.encode_base64(part)
        part.add_header('Content-Disposition', f"attachment; filename= {filename}")
        msg.attach(part)
        text = msg.as_string()
        server = smtplib.SMTP(smtp_server, smtp_port)
        server.starttls()
        server.login(smtp_username, smtp_password)
        server.sendmail(sender, recipient, text)
        server.quit()
        return 'OK'

create_google_chat_card(title, subtitle, image_url, image_alt_text, text, button_text, button_url)

Create Google Chat card.

Parameters:

Name	Type	Description	Default
title	str	Card title	required
subtitle	str	Card subtitle	required
image_url	str	Image URL	required
image_alt_text	str	Image alt text	required
text	str	Card text	required
button_text	str	Button text	required
button_url	str	Button URL	required

Returns:

Name	Type	Description
card	dict	Card to be sent

Source code in honeydew/notification.py

def create_google_chat_card(self, title, subtitle, image_url, image_alt_text, text, button_text, button_url):
    """
    Create Google Chat card.

    Args:
        title (str): Card title
        subtitle (str): Card subtitle
        image_url (str): Image URL
        image_alt_text (str): Image alt text
        text (str): Card text
        button_text (str): Button text
        button_url (str): Button URL

    Returns:
        card (dict): Card to be sent
    """
    card = {
        "cards": [
            {
                "header": {
                    "title": title,
                    "subtitle": subtitle,
                    "imageUrl": image_url,
                    "imageStyle": "IMAGE"
                },
                "sections": [
                    {
                        "widgets": [
                            {
                                "textParagraph": {
                                    "text": text
                                }
                            },
                            {
                                "buttons": [
                                    {
                                        "textButton": {
                                            "text": button_text,
                                            "onClick": {
                                                "openLink": {
                                                    "url": button_url
                                                }
                                            }
                                        }
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ]
    }
    return card

send_google_chat_card(webhook_url, card)

Send card to Google Chat.

Parameters:

Name	Type	Description	Default
webhook_url	str	Webhook URL	required
card	dict	Card to be sent	required

Returns:

Name	Type	Description
result	str	Value is 'OK' when successful

Source code in honeydew/notification.py

def send_google_chat_card(self, webhook_url, card):
    """
    Send card to Google Chat.

    Args:
        webhook_url (str): Webhook URL
        card (dict): Card to be sent

    Returns:
        result (str): Value is 'OK' when successful
    """
    headers = {'Content-type': 'application/json'}
    data = card
    response = requests.post(webhook_url, headers=headers, data=json.dumps(data), proxies=self.proxies)
    return 'OK'

send_google_chat_message(webhook_url, message)

Send message through webhook (Google Chat, Slack, etc).

Parameters:

Name	Type	Description	Default
webhook_url	str	Webhook URL	required
message	str	Message to be sent	required

Returns:

Name	Type	Description
result	str	Value is 'OK' when successful

Source code in honeydew/notification.py

def send_google_chat_message(self, webhook_url, message):
    """
    Send message through webhook (Google Chat, Slack, etc).

    Args:
        webhook_url (str): Webhook URL
        message (str): Message to be sent

    Returns:
        result (str): Value is 'OK' when successful
    """
    headers = {'Content-type': 'application/json'}
    data = {'text': message}
    response = requests.post(webhook_url, headers=headers, data=json.dumps(data), proxies=self.proxies)
    return 'OK'

send_smtp_email(smtp_server, smtp_port, smtp_username, smtp_password, sender, recipient, subject, message)

Send email through SMTP.

Parameters:

Name	Type	Description	Default
smtp_server	str	SMTP server address	required
smtp_port	str	SMTP port	required
smtp_username	str	SMTP username	required
smtp_password	str	SMTP password	required
sender	str	Sender email address	required
recipient	str	Recipient email address	required
subject	str	Email subject	required
message	str	Email message	required

Returns:

Name	Type	Description
result	str	Value is 'OK' when successful

Source code in honeydew/notification.py

def send_smtp_email(self, smtp_server, smtp_port, smtp_username, smtp_password, sender, recipient, subject, message):
    """
    Send email through SMTP.

    Args:
        smtp_server (str): SMTP server address
        smtp_port (str): SMTP port
        smtp_username (str): SMTP username
        smtp_password (str): SMTP password
        sender (str): Sender email address
        recipient (str): Recipient email address
        subject (str): Email subject
        message (str): Email message

    Returns:
        result (str): Value is 'OK' when successful
    """
    import smtplib
    from email.mime.multipart import MIMEMultipart
    from email.mime.text import MIMEText
    from email.mime.base import MIMEBase
    from email import encoders

    msg = MIMEMultipart()
    msg['From'] = sender
    msg['To'] = recipient
    msg['Subject'] = subject
    msg.attach(MIMEText(message, 'plain'))
    text = msg.as_string()
    server = smtplib.SMTP(smtp_server, smtp_port)
    server.starttls()
    server.login(smtp_username, smtp_password)
    server.sendmail(sender, recipient, text)
    server.quit()
    return 'OK'

send_smtp_email_html(smtp_server, smtp_port, smtp_username, smtp_password, sender, recipient, subject, message)

Send email through SMTP in HTML format.

Parameters:

Name	Type	Description	Default
smtp_server	str	SMTP server address	required
smtp_port	str	SMTP port	required
smtp_username	str	SMTP username	required
smtp_password	str	SMTP password	required
sender	str	Sender email address	required
recipient	str	Recipient email address	required
subject	str	Email subject	required
message	str	Email message	required

Returns:

Name	Type	Description
result	str	Value is 'OK' when successful

Source code in honeydew/notification.py

def send_smtp_email_html(self, smtp_server, smtp_port, smtp_username, smtp_password, sender, recipient, subject, message):
    """
    Send email through SMTP in HTML format.

    Args:
        smtp_server (str): SMTP server address
        smtp_port (str): SMTP port
        smtp_username (str): SMTP username
        smtp_password (str): SMTP password
        sender (str): Sender email address
        recipient (str): Recipient email address
        subject (str): Email subject
        message (str): Email message

    Returns:
        result (str): Value is 'OK' when successful
    """
    import smtplib
    from email.mime.multipart import MIMEMultipart
    from email.mime.text import MIMEText
    from email.mime.base import MIMEBase
    from email import encoders

    msg = MIMEMultipart()
    msg['From'] = sender
    msg['To'] = recipient
    msg['Subject'] = subject
    msg.attach(MIMEText(message, 'html'))
    text = msg.as_string()
    server = smtplib.SMTP(smtp_server, smtp_port)
    server.starttls()
    server.login(smtp_username, smtp_password)
    server.sendmail(sender, recipient, text)
    server.quit()
    return 'OK'

send_smtp_email_html_with_attachment(smtp_server, smtp_port, smtp_username, smtp_password, sender, recipient, subject, message, attachment_path)

Send email through SMTP in HTML format with attachment.

Parameters:

Name	Type	Description	Default
smtp_server	str	SMTP server address	required
smtp_port	str	SMTP port	required
smtp_username	str	SMTP username	required
smtp_password	str	SMTP password	required
sender	str	Sender email address	required
recipient	str	Recipient email address	required
subject	str	Email subject	required
message	str	Email message	required
attachment_path	str	Attachment file path	required

Returns:

Name	Type	Description
result	str	Value is 'OK' when successful

Source code in honeydew/notification.py

def send_smtp_email_html_with_attachment(self, smtp_server, smtp_port, smtp_username, smtp_password, sender, recipient, subject, message, attachment_path):
    """
    Send email through SMTP in HTML format with attachment.

    Args:
        smtp_server (str): SMTP server address
        smtp_port (str): SMTP port
        smtp_username (str): SMTP username
        smtp_password (str): SMTP password
        sender (str): Sender email address
        recipient (str): Recipient email address
        subject (str): Email subject
        message (str): Email message
        attachment_path (str): Attachment file path

    Returns:
        result (str): Value is 'OK' when successful
    """
    import smtplib
    from email.mime.multipart import MIMEMultipart
    from email.mime.text import MIMEText
    from email.mime.base import MIMEBase
    from email import encoders

    msg = MIMEMultipart()
    msg['From'] = sender
    msg['To'] = recipient
    msg['Subject'] = subject
    msg.attach(MIMEText(message, 'html'))
    filename = os.path.basename(attachment_path)
    attachment = open(attachment_path, "rb")
    part = MIMEBase('application', 'octet-stream')
    part.set_payload(attachment.read())
    encoders.encode_base64(part)
    part.add_header('Content-Disposition', f"attachment; filename= {filename}")
    msg.attach(part)
    text = msg.as_string()
    server = smtplib.SMTP(smtp_server, smtp_port)
    server.starttls()
    server.login(smtp_username, smtp_password)
    server.sendmail(sender, recipient, text)
    server.quit()
    return 'OK'

send_smtp_email_with_attachment(smtp_server, smtp_port, smtp_username, smtp_password, sender, recipient, subject, message, attachment_path)

Send email through SMTP with attachment.

Parameters:

Name	Type	Description	Default
smtp_server	str	SMTP server address	required
smtp_port	str	SMTP port	required
smtp_username	str	SMTP username	required
smtp_password	str	SMTP password	required
sender	str	Sender email address	required
recipient	str	Recipient email address	required
subject	str	Email subject	required
message	str	Email message	required
attachment_path	str	Attachment file path	required

Returns:

Name	Type	Description
result	str	Value is 'OK' when successful

Source code in honeydew/notification.py

def send_smtp_email_with_attachment(self, smtp_server, smtp_port, smtp_username, smtp_password, sender, recipient, subject, message, attachment_path):
    """
    Send email through SMTP with attachment.

    Args:
        smtp_server (str): SMTP server address
        smtp_port (str): SMTP port
        smtp_username (str): SMTP username
        smtp_password (str): SMTP password
        sender (str): Sender email address
        recipient (str): Recipient email address
        subject (str): Email subject
        message (str): Email message
        attachment_path (str): Attachment file path

    Returns:
        result (str): Value is 'OK' when successful
    """
    import smtplib
    from email.mime.multipart import MIMEMultipart
    from email.mime.text import MIMEText
    from email.mime.base import MIMEBase
    from email import encoders

    msg = MIMEMultipart()
    msg['From'] = sender
    msg['To'] = recipient
    msg['Subject'] = subject
    msg.attach(MIMEText(message, 'plain'))
    filename = os.path.basename(attachment_path)
    attachment = open(attachment_path, "rb")
    part = MIMEBase('application', 'octet-stream')
    part.set_payload(attachment.read())
    encoders.encode_base64(part)
    part.add_header('Content-Disposition', f"attachment; filename= {filename}")
    msg.attach(part)
    text = msg.as_string()
    server = smtplib.SMTP(smtp_server, smtp_port)
    server.starttls()
    server.login(smtp_username, smtp_password)
    server.sendmail(sender, recipient, text)
    server.quit()
    return 'OK'