Overview

SMTP Provider allows you to send emails from Keep. Most of the email services like Gmail, Yahoo, Mailgun, etc. provide SMTP servers to send emails. You can use these SMTP servers to send emails from Keep. The SMTP provider supports both plain text and HTML-formatted emails, allowing you to create rich, styled email notifications.

Authentication

This provider requires authentication.
  • smtp_server: SMTP Server Address (required: True, sensitive: False)
  • smtp_port: SMTP port (required: True, sensitive: False)
  • encryption: SMTP encryption (required: True, sensitive: False)
  • smtp_username: SMTP username (required: False, sensitive: False)
  • smtp_password: SMTP password (required: False, sensitive: True)
Certain scopes may be required to perform specific actions or queries via the provider. Below is a summary of relevant scopes and their use cases:
  • send_email: Send email using SMTP protocol (mandatory)

In workflows

This provider can be used in workflows. As “action” to make changes or update data, example:
actions:
    - name: Query smtp
      provider: smtp
      config: "{{ provider.my_provider_name }}"
      with:
        from_email: {value}
        from_name: {value}
        to_email: {value}
        subject: {value}
        body: {value}
        html: {value}
Check the following workflow examples:

Connecting with SMTP Provider

  1. Obtain the SMTP credentials from your email service provider. Example: Gmail, Yahoo, Mailgun, etc.
  2. Add SMTP Provider in Keep with the obtained credentials.
  3. Connect the SMTP Provider with Keep.

Email Format Support

The SMTP provider supports two email formats:

Plain Text Emails

Use the body parameter to send plain text emails:
with:
  from_email: "[email protected]"
  from_name: "Keep Alerts"
  to_email: "[email protected]"
  subject: "Alert Notification"
  body: "This is a plain text email notification."

HTML Emails

Use the html parameter to send HTML-formatted emails:
with:
  from_email: "[email protected]"
  from_name: "Keep Alerts"
  to_email: "[email protected]"
  subject: "Alert Notification"
  html: "<h1>Alert</h1><p>This is an <strong>HTML</strong> email notification.</p>"
When both body and html are provided, the HTML content takes precedence.

Multiple Recipients

You can send emails to multiple recipients by providing a list of email addresses: