Setup smtp credentials
Configuring an SMTP account is essential for on-premises Txture instances to enable email functionalities. SaaS instances provided by Txture come with pre-configured credentials, which can be customized upon request.
Emails are used for:
- Notifications about changes
- Surveys
- User invites
Without configured SMTP credentials, new users must be set up with a username and a pre-configured password, as invitation emails cannot be sent.
There are two ways to configure your SMTP credentials:
- Via the GUI (Recommended)
-
Via the
txture.propertiesfile
Before you begin, please collect the necessary SMTP information from your email provider.
1. Configuration via the GUI
This is the easiest way to set up your email configuration.
- Navigate to Settings > Configuration.
- Scroll down to the E-Mail Sender section.
- Fill in the following fields with the information from your
provider:
- Mail Server Host Address
- Mail Server Password
- Mail Server Port
- Mail Protocol
- Mail Sender Address
- SMTP: Use Authorization
- SMTP: Connection Timeout
- SMTP: Start TLS
- SMTP: Send Timeout
- Mail Sender Username
If you find that you cannot edit these fields, it is because
they are currently configured in the txture.properties
file.
To enable editing through the GUI, you must modify the
txture.properties file. This is done by setting the
corresponding keys but leaving their values empty.
SaaS Instances For SaaS instances, please contact our support team to have these fields enabled for you.
2. Configuration via
txture.properties
You can also configure the SMTP settings directly in the
txture.properties file. Adjust or add the following
properties to the file:
# -------------------------------------------------------------------------------------------------
# EMAIL PROPERTIES
# These properties control the settings for email delivery. Emails are used for surveys and
# welcome emails.
# -------------------------------------------------------------------------------------------------
txture.mail.sender.protocol=smtp
txture.mail.sender.host=YOURSMTPHOST
txture.mail.sender.port=587
# defines whether a username/password authentication will be used
txture.mail.sender.smtp.auth=true
txture.mail.sender.username=USER
txture.mail.sender.password=PASSWORD
# defines whether TLS encryption will be attempted
txture.mail.sender.smtp.starttls.enable=true
txture.mail.sender.address=your-email@example.com
Settings with the txture.mail.sender. prefix are
used to configure an SMTP account and/or server that is used by
Txture to send out emails.
Instance Restart Required After modifying the
txture.properties file, you must restart your Txture
instance for the SMTP settings to take effect.
Redirect URL from emails To send user invites or surveys
from your Txture instance, you must also set the correct
txture.server.url in the
Public Properties section of the txture.properties
file to ensure users are properly redirected to your Txture
instance.