Manual edit of configuration file - settings.xml

In settings.xml file are stored all application settings. File is located in /etc/msh-autoresponder directory.

Example of settings.xml file.

<!-- ********************************************************************************************* --> <!-- * After manual edit run /opt/msh-autoresponder/validate.sh script to validate config file. * --> <!-- * If everything is OK, then restart msh-ar-settings-service to apply changes. * --> <!-- ********************************************************************************************* --> <msh-autoresponder> <config> <milter-logs count="2" size="500"/> <settings-logs count="2" size="500"/> <messages-logs enable="yes" count="100"/> </config> <ldap-conf enable="yes"> <serverName value="sacramento.post.cal"/> <encryption value="LDAP"/> <port value="389"/> <baseDN value="dc=sacramento, dc=post, dc=cal"/> <anonConnection enable="no"/> <adminDN value="cn=admin, dc=sacramento, dc=post"/> <password value="secretpassword"/> </ldap-conf> <ruleset> <rule active="no" id="547CC0D32F3A46B6A6A48FBC053ADB0B" name="Out of Office: John Doe"> <message subject="Auto: $SUBJECT"> <from defaultAlways="no" defaultEmail="" singleEmail="" singleResponse="no"/> <body>Thank you for your message.\n\nI am currently out of office, with no e-mail access.</body> <headers> <header name="Auto-Submitted" value="auto-replied"/> </headers> </message> <conditions type="all"> <sender email="jane.smith@example.com"/> <recipient email="john.doe@example.com" search="TO,CC"/> <header name="X-Some-Header"> <have/> </header> <header name="X-Spam"> <haveValue value="no"/> </header> </conditions> <exceptions type="any"> <header name="Auto-Submitted"> <withoutValue value="no"/> </header> </exceptions> <time-range active="no" from="08/02/2012" to="08/03/2012" allday="no" hfrom="16:00" hto="23:59" pattern="saturday,sunday"/> <loop active="yes" max="10" interval="1" per="hour"/> <next isApplied="no" isNotApplied="yes"/> <forward active="no" subject="FW: $SUBJECT" to=""/> </rule> </ruleset> <access-control enabled="yes"> <user login="john" password="pR3afH/1C2Hq6gRENx9KapMB5QE="> <element id="c52b5fed-ccab-4c5b-9860-63b5ca822534" type="Available"> <rule id="547CC0D32F3A46B6A6A48FBC053ADB0B" type="Read Only"> </user> </access-control> </msh-autoresponder>

<milter-logs>

These logs are located in /var/log/msh-autoresponder directory.

count

Number of log files which will be created. These logs are rotating, so when they exceed specified limit application will remove oldest file. File names are created in milter-XXXXX.log format.

Minumum count of files is one. These logs cannot be turned off.

Default: 2

size

Size in kilobytes (kB) of each log file. If specified size is exceeded new file is created.

Default: 500 kB

<settings-logs>

These logs are located in /var/log/msh-autoresponder directory.

count

Number of log files which will be created. These logs are rotating, so when they exceed specified limit application will remove oldest file. File names are created in settings-service-XXXXX.log format.

Minumum count of files is one. These logs cannot be turned off.

Default: 2

size

Size in kilobytes (kB) of each log file. If specified size is exceeded new file is created.

Default: 500 kB

<messages-logs>

Those logs are located in /var/log/msh-autoresponder directory. File name of each log is created in TIME STAMP+TYPE+PROCESSING TIME+HANDLER STATUS+MESSAGE ID+QUEUE ID.xml format.

Each message which is going through MTA is logged in separate XML log file. These logs can be turned off.

enable

yes creating of logs is turned on.
no turned off.

Default: yes

count

Number of log files which will be created. Minumum count of files is one. Logs are rotating, so when they exceed specified limit application will remove oldest one.

Default: 100

ldap-conf

enable

yesvariables inserted in auto reply body will be replaced with values from LDAP
noLDAP will not be used. Variables inserted in auto reply body will be replaced with empty values

serverName

value

Server name with LDAP service.

encryption

Encryption type of connection with LDAP server.

value

LDAP
TLS
SSL

port

value

TCP port which will be used.

baseDN

value

Top level of the LDAP directory tree.

anonConnection

enable

yesanonymous connection is enabled
nocredentials defined in adminDN and password attributes will be used

adminDN

value

A directory administrator's DN. The admin must be able to perform searches.

password

value

The password of the directory administrator.

ruleset

Unlimited set of rules. Order of rules is important, rules are executed from top to bottom.

rule

active

yesrule will be used in processing
norule will be skipped

id

Unique rule identifier. This identifier will be used in credentials set.

name

Human friendly rule name.

message

subject

Auto reply subject. You can use $SUBJECT variable to replace with original message subject.

from

defaultAlways

yesan auto reply will be always sent from e-mail address defined in defaultEmail attribute
noan auto reply will be sent from e-mail address to which original message was sent

defaultEmail

This e-mail address which will be used in an auto reply From field when attribute defaultAlways is set.

singleEmail

If singleResponse attribute is set, then value from this attribute will be used for an auto reply From field.

singleResponse

yessend always only one auto reply
nosend as many auto replies as was applied by rule conditions

