├── .gitignore
├── .htaccess
├── README.md
├── autodiscover.xml.php
├── mail
    ├── autodiscover.xml
    └── config-v1.1.xml
└── settings.json.sample


/.gitignore:
--------------------------------------------------------------------------------
1 | settings.json
2 | *.swp
3 | .DS_Store


--------------------------------------------------------------------------------
/.htaccess:
--------------------------------------------------------------------------------
 1 | Options -Indexes
 2 | RewriteEngine On
 3 | RewriteBase /
 4 | 
 5 | RewriteCond %{REQUEST_URI}::$1 ^(.*?/)(.*)::\2$
 6 | RewriteRule ^(.*)$ - [E=BASE:%1]
 7 | 
 8 | RewriteCond %{QUERY_STRING} ^(emailaddress)=(.*)$
 9 | RewriteRule ^mail/(.*)$ %{ENV:BASE}autodiscover.xml.php?template=config-v1.1.xml&email=%2 [L]
10 | 
11 | #RewriteCond %{REQUEST_FILENAME} -f
12 | RewriteRule ^mail/(.*)$ %{ENV:BASE}autodiscover.xml.php?template=config-v1.1.xml&email=$1 [L]
13 | 
14 | #RewriteRule ^(.*)/?mail/(.*)$ info.php [L]
15 | RewriteRule ^(.*)/?autodiscover\.xml$ autodiscover.xml.php [L]
16 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | E-Mail Autoconfigure
  2 | ====================
  3 | 
  4 | Some E-Mail clients gather configuration information before setting up mail accounts. This project allows to provide clients like Outlook and Thunderbird the proper mail server configuration, so that users can simply enter their email and password to setup a new mail account.
  5 | 
  6 | Installation
  7 | ------------
  8 | 
  9 | ### Apache Webserver
 10 | 
 11 | You need an Apache webserver with PHP5 preconfigures. You can then configure your Virtual Host like this
 12 | 
 13 | ```
 14 | <VirtualHost *:443>
 15 |   ServerName autodiscover.{{$DOMAIN}}
 16 |   ServerAlias autodiscover.{{$DOMAIN}} autoconfig.{{$DOMAIN}}
 17 | 
 18 |   <Location />
 19 |     Options -Indexes
 20 |     AllowOverride All
 21 |   </Location>
 22 | 
 23 |   ...
 24 | </VirtualHost>
 25 | ```
 26 | 
 27 | Now copy `settings.json.sample` to your Virtual Host directory root and apply your configuration variables.
 28 | 
 29 | 
 30 | ### Autoconfig for multiple domains on the same server
 31 | 
 32 | When a user puts his E-Mail address `user@example.org` into his mail client, it will probably do a GET request on https://autodiscover.example.org/autodiscover/autodiscover.xml
 33 | 
 34 | If you have multiple domains hosted on your mailserver, you can redirect those requests to your main-autoconfig server. Add this configuration to your existing Virtual Host configuration:
 35 | 
 36 | ```
 37 | <VirtualHost *:443>
 38 |   ServerName example.org
 39 |   SSLEngine On
 40 |   ...
 41 | 
 42 |   RewriteEngine On
 43 |   RewriteCond %{HTTP_HOST} ^autodiscover\. [NC]
 44 |   RewriteRule ^/(.*)      https://autodiscover.{{$DOMAIN}}/$1 [L,R=301,NE]
 45 | 
 46 |   RewriteCond %{HTTP_HOST} ^autoconfig\. [NC]
 47 |   RewriteRule ^/(.*)      https://autoconfig.{{$DOMAIN}}/$1 [L,R=301,NE]
 48 |   ...
 49 | </VirtualHost>
 50 | 
 51 | <VirtualHost *:80>
 52 |   ServerName example.org
 53 |   
 54 |   RewriteEngine On
 55 |   RewriteCond %{HTTP_HOST} ^autodiscover\. [NC]
 56 |   RewriteRule ^/(.*)      https://autodiscover.{{$DOMAIN}}/$1 [L,R=301,NE]
 57 | 
 58 |   RewriteCond %{HTTP_HOST} ^autoconfig\. [NC]
 59 |   RewriteRule ^/(.*)      https://autoconfig.{{$DOMAIN}}/$1 [L,R=301,NE]
 60 |   ...
 61 | </VirtualHost>
 62 | 
 63 | ```
 64 | 
 65 | 
 66 | ### DNS Setup
 67 | 
 68 | For the case you are using Bind and have the autoconfig HTTP server running on the same IP your `www.` subdomain resolves to, you can use this DNS records to configure your nameserver
 69 | 
 70 | ```
 71 | autoconfig              IN      CNAME   www
 72 | autodiscover            IN      CNAME   www
 73 | 
 74 | @                       IN      MX 10   {{$MX_DOMAIN}}.
 75 | @                       IN      TXT     "mailconf=https://autoconfig.{{$DOMAIN}}/mail/config-v1.1.xml"
 76 | _imaps._tcp             SRV 0 1 993     {{$MX_DOMAIN}}.
 77 | _submission._tcp        SRV 0 1 465     {{$MX_DOMAIN}}.
 78 | _autodiscover._tcp      SRV 0 0 443     autodiscover.{{$DOMAIN}}.
 79 | ```
 80 | 
 81 | Instead of a CNAME, you can of course also choose an A-record
 82 | 
 83 | ```
 84 | autoconfig              IN      A      {{$AUTODISCOVER_IP}}
 85 | autodiscover            IN      A      {{$AUTODISCOVER_IP}}
 86 | ```
 87 | 
 88 | Replace above variables with data according to this table
 89 | 
 90 | Variable         | Description
 91 | -----------------|-------------------------------------------------------------
 92 | MX_DOMAIN        | The hostname name of your MX server
 93 | DOMAIN           | Your apex/bare/naked Domain
 94 | AUTODISCOVER_IP  | IP of the Autoconfig HTTP
 95 | 
 96 | ToDo
 97 | ----
 98 | 
 99 |  * Allow other authentication methods (currently always required)
