SMTP and Email Delivery

Bytebase uses an SMTP server of your choosing to send emails for slow query weekly report.

Configuring Bytebase to send email via Amazon AWS/SES

To use Amazon SES with Bytebase, first follow these steps to creating and verifying identities. Then, use AWS Access Management(IAM) to create an SMTP credential. Once you have an SMTP account, simply navigate to Setting->Integrations->Mail Delivery and fill in the configuration likes below:

_

Configuring Bytebase to send email using another provider

Other providers such as Sendgrid may also be used with Bytebase. Any valid SMTP server account should do. Once you have an SMTP account, simply navigate to Setting->Integrations->Mail Delivery and fill in the following fields:

  • SMTP Server Host: The host of your SMTP Server.
  • SMTP Server Port: The port of your SMTP Server. It is usually one of 22, 465 and 587.
  • From: The sender address of all Bytebase mails.
  • Authentication Method: Bytebase supports NONE, PLAIN, LOGIN, CRAM-MD5 and PLAIN is the most common.
  • SMTP Username/SMTP Password: They are available if the authentication method is PLAIN/LOGIN/CRAM-MD5.
  • Encryption: Bytebase supports NONE, SSL/TLS and STARTTLS. This can usually be determined by port. Port 22 generally uses NONE, port 465 generally uses SSL/TLS, and port 587 generally uses STARTTLS.
  • Send Test Email To: Fill in the receiving email address and click Send. A test email will be sent using your SMTP configuration, which will help you verify your SMTP configuration.

Sending a test email

To verify email sending is working correctly, fill in the Send Test Email To field and click Send button, Bytebase will send a test email using your SMTP configuration. If everything is correct, you will receive a mail like:

_

Edit this page on GitHub

Subscribe toย Newsletter

By subscribing, you agree with Bytebase's Terms of Service and Privacy Policy.