body

Defines the auto reply message body. Message body is in plain text format. New line character is represented as \n.

If LDAP is configured you can use these variables to personalise auto reply:

$SUBJECTwill be replaced with original message subject
$CITY
$EMAIL
$FAX
$FIRSTNAME
$LASTNAME
$MOBILE
$ORGANISATION
$PHONE
$POSTALCODE
$STATE
$STREET

headers

Collection of custom MIME headers which are placed in an auto reply message.

header

name

Name of custom MIME header.

value

Value of custom MIME header.

conditions

Collection of requirements to match. Order is significant, conditions will be matched from top to bottom.

type

allto send auto reply ALL conditions must be met (and no exceptions).
anyto send auto reply ANY condition must be met (and no exceptions).

sender

email

E-mail address of message sender. In this requirement asterisk (*) can be used, which mean matching zero or more characters.

recipient

email

E-mail address of message recipients. In this requirement asterisk (*) can be used, which mean matching zero or more characters. If message has more than one recipient, requirement will try to match any of them.

search

Specifies in which field recipient e-mail address will be searched.

TOonly in TO field
CConly in CC field
BCConly in BCC field
TO,CCin TO and CC field
TO,BCCin TO and BCC field
TO,CC,BCCin all fields TO, CC and BCC
CC,BCCin CC and BCC field

header

name

Name of the MIME header.

type of header value

Specifies how to match header.

In <haveValue> and <withoutValue> asterisk (*) can be used, which mean matching zero or more characters in header value.

<have/>requirement is match when message have defined header
<notHave/>requirement is match when message do not have defined header
<haveValue value="VAL"/>requirement is match when message have defined header with specified value
<withoutValue value="VAL"/>requirement is match when message have defined header but with other value than specified

exceptions

Collection of rule exceptions. When exceptions are met then auto reply is not send.

In exceptions can be used all requirements which are described in conditions section.

time-range

Specifies time options in which rule will be active.

active

yesglobal time range in which rule will be active
noglobal time range is not active

from

Date from which the rule will be active. Date format MM/dd/yyyy, month/day/year.

to

Date to which the rule will be active. Date format MM/dd/yyyy, month/day/year.

allday

If selected rule will be active all day.

yesall day is active. If selected hfrom and hto are NOT used.
noall day is not active. If selected hfrom and hto are used.

hfrom

Hour from which rule will be active. Format HH:mm.

hto

Hour to which rule will be active. Format HH:mm.

pattern

Pattern in which rule will be active or not.

Available options:

nopattern is not active
sunday,monday,tuesday,
wednesday,thursday,
friday,saturday
days of the week which are separated by comma. Here can be used only one day or any of combination.

loop

Specifies protection which protect against loops between servers.

active

yesprotection is active
noprotection is not active

max

Maximum number of auto replies sent to each recipient whichin specified interval.

interval

Interval in which measure.

per

Unit of interval.

minute
hour
day
week

next

Specifies what to do when current rule is applied or not.

isApplied

yesif current rule is applied then go to the next rule
noif current rule is applied stop processing more rules

isNotApplied

yesif current rule is not applied then go to the next rule
noif current rule is not applied then stop processing more rules

forward

Specifies the forward action of original message when rule is applied.

active

yesforward action is active
noforward action is not active

subject

Forwarded message subject. In this field can be used $SUBJECT variable, which will be replaced with original message subject.

to

E-mail address to which sent forward message.

access-control

Specifies restrictions for users which are using Admin tool to connect with server. If Admin tool is not used in configuration then access control can be swithed off.

enabled

yesaccess control is active
noaccess control is not active and any user can connect to server

user

login

Login name for user which will be connecting to server.

password

User password. For security reasons in settings file password is not stored in plain text. "Encrypted" password can only be created using Admin tool.

element

Element of MSH Autoresponder Admin user interface for which access can be restricted.

id

07d87cb9-0064-4842-a308-36b811af9029Tree Node: Autoresponder Rules
0c4b5f26-78be-4b37-bb45-7d7124db54cdTree Node: Access Control
45617eba-b1fc-4549-9027-2664ddb34629Tree Node: Events
e99ec1fc-f211-48dc-9e89-12ffdc189267Tree Node: License
25fbeb5b-f037-4590-a025-546065382cd7Tree Node: LDAP Directory Service
c52b5fed-ccab-4c5b-9860-63b5ca822534Rules: Add new or clone rule
6a5126da-0368-4685-9d9e-b00d05d7375bRules: Edit rules
28bac03f-3950-4576-9cf8-8a4b5f6beee9Rules: Remove rules
0ff11507-9fb2-4e2d-a99b-06feccfb14cdRules: Forward option in rule wizard
4017a64a-376c-491d-abe3-18aefb04678dRules: Copy rules and settings to/from this server

type

Availableelement will be available in read/write mode
Read Onlyelement will be visible only in read mode
Not Availableelement will be completely hidden and not available for user

rule

List of defined rules for which access can be restricted.

id

Unique identifier of defined rule.

type

Availablerule will be available in read/write mode
Read Onlyrule will be visible only in read mode
Not Availablerule will be completely hidden and not available for user