100 |  * Support nginx HTTP server
101 |  * Add client support table
102 |  * Create a Makefile for easy installation
103 | 


--------------------------------------------------------------------------------
/autodiscover.xml.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | try {
 4 |   $config = loadConfig();
 5 |   $xml = loadTemplate(determineTemplateFile());
 6 | } catch(Exception $e) {
 7 |   header("HTTP/1.0 500 Internal Server Error");
 8 |   exit;
 9 | }
10 | 
11 | header ("Content-Type:text/xml");
12 | 
13 | $xml = str_replace("%INFO/NAME%", $config['info']['name'], $xml);
14 | $xml = str_replace("%INFO/URL%", $config['info']['url'], $xml);
15 | $xml = str_replace("%INFO/DOMAIN%", $config['info']['domain'], $xml);
16 | $xml = str_replace("%TTL%", $config['ttl'], $xml);
17 | 
18 | 
19 | $xml = str_replace("%SERVER/SMTP/SSL_ON%", isOnOrOff($config['server']['smtp']['socket'] == "SSL"), $xml);
20 | $xml = str_replace("%SERVER/IMAP/SSL_ON%", isOnOrOff($config['server']['imap']['socket'] == "SSL"), $xml);
21 | 
22 | $xml = str_replace("%SERVER/IMAP/DOMAIN_REQUIRED%", isOnOrOff($config['server']['domain_required']), $xml);
23 | $xml = str_replace("%SERVER/SMTP/DOMAIN_REQUIRED%", isOnOrOff($config['server']['domain_required']), $xml);
24 | 
25 | $xml = str_replace("%SERVER/IMAP/HOST%", $config['server']['imap']['host'], $xml);
26 | $xml = str_replace("%SERVER/IMAP/PORT%", $config['server']['imap']['port'], $xml);
27 | $xml = str_replace("%SERVER/IMAP/SOCKET%", $config['server']['imap']['socket'], $xml);
28 | 
29 | $xml = str_replace("%SERVER/SMTP/HOST%", $config['server']['smtp']['host'], $xml);
30 | $xml = str_replace("%SERVER/SMTP/PORT%", $config['server']['smtp']['port'], $xml);
31 | $xml = str_replace("%SERVER/SMTP/SOCKET%", $config['server']['smtp']['socket'], $xml);
32 | 
33 | $xml = str_replace("%EMAIL%", getRequestEmail(), $xml);
34 | 
35 | $xml = removeComments($xml);
36 | $xml = beautify($xml);
37 | echo $xml;
38 | 
39 | 
40 | function removeComments ($xml) {
41 |   $pattern = '/<!--(.*)?-->/sU';
42 |   return preg_replace($pattern, '', $xml);
43 | }
44 | 
45 | function beautify ($xml) {
46 |   $dom = new DOMDocument;
47 |   $dom->preserveWhiteSpace = false;
48 |   $dom->loadXML($xml);
49 |   $dom->formatOutput = true;
50 |   return $dom->saveXml();
51 | }
52 | 
53 | function isOnOrOff ($value) {
54 |   return ($value === true) ? 'on' : 'off';
55 | }
56 | 
57 | function loadConfig () {
58 |   return json_decode(implode('', file('settings.json')), true);
59 | }
60 | 
61 | function loadTemplate ($file) {
62 |   return implode("",file($file));
63 | }
64 | 
65 | function determineTemplateFile () {
66 | 
67 |   $template = array_key_exists('template', $_GET) ? $_GET['template'] : null;
68 |   
69 |   switch($template) {
70 | 
71 |     case "config-v1.1.xml":
72 |       $file = 'mail/config-v1.1.xml';
73 |       break;
74 | 
75 |     default:
76 |       $file = 'mail/autodiscover.xml';
77 |       break;
78 | 
79 |   }
80 | 
81 |   return $file;
82 | 
83 | }
84 | 
85 | function getRequestEmail () {
86 | 
87 |   $email = array_key_exists('email', $_GET) ? $_GET['email'] : null;
88 |   return filter_var($email, FILTER_VALIDATE_EMAIL);
89 | 
90 | }
91 | 
92 | ?>
93 | 


