Skip to main content
Skip table of contents

Email Integration

Overview

Email Integration provides the following key features:

  • Password Reset Email: Sends an email for user password reset.

  • Two-Factor Authentication Code: Provides an additional security step by sending a verification code via email during user login.

  • Event Notifications: Sends email alerts to administrators based on event triggers defined by alert rules.

To send emails, an SMTP server is required, and QueryPie provides integration options for configuring the SMTP server.

Email Integration Configuration

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

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

  3. On the detailed page, click the Configure button to open a popup where you can enter the SMTP information.

    image-20241218-163108.png

    Email Integration Detailed Page

  4. To create SMTP settings, enter the following information:

    1. Email Server Name: Enter a custom name for easy identification.

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

    3. Secure: Choose the encryption method. You can select either TLS or STARTTLS. The default is TLS. STARTTLS will use plain text if the SMTP server cannot support TLS.

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

    5. Timeout (milliseconds): Enter the threshold for waiting for SMTP responses. The default value is 60,000. It's recommended not to modify this unless absolutely necessary.

    6. Sender Email Address: Enter the email address of the sender.

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

    8. Support Email Address (Reply-to): All emails sent from QueryPie via SMTP will be sender-only emails. Since the sender email address does not receive replies, provide an email address for the recipient to contact for technical support when necessary. As of version 10.2.2, the support email address specified here will be used for the password reset email template and the two-factor authentication code email template.

    9. SMTP Server Requires Authentication: Select On or Off based on whether authentication is required to connect to the SMTP server and send emails. If On, enter the User and Password.

      1. User: Enter the user for authentication, typically in the form of an email address.

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

    10. Test Button: Click the Test button to check if the SMTP settings are correctly configured and can connect successfully.

      image-20241218-163449.png

      SMTP Settings Popup Dialog

  5. Click the OK button to save the settings.

Modifying Email Integration Settings

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

  2. Click the Email tile to navigate to the detail page.

  3. On the detail page, click the Edit button for the SMTP settings displayed under Email sender.

    image-20241219-011621.png

    Email Sender

  4. Make the necessary changes and save the settings.

Verifying Email Sending History

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

  2. Click the Email tile to navigate to the detailed page.

  3. Review the Sent Email History list.
    The email sending history stored in this list is retained for 30 days, and entries older than 30 days are 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 detailed page.

  3. In the detailed page, click the Delete button for the SMTP settings displayed under Email sender.
    If there are any configurations, such as Alerts or MFA, using the SMTP settings, deletion will not be possible. You must first delete all related settings before the SMTP configuration can be deleted.

    image-20241219-011621.png

    Email Sender

Sending User Password Reset Email

To send a password reset email for users to reset their own password, Email Integration settings must be configured first.

Please refer to the following information on how to allow users to reset their own password via email.

Using Email as a Two-Factor Authentication Method

Starting from QueryPie 10.2.2, Email can be used as a two-factor authentication (2FA) method alongside Google OTP. Before enabling this feature, you must configure the Email Integration settings.

Refer to the instructions below to learn how to use Email as a two-factor authentication (2FA) method.

JavaScript errors detected

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

If this problem persists, please contact our support.