Skip to main content
Skip table of contents

Email Integration

Overview

Email integration in QueryPie supports the following key functionalities:

  • Sending Password Reset Emails: Allows users to receive emails to reset their passwords.

  • Sending 2nd Factor Authentication Codes: Provides an additional security step via email for user logins.

  • Event Notifications: Sends email notifications to administrators for events triggered by Alert rules.

An SMTP server is required to send emails, and QueryPie provides a method to integrate with your SMTP server.

Email Integration Configuration

  1. Navigate to the Administrator > General > System > Integrations menu.

  2. Click the Email tile to go to the details page.

  3. Click the Configure button on the details page. A pop-up window will appear where you can enter SMTP information.

    image-20241218-163108.png

    Email Integration detail page

  4. Enter the following information to create your SMTP configuration:

    1. Email Server Name: Enter a unique name for easy identification of this configuration.

    2. Host: Enter the hostname (FQDN) of your SMTP server.

    3. Secure: Select the encryption method for transmission. You can choose between TLS or STARTTLS. The default is TLS.

      If STARTTLS is selected and the SMTP server does not support TLS, the connection will attempt to use plaintext.

    4. Port: Enter the port number used by your SMTP server.

    5. Timeout (milliseconds): Enter the threshold for waiting for an SMTP server response. The default is 60000 milliseconds. It is recommended not to change this value unless necessary.

    6. Sender Email Address: Enter the email address that will appear as the sender.

    7. Sender Name: Enter the name that will be displayed as the sender.

    8. Support Email Address (Reply-to): Emails sent from QueryPie via the SMTP server are typically send-only. The "Sender Email Address" might be a no-reply address. Provide a support email address here if you want users to be able to reply for technical support.

      As of version 10.2.2, the password reset email template and the 2nd-factor authentication code email template use the support email address specified here.

    9. SMTP Server Requires Authentication switch: Set to On or Off depending on whether your SMTP server requires authentication for sending emails. If set to On, you must enter the User and Password.

      1. User: Enter the username for authentication (typically an email address).

      2. Password: Enter the password for the authentication account.

    10. Test button: Click this to verify that the SMTP settings can successfully connect to your server.

      image-20241218-163449.png

      SMTP Configuration Pop-up

  5. Click the OK button to save the configuration.

Editing Email Integration Settings

  1. Navigate to the Administrator > General > System > Integrations menu.

  2. Click the Email tile to go to the details page.

  3. For the SMTP configuration displayed under "Email sender" on the details page, click the Edit button.

    image-20241219-011621.png

    Email Sender

  4. Modify the necessary information and save the changes.

Checking Email Sending History

  1. Navigate to the Administrator > General > System > Integrations menu.

  2. Click the Email tile to go to the details page.

  3. View the Sent Email History list.

    The email sending history stored in this list is retained for 30 days. Records older than 30 days are automatically deleted.

image-20241219-005544.png

Sent Email History

Deleting Email Integration Settings

  1. Navigate to the Administrator > General > System > Integrations menu.

  2. Click the Email tile to go to the details page.

  3. For the SMTP configuration displayed under "Email sender" on the details page, click the Delete button.

    You cannot delete an SMTP configuration if it is currently being used by other QueryPie settings, such as Alerts or MFA. You must first remove or reconfigure all dependent settings before you can delete the Email Integration setup.

    image-20241219-011621.png

    Email Sender

Sending User Password Reset Emails

Email Integration must be configured before you can send password reset emails that allow users to reset their own passwords.

Refer to the following resources for methods on how users can reset their passwords via email:

Using Email as a Secondary Authentication Method

Starting with QueryPie 10.2.2, Email can be used as a secondary authentication method alongside Google OTP. Email Integration must be configured first.

For instructions on using Email as a secondary authentication method, please refer to the following document:

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.