Files for Configuration Synchronization

Files and syntax available to the Configuration Synchronization system.

Filenames

These files must have the correct filename and syntax to configure the Email Appliance through Configuration Synchronization. If the name or the syntax is incorrect you will get an error message at the command line when you use SCP to transfer the file to the appliance.
  • SOPHOS_INTERNAL_HOSTS
  • SOPHOS_TRUSTED_RELAYS
  • SOPHOS_RECIPIENT_VALIDATION
  • SOPHOS_RECIPIENT_ALIASES
  • SOPHOS_REWRITE_SENDERS
  • SOPHOS_REWRITE_RECIPIENTS
  • SOPHOS_MAIL_ROUTING

SOPHOS_INTERNAL_HOSTS

The SOPHOS_INTERNAL_HOSTS file contains a list of internal mail relay servers. You can enter a list of hostnames, IP addresses, or IP address ranges. To maintain this data through the related appliance page, browse to: Configuration > Routing > Internal Mail Hosts. The syntax of this file is the same as in the Internal Mail Hosts page, and the file should contain one entry per line. For example:
mailhost.example.com
mailhost2.example.com
192.0.2.2
192.168.45.0/24

SOPHOS_TRUSTED_RELAYS

The SOPHOS_TRUSTED_RELAYS file contains a list of Trusted Relays: mail gateways between the internet and the Sophos Email Appliance. To maintain this list through the related appliance page, browse to: Configuration > Routing > Trusted Relays. This file should contain one IP address or range per line. For example:
192.0.2.2
192.0.2.3
10.99.0.0/16

SOPHOS_RECIPIENT_VALIDATION

You can use the SOPHOS_RECIPIENT_VALIDATION file to manage your recipient validation list. To configure the appliance to use Configuration Synchronization, browse to Configuration > Policy > SMTP Options and select Via Configuration Sync from the Method of recipient validationdrop-down list. The file should contain one address per line. For example:
janedoe@example.com
bobsmith@example.com
postmaster@example.com
Note
You should upload a valid SOPHOS_RECIPIENT_VALIDATION file before you enable recipient validation using Configuration Synchronization. If you select Via Configuration Sync without uploading a file, the appliance will fall back to Via SMTP look-ahead until a valid SOPHOS_RECIPIENT_VALIDATION is in place.

SOPHOS_RECIPIENT_ALIASES

Use the SOPHOS_RECIPIENT_ALIASES file to copy an alias map list to the appliance through Configuration Synchronization. The file should include one entry per line, with the from and to portions separated by a colon with a space on each side. You can map either individual addresses or domains. For example:
admin@example.com : john.doe@example.com
administrator@example.com : john.doe@example.com
postmaster@example.com : john.doe@example.com
@examplesubsid.com : @example.com
To manage recipient aliases lists on your appliance, browse to Configuration > Accounts > User Groups, and click Custom alias maps. Aliases that have been uploaded through Configuration Synchronization cannot be viewed or edited on the Accounts > User Groups > Custom alias mapspage of the appliance. To remove outdated recipient aliases previously added to the appliance through Configuration Synchronization, use SCP to upload a SOPHOS_RECIPIENT_ALIASES file that contains only:
# <EMPTY FILE>

SOPHOS_REWRITE_SENDERS

Use the SOPHOS_REWRITE_SENDERS file to manage a list of sender email addresses to rewrite. The file should include one entry per line, with the from and to portions separated by a colon with a space on each side. For example:
admin@example.com : john.doe@example.com
John.doe@example.com : jdoe@example.com
bob.smith@example.com : bsmith@example.com
To manage address rewriting directly on the appliance, browse to Configuration > Routing > Address Rewriting. Address Rewriting information you have added to the appliance through Configuration Synchronization can be viewed and edited on the Address Rewriting page. The Email Appliance executes policy based on the original address before rewriting the sender.

SOPHOS_REWRITE_RECIPIENTS

Use the SOPHOS_REWRITE_RECIPIENTS file to manage a list of recipient email addresses to rewrite. The file should include one entry per line, with the from and to portions separated by a colon with a space on each side. For example:
John.doe@example.com : jdoe@example.com 
bob.smith@example.com : bsmith@example.com 
To manage address rewriting directly on the appliance, browse to Configuration > Routing > Address Rewriting. Address Rewriting information you have added to the appliance through Configuration Synchronization can be viewed and edited on the Address Rewriting page. The Email Appliance executes policy based on the new recipient after rewriting the recipient.

SOPHOS_MAIL_ROUTING

The SOPHOS_MAIL_ROUTING file allows you to push mail routing configurations to your appliance through Configuration Synchronization. The file uses an XML format to specify delivery and routing information for the appliance. Review the routing documentation to configure the various configuration settings available in this file through the appliance's administrative interface. The example SOPHOS_MAIL_ROUTING file below gives examples of configuring A records, MX records, and routes.
<?xml version="1.0" encoding="UTF8"?>
<mail-routing>
  <delivery>
    <mta host="10.100.140.60:25" dns_type="A" desc="10.100.140.60:25"/>
    <mta host="HOST1:25" dns_type="MX" desc="Exchange servers - New York Data Centre">
      <mx pri="10" host="ny1.example.com"/>
      <mx pri="20" host="ny2.example.com"/>
    </mta>
    <mta host="HOST2:25" dns_type="MX" desc="Exchange servers - UK Data Centre">
      <mx pri="10" host="uk1.example.com"/>
      <mx pri="10" host="uk2.example.com"/>
    </mta>
  </delivery>
  <routes>
    <route domain="example.net" withsubdomains="yes">
      <scope>
          mail-ny.example.com
          mail-uk.example.com
      </scope>
    </route>
    <route domain="example.org" withsubdomains="yes" deliver_to="10.100.140.60:25">
      <exclude>
        ca.example.org
        fr.example.org
      </exclude>
      <scope>
        mail-ny.example.com
        mail-uk.example.com
      </scope>
    </route>
    <route domain="example.com" withsubdomains="no" deliver_to="HOST1:25">
      <scope>
        mail-ny.example.com
      </scope>
    </route>
    <route domain="example.com" withsubdomains="no" deliver_to="HOST2:25">
      <scope>
        mail-uk.example.com
      </scope>
    </route>
  </routes>
</mail-routing>