|
How to Use the dsemailService Command Line Utility
Note: This applies to DocuShare 6.6.1 R2, 6.6.1 Update 2, and DocuShare 7.
Note: This information can
also be found in the Xerox DocuShare Command Line Utilities Guide
released July 2016.
Syntax:
dsemailService [option]
The dsemailService command
allows you to configure an SMTP email server. When finished, the command
creates an emailService.properties file. DocuShare then uses the SMTP email
server account information in this new properties file when sending all system
email; bypassing the original email server settings for subscription, workflow,
and Lifecycle Manager.
Option for
dsemailService
Disable This
option copies the emailService.properties file to emailService.bak, and then
deletes the emailService.properties file. After running the command with this
option, DocuShare uses the SMTP email server account information in the
original email server file to send system email.
Using dsemailService
1. Run stop_docushare.
2. Run
either dsemailService.bat in Windows or dsemailService.sh in
Linux/Solaris.
3. At
the prompt, reply Yes that you want to configure an SMTP email server.
4. Using
the table below, enter the appropriate value for each configuration parameter.
SMTP email
server configuration parameters and values table
Parameter Value
|
Parameter
|
Value
|
|
SMTP Port
|
The
address of the SMTP email server.
|
|
SMTP Port
|
The port
number used by the SMTP email server defined in the SMTP Host field.
|
|
SMTP Type
|
Enter 0
for SMTP SSL (The site must be configured to support SSL/TLS)
Enter 1
for SMTP TLS (The site must be configured to support SSL/TLS)
Enter 2
for SMTP (unencrypted connection)
Note: For
instructions on installing an SSL or a TLS certificate, refer to the
DocuShare Print and Email Setup and User Guide; available on the DocuShare
site Help Desk.
|
|
SMTP
Email Account
|
If the
email server requires authentication, enter the account name.
If the
email server does not require authentication, leave this parameter value
blank. Enter one or more spaces to delete the old value.
|
SMTP email Server
configuration parameters and values table
|
Parameter
|
Value
|
|
SMTP
Email Password
|
If the
email server requires authentication, enter the account password for the SMTP
Email Account.
If the
email server does not require authentication, leave this parameter value
blank. Enter one or more spaces to delete the old value.
|
|
SMTP
Email Sender
|
Enter 1
(No) to use the Site Administrator email account as the sender (FROM) for all
email sent by DocuShare.
Enter 0
(Agent) to use the email account defined in the SMTP Email Account field.
|
|
SMTP
Connection
|
Enter a
maximum time, in milliseconds, for sending email messages before the system
times out.
|
|
SMTP
Connection Timeout
|
Enter a
maximum time, in milliseconds, for establishing an SMTP connection before the
system times out.
|
5. At
the prompt, reply Yes to save the changes and update the configuration.
The dsemailService command
tool creates the emailService.properties file.
6. Run start_docushare.
At startup, DocuShare
uses the parameter values in the emailService.properties file for site
email operations.
Solution Published:
August 10, 2016
Solution ID: 1806
| 
