SpamExperts KnowledgebaseIncoming Filtering

LDAP Mailbox Sync

With the LDAP Mailbox Sync you can synchronize the mailboxes from your LDAP server in the interface. These will show up in the Local Recipients section. Even if the list is populated, the Local Recipients will not be used unless you manually enable this from that section. 

This is available for Domain users, Admin users and Super Admin users. 

Setting it up

To set this up, you will need to go the the domain dashboard and then to the LDAP Mailbox Sync section. Once you are there, you need to first go to the Configuration tab. 

Here, you will need to add: 

  • Host: this is the hostname or IP that points to your LDAP server

  • Port: this can be either 389, 636 or any custom port that you  have externally accessible on the LDAP server

  • Use TLS connect: if this is enabled, TLS will be enforced

  • Username / bind DN: This is the username that has access to that LDAP server

  • Password: the password of the username you selected

  • Base DN: This should be the starting point of the DNs that contains all the users for this domain and no others.

  • Sync Every: this will determine how often the filtering server will connect to the LDAP server to check for changes

If you select the Show Advanced Configuration settings, you will have access to other details as well: 

  • Filter: by default, the filtering server will query everything on the LDAP Server. If you want to have a custom filter in place, you can add it here. For example, you can use: (|(objectClass=person)(objectClass=user)) to limit the filter

  • Allow Updates: If this is enabled, if the filtering server finds any new setting it will automatically add it to the interface as well

  • Allow deactivations: If this is enabled and a mailbox was removed from the LDAP server it will also be removed from the Local Recipient list. 

Once you finished the configuration you need to click Save.

If you want to clear the configuration so LDAP Mailbox Sync is no longer used, you need to click on the Clear button and then on save. 



The Preview allows you to see in real time what changes will be made when the sync will take place. To access this section, you need to click on the Preview button in the Ldap Configuration section. 

Once you click on that, a new pop-up screen will appear. 

Here you will see how many mailboxes / aliases will be added, removed or updated and also a list of mailboxes and aliases that will be updated. 

You have the option to save this setup and sync the mailboxes now. This will result in the sync being performed at that point. 

Or you can save the settings and sync later, which will lead to the sync being run at the scheduled time. 

Mapping / Default Mapping

Any cluster will have a default mapping added. These can be Edited by the Super-Administrator user.

The default Mapping rules will include the most common methods of linking LDAP attributes to control panel mailboxes or aliases. This should remove the need for users to configure mappings themselves, making configuring LDAP synchronisation far simpler.

This can be seen in the Default Mapping section. Once you get to this section you need to click show results to view the existing entries

Several actions are available to these rules. You can either copy them one by one or export them to CSV by using the drop-down arrow to the left of the rule. Or you can select them all and then remove them or export them by using the drop-down list at the bottom of the page. 

If you want to use your own custom mapping rules, you can add them in the Mapping tab. 

To view any existing Mapping rules that you have created, you need to click on Show Results once you are in that section. 

To add a new Mapping rule, you need to click on the Add Mapping button.

  • Type: Mailbox or Alias

  • Attribute: the LDAP attribute name

  • Regular Expression: regular expression that is used to match on the value of the LDAP attribute. Must contain a group that will be used in the formatter. (E.g. ^(.*)@)

  • Formatter: Format the value of the LDAP attribute using the groups from the regular expression. (E.g. {} or {}

Once you’ve filled in all of the above, you need to click save to add the mapping rule. 

Was this article helpful?

Related articles

Search result for :