--------------------------------------------------------------------------------
/mail/autodiscover.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="utf-8" ?>
  2 | <Autodiscover xmlns="http://schemas.microsoft.com/exchange/autodiscover/responseschema/2006">
  3 | <!-- Response: Required
  4 | This tag serves as an indication that the retrieved XML is an Autodiscovery Response
  5 | -->
  6 | <Response xmlns="http://schemas.microsoft.com/exchange/autodiscover/outlook/responseschema/2006a">
  7 | <!-- User: Optional
  8 | This tag gives user-specific information.  Autodiscover must be UTF-8 encoded.
  9 | -->
 10 | <User>
 11 | <!-- DisplayName: Optional
 12 | The server may have a good formal display name.  The client can decide to accept it or change it.  This will save the user time in the default case.
 13 | -->
 14 | <DisplayName>%INFO/NAME%</DisplayName>
 15 | </User>
 16 | 
 17 | <!-- Account: Required
 18 | This tag specifies the type of account, such as Email vs Newsgroups, vs SIP server, etc.
 19 | -->
 20 | <Account>
 21 | <!-- AccountType: Required
 22 | This value indicates the type of the account.
 23 | VALUES:
 24 | email: The values under this Account tag indicate configuration settings for an email server.
 25 | nntp: The values under this Account tag indicate configuration settings for a NNTP server. (not used by Outlook 2007)
 26 | -->
 27 | <AccountType>email</AccountType>
 28 | 
 29 | <!-- Action: Required
 30 | This value indicates if the goal of this account results is to provide the settings or redirect to another web server that can provide results.
 31 | VALUES:
 32 | redirectUrl: If this value is specified, then the URL tag will specify the http: or https: URL containing the Autodiscover results to be used.  In order to prevent the server from being able to send the client into an infinite loop, the client should stop redirecting after 10 redirects.
 33 | redirectAddr: If this value is specified, then the XML tag will specify the e-mail address that Outlook should use to execute Autodiscover again.  In other words, the server is telling the client that the e-mail address the client should really be using for Autodiscover is not the one that was posted, but the one specified in this tag. 
 34 | settings: If this value is specified, then the XML will contain the settings needed to configure the account.  The settings will primarily be under the PROTOCOL tag.
 35 | -->
 36 | <Action>settings</Action>
 37 | 
 38 | <!-- RedirectUrl: Required if ACTION tag has value of 'redirectUrl'. Otherwise this tag must not exist.
 39 | The value will be a https: URL that the client should use to obtain the Autodiscover settings or a http: URL that the client should use for further redirection.
 40 | --><!--
 41 | <RedirectUrl>redirect.URL</RedirectUrl>
 42 | -->
 43 | 
 44 | <!-- RedirectAddr: Required if ACTION tag has value of 'redirectAddr'. Otherwise this tag must not exist.
 45 | The value will be an email address that the client should use to rediscover settings using the Autodiscover protocol.
 46 | --><!--
 47 | <RedirectAddr>email@address</RedirectAddr>
 48 | -->
 49 | 
 50 | <!-- Image: Optional
 51 | This is a JPG picture to brand the ISP configuration experience with. The client can choose whether or not they download this picture to display. (not used by Outlook 2007)
 52 | --><!--
 53 | <Image>http://path.to.image.com/image.jpg</Image>
 54 | -->
 55 | 
 56 | <!-- ServiceHome: Optional
 57 | This is a link to the ISP’s Home Page. The client can choose whether or not they expose this link to the user. (not used by Outlook 2007)
 58 | -->
 59 | <ServiceHome>%INFO/URL%</ServiceHome>
 60 | 
 61 | <!-- Protocol: Required if ACTION tag has value of 'settings'. Otherwise, this tag must not exist.
 62 | The tag encloses the specifications for a single account type.  The list of Protocol tags are in order of preference of the server.  The client may over ride the preference.
 63 | -->
 64 | <Protocol>
 65 | <!-- TYPE: Required.
 66 | The value here specifies what kind of mail account is being configured.
 67 | POP3: The protocol to connect to this server is POP3. Only applicable for AccountType=email.
 68 | SMTP: The protocol to connect to this server is SMTP. Only applicable for AccountType=email.
 69 | IMAP: The protocol to connect to this server is IMAP. Only applicable for AccountType=email.
 70 | DAV: The protocol to connect to this server is DAV. Only applicable for AccountType=email.
 71 | WEB: Email is accessed from a web browser using an URL from the SERVER tag. Only applicable for AccountType=email. (not used by Outlook 2007)
 72 | NNTP: The protocol to connect to this server is NNTP. Only applicable for AccountType=nntp. (not used by Outlook 2007)
 73 | -->
 74 | <Type>IMAP</Type>
 75 | 
 76 | <!-- ExpirationDate: Optional.
 77 | The value here specifies the last date which these settings should be used. After that date, the settings should be rediscovered via Autodiscover again. If no value is specified, the default will be no expiration.
 78 | --><!--
 79 | <ExpirationDate>YYYYMMDD</ExpirationDate>
 80 | -->
 81 | 
 82 | <!-- TTL: Optional.
 83 | The value here specifies the time to live in hours that these settings are valid for. After that time has elapsed (from the time the settings were retrieved), the settings should be rediscovered via Autodiscovery again. A value of 0 indicates that no rediscovery will be required. If no value is specified, the default will be a TTL of 1 hour.
 84 | -->
 85 | <TTL>%TTL%</TTL>
 86 | 
 87 | <!-- Server: Required.
 88 | The value here specifies the name of the mail server corresponding to the server type specified above.
 89 | For protocols such as POP3, SMTP, IMAP, or NNTP, this value will be either a hostname or an IP address.
 90 | For protocols such as DAV or WEB, this will be an URL.
 91 | -->
 92 | <Server>%SERVER/IMAP/HOST%</Server> <!--IP Addr or DNS name of server-->
 93 | 
 94 | <!-- Port: Optional.
 95 | The value specifies the Port number to use.  If no value is specified, the default settings will be used depending on the mail server type.  This value is not used if the SERVER tag contains an URL.
 96 | -->
 97 | <Port>%SERVER/IMAP/PORT%</Port>
 98 | 
 99 | <!-- LoginName: Optional.
