Hexamail Guard Configuration Reference [Routes]

[Routes]

The following settings can be used in this section:

Enable
You can turn off all routing using this switch
bool
On/Off, True/False, Yes/No, 1/0
On
Enable=On
MatchMethod
Routes can be matched in a variety of ways. "All" means that all matching routes will be triggered. This can mean the email is routed for a single recipient to multiple recipients based on each route matched. "Priority" means that the first matching route will be used routes will be checked in order of priority (low to high) "Best" means the most appropriate match will be selected. This means more specific routes will take precedence. e.g. user@domain.com will match even if *@domain.com is another routed recipient.
All
MatchMethod=All
RoutexName
the name by which you wish to call this route
text
RoutexPriority
Each route can havea match priority. The LOWER the priority the sooner it will be checked and the greater precedence it takes if the route matching mode is 'Priority'
text
1
Route%dPriority=1
RoutexEnable
Enable this route
bool
On/Off, True/False, Yes/No, 1/0
on
Route%dEnable=on
RoutexDescription
description of this route
text
RoutexDirections
Check the email directions you wish to match. Inbound means email sent from an external domain to one of your specified domains (see SMTP Server). Outbound is to an external domain from your domain, and relay is from an exteranl domain to another external domain (if this is allowed with your server).
flags
InBound
Route%dDirections=InBound
RoutexOriginalEnable
Also deliver to the original recipient(s) of the email
bool
On/Off, True/False, Yes/No, 1/0
RoutexBCC
New recipients can be added as hidden recipients, equivalent to BCC when sending an email from a mail client. Any removed recipients will still be removed from the To: field unless you have checked the Retain original To information checkbox.
bool
On/Off, True/False, Yes/No, 1/0
RoutexRetainTo
The original MIME To: field will be retained, so that the email looks unmodified, but new recipients may be added as per the rules configured. New recipients are added as BCC recipients and none are removed from the To header field
bool
On/Off, True/False, Yes/No, 1/0
RoutexRecipient
email to these email addresses will be rerouted
text
RoutexSender
email from these email addresses will be rerouted
text
RoutexDefaultDestination
Specify a default routing address to send all email that matches the route (but not necessarily any sub-rules) to this new address. Leave this setting blank to retain the original recipient(s) on the email if no rules are matched. This address can be used to change the address using specific tokens: Use <rcptlocalpart> in the email address to have any local part of the matched original route recipient email address inserted into the new recipient email address. For example if the original recipient was someuser@somedomain.com and you want to route to someuser@newdomain.com you can specify <rcptlocalpart>@newdomain.com as the route destination address Use <rcptdomain> in the email address to have any domain part of the matched original route recipient email address inserted into the new recipient email address. For example if the original recipient was someuser@somedomain.com and you want to route to alert_somedomain.com@myserver.com you can specify alert_<rcptdomain>@myserver.com as the route destination address Use <phonenumber> in the email address to have any phone number from the matched original route recipient email address inserted into the new recipient email address. For example if the original recipient was 123456789fax@somedomain.com and you want to route to fax123456789@faxdomain.com you can specify fax<phonenumber>@faxdomain.com as the route destination address Use <number> in the email address to have any number from the matched original route recipient email address inserted into the new recipient email address. For example if the original recipient was user1234@somedomain.com and you want to route to newuser1234@newdomain.com you can specify newuser<number>@newdomain.com as the route destination address
text
RoutexReturn
Return to sender
bool
On/Off, True/False, Yes/No, 1/0
RoutexMsgId
New Message-Id
bool
On/Off, True/False, Yes/No, 1/0
RoutexForceFrom
Set the From address to this
text
RoutexForceReplyTo
Set the Reply-To address to this
text
RoutexForceTo
Force any email that matches the route to be sent through the specific server
bool
On/Off, True/False, Yes/No, 1/0
RoutexForceServer
email will be sent to this email server if they match this rule
text
RoutexForcePort
email will be sent to this port if they match this rule
text
25
Route%dForcePort=25
RoutexForceSSL
email will be sent using ssl if they match this rule
select
Off, SSL/TLS, STARTTLS, STARTTLS Required
Off
Route%dForceSSL=Off
RoutexRuleyEnable
Enable this rule
bool
On/Off, True/False, Yes/No, 1/0
on
Route%dRule%dEnable=on
RoutexRuleyName
the name by which you wish to call this rule
number
RoutexRuleySubjectMatches
email with subjects that match any of these wildcard/phrase/substring will be routed. Leave blank to match for all emails (equivalent to *)
text
RoutexRuleyContentMatches
The text and html content parts of the email are scanned for the content match expressions. The expressions are substrings and can include the wildcards * ('one or more of any character') and ? ('any single character')
text
RoutexRuleyContentLang
The text and html content parts of the email are scanned for the content language
text
RoutexRuleyLangLines
Use only the first N sentences for language detection. This helps avoid disclaimers and other material that may not be in the language you wish to detect. Set to 0 to use entire text content.
text
0 lines
Route%dRule%dLangLines=0
RoutexRuleyCharset
UTF-8 - 8 bit encoding of ISO-10646 UTF-16LE - 16 bit little endian encoding of ISO-10646 UTF-16BE - 16 bit big endian encoding of ISO-10646 UTF-16 - 16 bit platform native byte order encoding of ISO-10646 ASCII - US 7-bit ASCII, ISO-646 - Windows-1250 - Windows character set for Central European languages Windows-1251 - Windows character set for Cryllic languages Windows-1252 - Windows character set for Western European languages Windows-1253 - Windows character set for Greek Windows-1254 - Windows character set for Turkish Windows-1255 - Windows character set for Hebrew Windows-1256 - Windows character set for Arabic languages Windows-1257 - Windows character set for Baltic rim languages Windows-1258 - Windows character set for Vietnamese Windows-874 - Windows character set for Thai ISO-8859-1 - ISO character set for Western European languages ISO-8859-2 - ISO character set for Central European languages ISO-8859-3 - ISO character set for Esperanto and Maltese ISO-8859-4 - ISO character set for Baltic rim languages ISO-8859-5 - ISO character set for Cryllic languages ISO-8859-6 - ISO character set for Arabic languages ISO-8859-7 - ISO character set for Greek ISO-8859-8 - ISO character set for Hebrew ISO-8859-9 - ISO character set for Turkish ISO-8859-15 - ISO character set for Western European languages KOI8-R - Cryllic character set Shift_JIS - Japanese character set EUC-JP - Japanese character set EUC-KR - Korean character set Big5 - Traditional Chinese character set GB2312 - Simplified Chinese character set GB18030 - Simplified Chinese character set LMBCS - Lotus Multi Byte Character Set
text
RoutexRuleyStartTime
only email sent between the start and end times will be routed
text
Route%dRule%dStartTime=9:00
RoutexRuleyEndTime
only email sent between the start and end times will be routed
text
Route%dRule%dEndTime=17:00
RoutexRuleyStartDate
only email sent between the start and end dates will be routed
text
Route%dRule%dStartDate=12 July 2003
RoutexRuleyEndDate
only email sent between the start and end dates will be routed
text
Route%dRule%dEndDate=27 July 2003
RoutexRuleyMinSize
only email sent between the min and max sizes will be routed
text
0 kbytes
Route%dRule%dMinSize=0
RoutexRuleyMaxSize
only email sent between the min and max sizes will be routed
text
0 kbytes
Route%dRule%dMaxSize=0
RoutexRuleyDateSource
You can use either the date as it appears in the email MIME headers (the Sent date) or the time and date that the email arrived at Hexamail Guard.
text
Headers
Route%dRule%dDateSource=Arrival
RoutexRuleyDays
only email sent on a day that match the selected days will be routed
flag
Sunday+Monday+Tuesday+Wednesday+Thursday+Friday+Saturday
Route%dRule%dDays=Sunday+Saturday
RoutexRuleyFromMatches
email from any of these addresses will be routed. Leave blank to match for all emails (equivalent to *)
text
Route%dRule%dFromMatches=forbidden@example.com
RoutexRuleyIPMatches
email from any of these IP addresses will be routed. Leave blank to match for all email (equivalent to *)
text
Route%dRule%dIPMatches=165.34.*.*
RoutexRuleyCountryMatches
email from any of these country codes will be routed. Leave blank to match for all email (equivalent to *)
text
Route%dRule%dCountryMatches=us,gb
RoutexRuleyAttachMatches
email with these attachment types will be routed. Use * to mean any attachment, leave blank not match on attachments, or specify attachment types like *.pdf
text
Route%dRule%dAttachMatches=*.jpg
RoutexRuleyHeaderMatches
email with these header lines will be routed.
text
Route%dRule%dHeaderMatches=Content-Type: multipart/*,X-Sender: *@gmail.com,X-*: *
RoutexRuleyDestination
Specify a routing address to send all email that matches the route rule to this new address. Leave this setting blank to retain the original recipient(s) on the email. This address can be used to change the address using specific tokens: Use <rcptlocalpart> in the email address to have any local part of the matched original route recipient email address inserted into the new recipient email address. For example if the original recipient was someuser@somedomain.com and you want to route to someuser@newdomain.com you can specify <rcptlocalpart>@newdomain.com as the route destination address Use <rcptdomain> in the email address to have any domain part of the matched original route recipient email address inserted into the new recipient email address. For example if the original recipient was someuser@somedomain.com and you want to route to alert_somedomain.com@myserver.com you can specify alert_<rcptdomain>@myserver.com as the route destination address Use <phonenumber> in the email address to have any phone number from the matched original route recipient email address inserted into the new recipient email address. For example if the original recipient was 123456789fax@somedomain.com and you want to route to fax123456789@faxdomain.com you can specify fax<phonenumber>@faxdomain.com as the route destination address Use <number> in the email address to have any number from the matched original route recipient email address inserted into the new recipient email address. For example if the original recipient was user1234@somedomain.com and you want to route to newuser1234@newdomain.com you can specify newuser<number>@newdomain.com as the route destination address
number
RoutexRuleyReturnToSender
email matching this rule will be returned to the sender
number
false
Route%dRule%dReturnToSender=false
RoutexRuleyExtractRcpt
This option will attempt to extract the new recipient from the subject or content of the email
text
RoutexRuleyExtractCount
You can extract and use one or more recipients from the email. The delimiters will be used to find all email addresses between delimiters or multiple email addresses in multiple occurrances of the delimiters
number
1 - 256
RoutexRuleyExtractStart
The email address is extracted from between delimiters if specified. If not the first valid email address will be used.
text
Route%dRule%dExtractStart=Email address:
RoutexRuleyExtractEnd
The email address is extracted from between delimiters if specified. If not the first valid email address will be used.
text
Route%dRule%dExtractEnd=Next Field:
RoutexRuleyForceTo
Force sending through
bool
On/Off, True/False, Yes/No, 1/0
RoutexRuleyForceServer
email will be sent to this email server if they match this rule
text
RoutexRuleyForcePort
email will be sent to this email server if they match this rule
text
25
Route%dRule%dForcePort=25
RoutexRuleyForceSSL
email will be sent to this email server if they match this rule
text
Off
Route%dRule%dForceSSL=Off
RoutexRuleySubjectTag
Use this setting to have email tagged by subject if an email matches the rule, for example you can set this setting to [Some Tag]: <subject> to make the email with a subject 'Sales enquiry' get tagged to [Some Tag]: Sales Enquiry Similarly <rcpt> is replaced with the recipient address and <to> is replaced with the displayed recipient To address and <sndr> is replaced with the SMTP sender address (different from the displayed From address in some cases!)
text
Route%dRule%dSubjectTag=[RULE TAG STRING]: <subject>
RoutexRuleyContentTagPos
Use this setting to have email content tagged if it matches the rule, for example you can set this setting to [Some Tag] to make the email have the tag appended to the text and HTML content parts on a new line. If you wish the tag to be invisible in the HTML part use angle braces around the tag thus <exampletag> You can also replace the content completely using the Replace option
Append
Route%dRule%dContentTagPos=Append
RoutexRuleyContentTag
Use this setting to have email content tagged if it matches the rule, for example you can set this setting to [Some Tag] to make the email have the tag appended to the text and HTML content parts on a new line. If you wish the tag to be invisible in the HTML part use angle braces around the tag thus <exampletag>
text
Route%dRule%dContentTag=[RULE TAG STRING]
RoutexRuleyContentTagHTML
Use this setting to have email content tagged if it matches the rule, for example you can set this setting to [Some Tag] to make the email have the tag appended to the text and HTML content parts on a new line. If you wish the tag to be invisible in the HTML part use angle braces around the tag thus <exampletag> You can inject fields from the original email using the tags <subject>, <date>, <datetime>, <sentdate>, <sentdatetime>, <ip>, <senderip>, <from>, <fromdisplay>, <recipient>, <product>, <domain>, <company>, <producturl>, <productname>
text
Route%dRule%dContentTagHTML=<p>A piece of html to tag with</p>
RoutexRuleyHeaderTagAction
Use this setting to have an extra MIME header inserted into the email. If an email matches the rule, you can insert a custom header, e.g. specify "X-MyTagHeader: TagValue" for this setting to insert the MIME header X-MyTagHeader with the value TagValue. You should only specify MIME compliant header strings for this setting, otherwise the MIME of the email may no longer be MIME compliant and messages transfer agents further down the line may report errors or warnings. The MIME standard can be found online as W3C RFC number 822 and 2822
text
Replace
Route%dRule%dHeaderTagAction=Add
RoutexRuleyHeaderTag
Use this setting to have an extra MIME header inserted into the email. If an email matches the rule, you can insert a custom header, e.g. specify "X-MyTagHeader: TagValue" for this setting to insert the MIME header X-MyTagHeader with the value TagValue. You should only specify MIME compliant header strings for this setting, otherwise the MIME of the email may no longer be MIME compliant and messages transfer agents further down the line may report errors or warnings. The MIME standard can be found online as W3C RFC number 822 and 2822
text
Route%dRule%dHeaderTag=X-MyHeaderName:
RoutexRuleyHeaderTagValue
Use this setting to have an extra MIME header inserted into the email. If an email matches the rule, you can insert a custom header, e.g. specify "X-MyTagHeader: TagValue" for this setting to insert the MIME header X-MyTagHeader with the value TagValue. You should only specify MIME compliant header strings for this setting, otherwise the MIME of the email may no longer be MIME compliant and messages transfer agents further down the line may report errors or warnings. The MIME standard can be found online as W3C RFC number 822 and 2822
text
Route%dRule%dHeaderTagValue=myheadervalue
LanguageStoplist
Stoplist to use before performing language matching on the text content. This can be used to filter any known words out of the email content that may cause the language match to underperform or fail. For example if you are language matching website forms then use this setting to remove the form field names if they may be in the text content of the email.
text
LanguageStoplist=Title,First,Last,Phone,Fax,Company,Country,Email,Message,Website,Terms,Conditions
LanguageByCharset
Where languages can be determined from the character set alone this information is used from an email header to determine the language with no Bayesian pattern recognition required. If you wish to turn this feature off and force a full language detection remove the languages from the default list. The default list is jp,ch,tr,ru
jp,ch,tr,ru
LanguageByCharset=jp,ch,tr,ru
LanguageEnable
bool
On/Off, True/False, Yes/No, 1/0
LanguageRouteFor
text
LanguageCZEnable
bool
On/Off, True/False, Yes/No, 1/0
LanguageCZRouteTo
text
LanguageDEEnable
bool
On/Off, True/False, Yes/No, 1/0
LanguageDERouteTo
text
LanguageDKEnable
bool
On/Off, True/False, Yes/No, 1/0
LanguageDKRouteTo
text
LanguageESEnable
bool
On/Off, True/False, Yes/No, 1/0
LanguageESRouteTo
text
LanguageFREnable
bool
On/Off, True/False, Yes/No, 1/0
LanguageFRRouteTo
text
LanguageFIEnable
bool
On/Off, True/False, Yes/No, 1/0
LanguageFIRouteTo
text
LanguageGBEnable
bool
On/Off, True/False, Yes/No, 1/0
LanguageGBRouteTo
text
LanguageHUEnable
bool
On/Off, True/False, Yes/No, 1/0
LanguageHURouteTo
text
LanguageISEnable
bool
On/Off, True/False, Yes/No, 1/0
LanguageISRouteTo
text
LanguageITEnable
bool
On/Off, True/False, Yes/No, 1/0
LanguageITRouteTo
text
LanguageNLEnable
bool
On/Off, True/False, Yes/No, 1/0
LanguageNLRouteTo
text
LanguageNOEnable
bool
On/Off, True/False, Yes/No, 1/0
LanguageNORouteTo
text
LanguageSEEnable
bool
On/Off, True/False, Yes/No, 1/0
LanguageSERouteTo
text
LanguagePLEnable
bool
On/Off, True/False, Yes/No, 1/0
LanguagePLRouteTo
text
LanguagePREnable
bool
On/Off, True/False, Yes/No, 1/0
LanguagePRRouteTo
text
LanguageUnmatchedEnable
bool
On/Off, True/False, Yes/No, 1/0
LanguageUnmatchedRouteTo
text