Auto-discovery Configuration

Axigen Auto-discovery

In Axigen, the Auto-discovery feature can be configured at two distinct levels:

  1. Globally, at server level – this means that all email domains will inherit the Auto-discover configurations set at server level (CLI or axigen.cfg)
  2. At domain level – the Auto-discovery configuration set for a specific domain will override any Auto-discovery configurations set at server level (CLI only).

Server level configuration is visible in axigen.cfg.

Admins are able to configure default Auto-discovery settings:

  • Enable IMAP auto discovery (default = yes)
  • Enable POP3 auto discovery (default = no)
  • Enable SMTP auto discovery (default = yes)
  • Configure default Auto-discovery URLs for all three
  • Configure the default Auto-discovery host(s) in your DNS (and edit certificate information)

Here is an example of Auto-discovery service URLs configured in axigen.cfg

...
autodiscoveryParams = {
    enableIMAPAutodiscovery = yes
    enablePOP3Autodiscovery = no
    enableSMTPAutodiscovery = yes
    enableWebDavAutodiscovery = yes
    autodiscoveryDefaultUrls = {
        httpAutodiscoveryUrl = "https://mail.domain.name:443/Microsoft-Server-ActiveSync"
        imapAutodiscoveryUrl = "imaps://imap.domain.name:993"
        pop3AutodiscoveryUrl = "pop3s://pop3.domain.name:995"
        smtpAutodiscoveryUrl = "smtps://smtp.domain.name:465"
        webDavAutodiscoveryUrl = "https://mail.domain.name:443"
    }
}


Server level configuration in CLI:

root@domain.name:/root# telnet 127.0.0.1 7000
<login> user admin
<password> MyAdminPassw0rd
<#> config server
<server#> config autodiscovery
<server-autodiscovery#> help
-------------------------------------
The commands available for the Autodiscovery configuration context context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
DONE - saves the changes and switches back to previous context
SHOW [ATTR <param>] - shows information about this context

SET enableIMAPAutodiscovery <yes|no> - enables/disables IMAP Autodiscovery
SET enablePOP3Autodiscovery <yes|no> - enables/disables POP3 Autodiscovery
SET enableSMTPAutodiscovery <yes|no> - enables/disables SMTP Autodiscovery
SET enableWebdavAutodiscovery <yes|no> - enables/disables WEBDAV Autodiscovery

CONFIG defaultUrls - enters the autodiscoveryDefaultUrls context
SHOW defaultUrls - shows default autodiscovery URLs

-------------------------------------
+OK: command successful
<server-autodiscovery#> 

 

Here's an example of how to enable the POP3 Auto-discovery feature and set the POP3S Auto-discovery URL for the Axigen server

<server-autodiscovery#> SET  enablePOP3Autodiscovery YES
+OK: command successful
<server-autodiscovery#> show

general parameters for the autodiscovery context:
enableIMAPAutodiscovery = yes
enablePOP3Autodiscovery = yes
enableSMTPAutodiscovery = yes
enableWebDavAutodiscovery = yes

+OK: command successful


<server-autodiscovery#> CONFIG defaultUrls 
+OK: command successful
<server-autodiscovery-urls#> SET pop3AutodiscoveryUrl "pop3s://pop3.domain.name:995"
+OK: command successful
<server-autodiscovery-urls#> show

general parameters for the urls context:
httpAutodiscoveryUrl = ""
imapAutodiscoveryUrl = ""
pop3AutodiscoveryUrl = "pop3s://pop3.domain.name:995"
smtpAutodiscoveryUrl = ""
webDavAutodiscoveryUrl = ""

+OK: command successful
<server-autodiscovery-urls#> 

 

Domain level configuration in CLI:

The enable / disable flags for IMAP, POP, SMTP are not available at domain level. They are inherited from the server level (in axigen.cfg).

root@domain.name:/root# telnet 127.0.0.1 7000
<login> user admin
<password> admin
<#> update domain domain.name
<domain#> config autodiscovery
<domain-autodiscovery-params#> help
-------------------------------------
The commands available for the Autodiscovery Domain Parameters configuration context context are:
EXIT/QUIT - exits CLI and closes connection to AXIGEN
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
DONE - saves the changes and switches back to previous context
SHOW [ATTR <param>] - shows information about this context

CONFIG Urls - enters the autodiscoveryUrls context
SHOW Urls - shows domain autodiscovery URLs

ADD HostNameResolver [host] <host> [domain <domain>] - adds a host name (WebMail URL) to HSP template name mapping
UPDATE HostNameResolver [host] <host> [domain <domain>] - updates a host name (WebMail URL) to HSP template name mapping
REMOVE HostNameResolver [host] <host> - removes a host name (WebMail URL) to HSP template name mapping
SHOW HostNameResolver [host] <host> - shows a virtual host configuration
    *The domain parameter refers to the HSP template directory
 
LIST HostNameResolvers - lists the hostname resolvers
-------------------------------------
+OK: command successful
<domain-autodiscovery-params#> 

 

For example, to set specific Auto-discovery URLs for domain domain1.name, you can use the following commands:

<#> update domain domain1.name
+OK: command successful
<domain#> config autodiscovery
+OK: command successful
<domain-autodiscovery-params#> show urls
httpAutodiscoveryUrl = ""
imapAutodiscoveryUrl = ""
pop3AutodiscoveryUrl = ""
smtpAutodiscoveryUrl = ""
webDavAutodiscoveryUrl = ""
+OK: command successful
 
 
<domain-autodiscovery-params#> config urls
+OK: command successful
<domain-autodiscovery-params-urls#>SET httpAutodiscoveryUrl "https://mail.domain1.name:443/Microsoft-Server-ActiveSync"
+OK: command successful
<domain-autodiscovery-params-urls#> SET imapAutodiscoveryUrl "imaps://imap.domain1.name:993"
+OK: command successful
<domain-autodiscovery-params-urls#>  SET smtpAutodiscoveryUrl "smtps://smtp.domain1.name:465"
+OK: command successful
<domain-autodiscovery-params-urls#> done 
saving changes (if applicable) and switching back to previous context.
+OK: command successful
<domain-autodiscovery-params#> show urls
httpAutodiscoveryUrl = "https://mail.domain1.name:443/Microsoft-Server-ActiveSync"
imapAutodiscoveryUrl = "imaps://imap.domain1.name:993"
pop3AutodiscoveryUrl = ""
smtpAutodiscoveryUrl = "smtps://smtp.domain1.name:465"
webDavAutodiscoveryUrl = ""
+OK: command successful
<domain-autodiscovery-params#> commit
committing changes and switching back to previous context.
<domain-autodiscovery-params#> +OK: command successful
<domain#>


The Auto-discovery functionality has the following purpose: by filling in only the email address and the password in the email client (Outlook, Thunderbird, Axigen Outlook Connector, etc.), the client will be capable to auto configure itself with the appropriate information related to the Incoming and Outgoing email servers, access ports, SSL, or authentication mechanism.