100 | This value specifies the user's login.  If no value is specified, the default will be set to the string preceding the '@' in the email address.  If the Login name contains a domain, the format should be <Username>@<Domain>.  Such as JoeUser@SalesDomain.
101 | --><!--
102 | <LoginName>johndoe</LoginName>
103 | -->
104 | 
105 | <!-- DomainRequired: Optional.  Default is off.
106 | If this value is true, then a domain is required during authentication.  If the domain is not specified in the LOGINNAME tag, or the LOGINNAME tag was not specified, the user will need to enter the domain before authentication will succeed.
107 | -->
108 | <DomainRequired>%SERVER/IMAP/DOMAIN_REQUIRED%</DomainRequired>
109 | 
110 | <!-- DomainName: Optional.
111 | This value specifies the user's domain. If no value is specified, the default authentication will be to use the e-mail address as a UPN format <Username>@<Domain>. Such as JoeUser@SalesDomain.
112 | --><!--
113 | <DomainName></DomainName>
114 | -->
115 | 
116 | <!-- SPA: (Secure Password Authentication) Optional.
117 | This value specifies whether or not secure password authentication is needed.
118 | If unspecified, the default is set to on.
119 | -->
120 | <SPA>off</SPA>
121 | 
122 | <!-- SSL: Optional.
123 | This value specifies whether secure login is needed.
124 | If unspecified, the default is set to on.
125 | -->
126 | <SSL>%SERVER/IMAP/SSL_ON%</SSL>
127 | 
128 | <!-- AuthRequired: Optional.
129 | This value specifies whether authentication is needed (password).
130 | If unspecified, the default is set to on.
131 | -->
132 | <AuthRequired>on</AuthRequired> <!-- Optional: Is Authentication required? -->
133 | 
134 | <!-- UsePOPAuth: Optional.
135 | This value can only be used for SMTP types.
136 | If specified, then the authentication information provided for the POP3 type account will also be used for SMTP.
137 | -->
138 | <UsePOPAuth>on</UsePOPAuth>
139 | 
140 | <!-- SMTPLast: Optional.  Default is off.
141 | If this value is true, then the SMTP server requires that email be downloaded before sending email via the SMTP server.  This is often required because the SMTP server verifies that the authentication succeeded when downloading email.
142 | -->
143 | <SMTPLast>off</SMTPLast>
144 | </Protocol>
145 | 
146 | <Protocol>
147 |   <Type>SMTP</Type>
148 |   <TTL>%TTL%</TTL>
149 |   <Server>%SERVER/SMTP/HOST%</Server>
150 |   <Port>%SERVER/SMTP/PORT%</Port>
151 |   <DomainRequired>%SERVER/SMTP/DOMAIN_REQUIRED%</DomainRequired>
152 |   <SPA>off</SPA>
153 |   <SSL>%SERVER/SMTP/SSL_ON%</SSL>
154 |   <AuthRequired>on</AuthRequired>
155 |   <UsePOPAuth>on</UsePOPAuth>
156 |   <SMTPLast>off</SMTPLast>
157 | </Protocol>
158 | </Account>
159 | </Response>
160 | </Autodiscover>
161 | 


