Before sending a report or dashboard via email or scheduling reports and/or dashboards to be emailed, it is necessary to configure the email ID from which these emails will be sent.
In order to do this, open the mailConfiguration.properties file present at
.. \hi\hi-repository\System\Mail\
You will see the following:
Provide the details of your email server and email authentication details.
Use ‘true’ and ‘false’ instead of ‘yes’ and ‘no’ to set isAuthenticated and isSSLEnabled variables.Below is an example for gmail configuration
# This configuration file is used to send e-mails with attachments # The address of the SMTP server. hostName=smtp.gmail.com # The connection port. 587 is standard for STARTTLS (secure). 465 is for Implicit SSL. port=465 # The default "Sender" email address that will appear in the "From" field of the recipient's inbox. from= dummy.helical@gmail.com # When true, the server requires a username and password to send mail. Gmail always requires this. isAuthenticated=true # When true, it uses Implicit SSL (usually port 465). Since you are using port 587, this should be false (STARTTLS is handled by ttlsEnabled instead). isSSLEnabled=true # The email account used to log in user= dummy.helical@gmail.com # The password or App Password for the user. (For Gmail, a 16-character App Password is required). password= helical subject=Report Name: body=NOTICE: This email is generated by Helical Insight Application. This email and any attachments may contain confidential and proprietary information and is for the sole use of the intended recipient for the stated purpose. If you are not the intended recipient, please notify the sender. # The transport protocol. Usually smtp or smtps mailProtocol=smtps # When true, prints the full SMTP "handshake" to the console debug=false # Specifies the specific security protocol. TLSv1.2 or TLSv1.3 are recommended for modern security. sslProtocols=TLSv1.2 # Enables the STARTTLS command. This upgrades an insecure connection to a secure one on port 587. ttlsEnabled=true # If true, the mail will fail to send if the server doesn't support a secure TLS connection. ttlsRequired=true # If true, the socket is kept open between transmissions to improve performance. keepAlive=true # If true, the application waits for the server to acknowledge the QUIT command before closing the socket. quitWait=false #poolConfig # The minimum number of connections to keep alive in the pool at all times, even if no one is sending mail. minIdle=5 # The maximum number of connections that can sit unused in the pool. Excess connections are closed. maxIdle=10 # The absolute limit of simultaneous connections. If this is 25, the 26th connection trying to send a mail must wait. maxTotal=25 # How long (in milliseconds) a thread will wait for a connection to become available before throwing an error (e.g., 10 seconds). maxWaitMillis=10000 # The minimum time a connection can sit idle before it becomes "eligible" for being closed and removed from the pool. minEvictableIdleTimeMillis=5 # How often the "cleaner" thread runs to scan for idle connections that need to be closed (e.g., every 10 seconds). timeBetweenEvictionRunsMillis=10000 # If true, the pool "pings" the SMTP server before giving a connection. Highly recommended to prevent "Stale Connection" errors. setTestOnBorrow=true
Note:
- Give the correct details in the above configuration according to your respective mail server.
- Certain email servers like Gmail, Microsoft , Zoho Mail etc use enhanced security. You must generate an App Password and use it instead of your regular account password when configuring SMTP settings. Refer to the official documentation for each provider for instructions on how to generate an App Password.
- If you are using an older version of Helical Insight i.e. older than 6.2, your mailConfiguration.properties might have lesser configurations.
In case if you have any queries please get us at support@helicalinsight.com
