Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/regnull/email-autodiscover

Autodiscover email configuration for popular email clients
https://github.com/regnull/email-autodiscover

apple-mail configuration email ios-mail outlook thunderbird

Last synced: about 2 months ago
JSON representation

Autodiscover email configuration for popular email clients

Awesome Lists containing this project

README

        

# Email Autodiscover

Provides IMAP/SMTP Autodiscover capabilities on Microsoft Outlook/Apple Mail, Autoconfig capabilities for Thunderbird, and Configuration Profiles for iOS/Apple Mail.

The config files (and this README file, to a large extent) are copied from the excellent [Incruises autodiscover.xml](https://github.com/Incruises/autodiscover.xml) repo,
but the code was re-written in Go instead of Java Script and the functionality to handle TLS/SSL connections was added.

## Running the Autodiscover Server

To run the server, complile cmd/autodiscover/main and run it like so:

```
autodiscover --config=
```

See config directory for the example of the config file. There are additional command line arguments to specify certificate and key if you want to handle TLS/SSL connections.

## Microsoft Outlook/Apple Mail
URL (POST XML): https://{{app_domain}}/Autodiscover/Autodiscover.xml

Create a SRV DNS Record:

| Service | Protocol | Value, Destination, Target | Port | Priority | Weight | TTL |
|:-------------:|:--------:|:--------------------------:|:----:|:--------:|:------:|:----:|
| _autodiscover | _tcp | {{app_domain}} | 443 | 5 | 0 | 3600 |

Test your Autodiscover configuration (Microsoft Outlook): https://testconnectivity.microsoft.com (Click on "Outlook Autodiscover")

## Mozilla Thunderbird
URL (GET): https://{{app_domain}}/mail/config-v1.1.xml

Create a CNAME DNS Record:

| Name, Host, Alias | Value, Destination | TTL |
|:-----------------:|:--------------------:|:----:|
| autoconfig | {{app_domain}} | 3600 |

## iOS / Apple Mail
URL (GET): https://{{app_domain}}/email.mobileconfig?email=EMAIL_ADDRESS

Redirect users to above URL and the MobileConfig Profile will be downloaded. The user will be instructed to install the profile to configure their email.

## Notes

The above autoconfiguration methods assume the following:

* Username: `{{email}}` (Entire email address)
* Encryption: SSL/TLS

## Workarounds

#### I only have one mail server with both IMAP and SMTP on the same machine (mail.mydomain.com).

Create CNAME DNS Records that alias imap/smtp to your machine, like so:

| Name, Host, Alias | Value, Destination | TTL |
|:-----------------:|:------------------:|:----:|
| imap | mail.mydomain.com | 3600 |
| smtp | mail.mydomain.com | 3600 |

#### My settings are different or not compatible with these settings.

Feel free to fork this repository and modify it to your needs.

## License

This project is distributed under the [MIT License](LICENSE)