CentraSite Documentation : CentraSite Administrator’s Guide : Basic Operations : Configuring the Email Server : Configuring the Email Server Settings
Configuring the Email Server Settings
Use the following procedure to specify the email server settings for CentraSite. To perform this procedure, you must know the name (or IP address) of the email server that CentraSite is to use and the port number on which that server listens for SMTP requests. If the email server is configured to authenticate users, you must additionally provide the user ID and password that CentraSite is to use to log on to the server.
You can configure the email server settings by executing the following commands in the command line interface CentraSiteCommand.cmd (Windows) or CentraSiteCommand.sh (UNIX) of CentraSite. The command line tool is located in the directory <CentraSiteInstallDir>/utilities.
If you start this command line tool with no parameters, you receive a help text summarizing the required input parameters.
The parameters of the command are case-sensitive, so for example the parameter -url must be specified as shown and not as -URL.
To configure the email server settings
1. Create an XML configuration file that contains the following predefined properties. This file should be in Java XML properties format. For example:
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties version="1.0">
<entry key="com.centrasite.config.email.SMTPHost">
localhost</entry>
<entry key="com.centrasite.config.email.SMTPPort">
25</entry>
<entry key="com.centrasite.config.email.ReplyTo">
noreply@editthisdomain.com</entry>
<entry key="com.centrasite.config.email.ConnectionTimeout">20</entry>
<entry key="com.centrasite.config.email.Authentication">false</entry>
<entry key="com.centrasite.config.email.User">xyz</entry>
<entry key="com.centrasite.config.email.Password">xyz</entry>
<entry key="com.centrasite.config.email.TransportLayerSecurity">
false</entry>
</properties>
Descriptions of these properties are as follows:
In this field...
Specify...
SMTPHost
The name or IP address of the machine on which the SMTP server is running.
SMTPPort
The port on which the machine specified in SMTP Host listens for SMTP requests.
ReplyTo
The email address to which responses to the emails sent by CentraSite are to be directed.
CentraSite uses this address to populate the "From" email header in the emails that it sends.
ConnectionTimeout
The number of seconds that CentraSite will wait for the email server to accept a connection request.
If the email server does not respond within the specified time period, CentraSite writes an error message to the console and discards the email.
Authentication
Whether the SMTP server authenticates users. Set Authentication to yes if authentication is enabled on the SMTP server.
If you set this field to yes, you must specify the appropriate log-on credentials in the User and Password fields below.
User
The user ID that CentraSite is to use to log on to the SMTP server.
This value is required only when Authentication is set to yes.
Password
The password that CentraSite is to use when it logs on to the SMTP server.
This value is required only when Authentication is set to yes.
TransportLayerSecurity
If true, enables the use of the STARTTLS command (if supported by the server) to switch the connection to a TLS-protected connection before issuing any login commands. Note that an appropriate trust store must configured so that the client will trust the server's certificate. Defaults to false.
2. Use the set Email command to configure the email settings for CentraSite.
The syntax for the command is:
C:\SoftwareAG\CentraSite\utilities>CentraSiteCommand.cmd set Email [-url <CENTRASITE-URL>] -user <USER-ID> -password <PASSWORD> -file <CONFIG-FILE>
The input parameters are:
Parameter
Description
-url
(Optional) The URL of the CentraSite registry. Default value is http://localhost:53307.
-user
The user ID of a registered CentraSite user. For example, a user who has the CentraSite Administrator role.
-password
The password for the registered CentraSite user identified by the parameter -user.
-file
The absolute or relative path to the XML configuration file. If relative, the path should be relative to the location from where the command is executed.
Example:
C:\SoftwareAG\CentraSite\utilities>CentraSiteCommand.cmd set Email -url http://localhost:53307/CentraSite/CentraSite -user Administrator -password manage -file config.xml
The response to this command could be:
Executing the command : set Email
Successfully executed the command : set Email
Copyright © 2005-2016 Software AG, Darmstadt, Germany.

Product LogoContact Support   |   Community   |   Feedback