When an address is parsed and its domain part is extracted,
the Router checks the routing records in the Routing Table.
Open the Router page in the Settings section of the WebAdmin Interface to manage
the Routing Table:
fax.stalker.com = stalker.com ; -> to the same domain
hq.stalker.com = newhq.stalker.com ; -> to some other server
Relay:*.test.com = stalker.com ; aaa.test.com, bbb.test.com
; just a comment line
<sales> = john ; simple alias
<sales@client1.com> = sales-client1 ; simple foreign alias
<info@client1.com> = info@otherhost.com; account -> other account
<*@client2.com> = *.cl2 ; sales@.. -> sales.cl2
test.com = Unified.local ; unified Domain-Wide Account |
|
|
Each line in the Routing Table is a routing record. A routing
record contains optional prefixes, a left part, the equals sign (=) and a right
part. The semicolon sign (;) can be used to place a comment after
the right part of a routing record. A comment line can be added to the
Table by inserting a line starting with the semicolon sign.
The Router takes a parsed address (i.e. the domain and local
parts of the address) and uses the Table, scanning its records from top
to bottom. If an applicable record is found, it is applied as described
below and the modified address is processed with the Router again.
- Log
- The CommuniGate Pro Router has the Log Setting that you can modify
using a Web browser. Use this setting to specify what kind of information
the CommuniGate Pro Router should put in the System Log. Usually you should
use the Major (address routing) level. But when you experience
problems with the Router, you may want to set the Log setting to Low-Level
or All Info: in this case more low-level information about the
Router activity will be recorded in the System Log as well. The Router
component records in the System Log are marked with the ROUTER
tag.
Prefix
A Routing record can contain a Relay-mode prefix: Relay: (can be shorten to R:),
NoRelay: (can be shorten to N:), or RelayAll:.
See the Protection
section for the details. If none of these prefixes is specified, the Relay: prefix is assumed.
A Routing record can contain one of the following operation-type prefixes:
- Mail: (can be shorten to M:). Records with this prefix take effect only
when an address is routed for some E-mail delivery operation.
- Access: (can be shorten to A:). Records with this prefix take effect only
when an address is routed for some account access operation.
- Signal: (can be shorten to S:). Records with this prefix take effect only
when an address is routed for some Signal operation.
These prefixes should be specified after an optional Relay-mode prefix. If none of these prefixes
is specified, the Routing record is applied to addresses used in all operations.
Sample
The left part of a Routing record contains a Sample: a string with an optional wildcard.
The following wildcards are supported:
- *
- this wildcard matches zero or more symbols.
- Sample 1:
sta*r
- This sample matches any staXXXXXXr string where XXXXXX is any substring (including an empty
substring of the star string).
- (size type)
- type is the substring type:
- d - decimal digits (0 .. 9)
- h - hexadecimal digits (0 .. 9, A .. F, a .. f)
- L - alpha-numeric symbols (0 .. 9, A .. Z, a .. z)
- * - any symbols
size is an optional substring length. It can be specified in the following forms:
- nnn (where nnn a decimal number): a matched substring should have nnn symbols.
- nnn+ : a matched substring should have nnn or more symbols.
- nnn-mmm (where mmm a decimal number, mmm >= nnn):
a matched substring should have between nnn and mmm symbols.
- Sample 1:
sta(3*)r
- This sample matches any staXXXr string where XXX are any 3 symbols.
- Sample 2:
sta(4+d)r
- This sample matches any staDDDDDr string where DDDDD are 4 or more decimal digits.
sta(3-5h)r
- This sample matches any staHHHr string where HHH are 3,4, or 5 hexadecimal digits.
The backslash (\) symbol is used as an escape symbol: \\ is processed
as a single backslash symbol, \* is processed as an asterisk symbol, etc.
Only one wildcard symbol is allowed in a Sample.
Route
The right part of a Routing record contains a Route: a string with an optional * wildcard.
When a Record Sample matches an address, the address is changed to the Record Route. The Substring
matching the Sample wildcard substitutes the Route wildcard.
Domain-Level Routing Records
If the left part of a Routing record contains a domain name, the record
specifies domain-level routing.
When some address is being processed and the domain name matches a domain
name specified in such a record, the domain part is substituted with the
right part of the routing record.
- Example:
- hq.stalker.com = twisted.stalker.com
- All addresses with the hq.stalker.com domain part are changed to have
the twisted.stalker.com domain part. The Router restarts, trying to route
the modified address.
A routing path can specify relays.
- Example:
- hq.stalker.com = hq.stalker.com@relay.stalker.com
- All messages and signal directed to the domain name hq.stalker.com will be redirected
to the system (domain) relay.stalker.com, and then, from that system, to the domain
hq.stalker.com.
If mail to several domains should be routed in the same or similar way,
you may use the asterisk sign as the wild-card symbol.
- Example:
- *.old_company.com = new_company.com
- In this case addresses in all the domains ending with .old_company.com
will be changed to have the new_company.com domain part, with the local parts (user
names) unchanged.
Very often this type of routing is used to process all subdomains of
the some domain.
- Example:
- *.mycompany.com = mycompany.com
- If the mycompany.com is the Server's Main Domain name, then this routing
record makes the Server process messages and signals sent to all subdomains of its
Main Domain as messages and signals sent to the Main domain,
the address user@mail.mycompany.com will be processed as the user@mycompany.com address.
- Example:
- *.old_company.com = *.new_company.com
- When such a routing line is entered and a message or a signals comes in for the domain
host5.old_company.com, it is routed to host5.new_company.com.
- Example:
- system-*.mycompany.com = uu*.local
- This routing line will redirect system-abc.mycompany.com to uuabc.local.
Besides domain-level routing records, routing for domains can be specified
using account-level records (see below).
Records for Unified Domain-Wide
Accounts are domain-level routing records, too.
Account-Level Routing Records
If the left part of a routing record contains an E-mail address in the
angle brackets (< and >), the record is
an Account-level record - a routing rule for a specific address.
When an address is parsed and the Router scans the Table records,
it compares the address domain part with the domain part of all Account-Level routing records.
If the domain parts match, the Router compares the local part of the address with the
local part of the account-level record address. If both domain and local parts match,
the right part of the account-level routing record is used as the new address.
The Router restarts, parsing and processing this new address.
Note: Because the Server Main Domain Name in the parsed address is
immediately replaced with an empty string, account-level records that should apply to
addresses in the Main Domain should not contain any domain part at all.
In the all examples below mycompany.com is the Server Main Domain name.
- Example:
- <sales> = Bill
in this case, all messages to sales@mycompany.com will go to Bill, as if
they were sent to Bill@mycompany.com
Note: if there is an account-level record for the local name xxxx,
there is no need to actually create a real xxxx Account on
the Server. Additionally, that Account would be useless, since no
message or signal will ever reach that Account: everything directed to the
xxxx name will be routed elsewhere.
The right side of an account-level record can be any E-mail address.
- Example:
- <sales> = Bill@thatcompany.com
- All messages directed to sales@mycompany.com will be directed to Bill@thatcompany.com.
The Router takes the new address, extracts the domain name (thatcompany.com)
and local (Bill) parts, then the Router restarts trying to find a route to thatcompany.com.
You can use the wildcard symbol (*) in the local part of account-level records.
The same symbol can be used in any part of the right-side address to specify substring
substitution.
- Example:
- <dept-*> = postmaster@*-dept.mycompany.com
- This record will redirect all messages sent to dept-sales@mycompany.com
to the user postmaster at the sales-dept.mycompany.com department mail
server.
You can use Router account-level records to reroute mail sent to some of the your Server
Secondary Domains. In the following example, the client.com is a local Secondary Domain.
- Example:
- <sales@client.com> = Bill@client.com
- All messages directed to sales@client.com will be directed to Bill@client.com.
- Example:
- <sales@client.com> = Bill
- All messages directed to sales@client.com will be directed to Bill@mycompany.com (i.e.
to the address Bill in the Main Domain).
In most cases you do not have to use account-level Router Records: if you need
to provide an alternative name some Account, use
Account Aliases instead. If you need to re-route all
mail sent to some name in a local Server Domain to some other address, use
Forwarders instead.
You may need to create an alias for a specific account
on a foreign system. For example, all mail sent to some domain should be
routed to a specific mail host or to a unified account, but certain accounts
in that domain should be routed to accounts on your or other systems.
- Example:
- <sales@client1.com> = sales-client1
client1.com = new.client1.com
- These records route all messages directed to the account sales at the
domain client1.com to the Account sales-client1 in your Server Main Domain, while messages
to all other accounts in the client1.com domain are routed to the new.client1.com
system.
The wildcard symbol (*) can be used only in the local part
of the full account name (i.e. it can be used before the @ sign).
You can use the wildcard feature to host several domains in one CommuniGate Pro Domain
creating a unique "address space" for each domain name.
- Example:
- <*@client5.com> = cl5-*
<*@client7.com> = cl7-*
Mail to sales@client5.com address will be stored on your server
in the cl5-sales Main Domain account, messages to info@client5.com address will be
stored in the cl5-info Main Domain account, while messages to sales@client7.com address
will be stored in the cl7-sales Main Domain account.
This method can be used when you do not want to create full-scale CommuniGate Pro
Domains for many domains that should host 1-2 accounts.
All-Local Routing Records
Account-level records can use wildcard symbol (*) as the domain part. This
records are applied to the addresses that contain any local Domain (i.e. a Domain created on
this CommuniGate Pro Server or Cluster). The right-side address of such record specifies an
address in the same local Domain.
- Example:
- <abuse@*> = postmaster
This record reroutes an abuse@domainX.dom address into postmaster@domainX.dom for all
domainX.dom Domains created in your CommuniGate Pro system.
If the right-side address contains a domain part, the address is routed to that domain.
- Example:
- <abuse@*> = postmaster@somedomain.com
This record reroutes abuse@domainX.dom addresses into the postmaster%somedomain.com@domainX.dom addresses for all
domainX.dom Domains created in your CommuniGate Pro system. Then the postmaster%somedomain.com@domainX.dom
addresses are rerouted to the postmaster@somedomain.com address.
The local part of the left-side address can contain a wildcard (as in regular account-level
records). The string matching this wildcard symbol can be used in the right-side address.
- Example:
- <+*@*> = 011*
This record reroutes the +490088899@domainX.dom address into the 011490088899@domainX.dom address
for all domainX.dom Domains created in your CommuniGate Pro system.
