How do I access the GMS address books from an LDAP compliant application?

  1. Home
  2. Knowledge Base
  3. GMS
  4. How do I access the GMS address books from an LDAP compliant application?


If your email client supports LDAP you can query GMS to return e-mail addresses from a number of address book repositories. These address book contact you retrieve from GMS will be read-only format so if you wish to populate any of these server side address books, you will need to do this in either GMS Webmail or through the admin interface.

GMS Collaboration also provides access to the server side address books direct from Outlook.


Outlook stores its e-mail addresses under i’s "Contacts" folder. GMS Webmail stores its e-mail addresses under its "MyAddresses" address book. Any e-mail addresses store in GMS Webmail "MyAddresses" will be held on the GMS server. Outlook offers similar functionality but you will need an Exchange server or third party application to take advantage of this.

Using LDAP we have made it possible to query/retrieve GMS server-side address books from any supporting LDAP client. This doesn’t have to be a dedicated LDAP client, it can be a e-mail client such as Thunderbird or even Outlook Express.

  • To query the "MyAddresses" address book ensure that both the account name (login credentials) and the Search Base (BaseDN) match as follows:
    User name:,ou=gmsaddressbook
    Search Base:,ou=gmsaddressbook

You will need to substitute to be a valid account on your GMS server that is able to authenticate to the GMS LDAP server.

  • It is also possible to query all local accounts from your GMS domain. Similarly to the example above the account name/user name will need to reflect the address book you are wanting to query. The Search Base (BaseDN) only needs to reference the appropriate address book.
    User name:,ou=gmslocaladdressbook
    Search Base: ou=gmslocaladdressbook

Note: Access to the domain and system level address books are only available for version 15 installations and higher.
To access these books, replace "gmslocaladdressbook" with either "gmsdomainaddressbook" or "gmssystemaddressbook".

GMS will only accept a few LDAP filter commands. For example it does not accept the default (objectClasses=*). Often the application accessing the GMS address books can customize the filter. Here are a couple of examples:

mail=a* to display all of the accounts begining with "a"
mail=* (or mail=%) to display all of the accounts

See Also:

Keywords:LDAP,address,books,outlook,client,eudora,directory services

Was this article helpful?

Related Articles