--------------------------------------------------------------------------------
/mail/config-v1.1.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | 
 3 | <clientConfig version="1.1">
 4 |   <emailProvider id="%INFO/DOMAIN%">
 5 |     <domain>%INFO/DOMAIN%</domain>
 6 |     <displayName>%INFO/NAME%</displayName>
 7 |     <displayShortName>%INFO/NAME%</displayShortName>
 8 |     <incomingServer type="imap">
 9 |       <hostname>%SERVER/IMAP/HOST%</hostname>
10 |       <port>%SERVER/IMAP/PORT%</port>
11 |       <socketType>%SERVER/IMAP/SOCKET%</socketType>
12 |       <authentication>password-cleartext</authentication>
13 |       <username>%EMAIL%</username>
14 |     </incomingServer>
15 |     <outgoingServer type="smtp">
16 |       <hostname>%SERVER/SMTP/HOST%</hostname>
17 |       <port>%SERVER/SMTP/PORT%</port>
18 |       <socketType>%SERVER/SMTP/SOCKET%</socketType>
19 |       <authentication>password-cleartext</authentication>
20 |       <username>%EMAIL%</username>
21 |     </outgoingServer>
22 |     <documentation url="%INFO/URL%">
23 |       <descr lang="de">Allgemeine Beschreibung der Einstellungen</descr>
24 |       <descr lang="en">Generic settings page</descr>
25 |     </documentation>
26 |   </emailProvider>
27 | </clientConfig>
28 | 


--------------------------------------------------------------------------------
/settings.json.sample:
--------------------------------------------------------------------------------
 1 | {
 2 |   "info": {
 3 |     "name": "{{$COMPANY_NAME}}",
 4 |     "url": "{{$SUPPORT_URL}}",
 5 |     "domain": "{{$DOMAIN}}"
 6 |   },
 7 |   "server": {
 8 |     "imap": {
 9 |       "host": "{{$IMAP_HOST}}",
10 |       "port": {{$IMAP_PORT}},
11 |       "socket": "SSL"
12 |     },
13 |     "smtp": {
14 |       "host": "{{$SMTP_HOST}}",
15 |       "port": {{$SMTP_PORT}},
16 |       "socket": "SSL"
17 |     },
18 |     "domain_required": true
19 |   },
20 |   "ttl": 168
21 | }


--------------------------------------------------------------------------------