| Overview | Service | Command |
<CheckGalConfigRequest>
<a n='zimbraGalMode'>ldap</a>
<a n='zimbraGalLdapURL'>...</a>
<a n='zimbraGalLdapSearchBase'>...</a>
<a n='zimbraGalLdapFilter'>...</a>
<a n='zimbraGalLdapAuthMech'>...</a>
<a n='zimbraGalLdapBindDn'>...</a>*
<a n='zimbraGalLdapBindPassword'>...</a>*
<a n='zimbraGalLdapKerberos5Principal'>...</a>*
<a n='zimbraGalLdapKerberos5Keytab'>...</a>*
<a n='zimbraGalSyncLdapURL'>...</a>
<a n='zimbraGalSyncLdapSearchBase'>...</a>
<a n='zimbraGalSyncLdapFilter'>...</a>
<a n='zimbraGalSyncLdapAuthMech'>...</a>
<a n='zimbraGalSyncLdapBindDn'>...</a>*
<a n='zimbraGalSyncLdapBindPassword'>...</a>*
<a n='zimbraGalSyncLdapKerberos5Principal'>...</a>*
<a n='zimbraGalSyncLdapKerberos5Keytab'>...</a>*
<a n='zimbraGalAutoCompleteLdapFilter'>...</a>
<a n='zimbraGalTokenizeAutoCompleteKey'>...</a>
<a n='zimbraGalTokenizeSearchKey'>...</a>
<query limit="...">...</query>*
<action>{GAL-action}</action>*
</CheckGalConfigRequest>
Notes:
| Authorization token required | true |
| Admin Authorization token required | true |
<CheckGalConfigRequest> ## CheckGalConfigRequest
<query [limit="{query-limit} (Long)"]>{text}</query> ## LimitedQuery
<action>{action} (String)</action>
(<a n="{key}" /> ## Attr)*
</CheckGalConfigRequest>
elements and attributes you can define within a
<CheckGalConfigRequest> element:
| XPath | Required / Optional | Description |
| /query | Optional (0 or 1) | Type: {text} Query Description for element text content:Query |
| /query@limit | Optional (0 or 1) | Type: Long Limit. Default value 10 |
| /action | Optional (0 or 1) | Type: {action} (String) |
| /a | Optional (0 or more) | Attributes |
| /a@n | Required (only 1) | Type: String Key |
<CheckGalConfigResponse> ## CheckGalConfigResponse
<code>{code} (String)</code>
<message>{message} (String)</message>
(<cn id="{gal-contact-id}"> ## GalContactInfo
(<a n="{key}" /> ## Attr)*
</cn>)*
</CheckGalConfigResponse>
elements and attributes you can define within a
<CheckGalConfigResponse> element:
| XPath | Required / Optional | Description |
| /code | Required (only 1) | Type: {code} (String) Code |
| /message | Optional (0 or 1) | Type: {message} (String) Message |
| /cn | Optional (0 or more) | Information for GAL contacts |
| /cn@id | Required (only 1) | Type: String Global Address List contact ID |
| /cn/a | Optional (0 or more) | Attributes |
| /cn/a@n | Required (only 1) | Type: String Key |