Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend documentation #13

Open
controlol opened this issue Dec 26, 2024 · 0 comments
Open

Extend documentation #13

controlol opened this issue Dec 26, 2024 · 0 comments

Comments

@controlol
Copy link

I feel like there's essential information missing for people who are less experienced with mail autodiscover. Fortunately, this repo seems much more complete than other repositories available. However, this also brings the complexity of slight differences between each supported client. For this reason I think a sort of setup guide is missing.

I think it would be nice to get an overview of each exported page and to which client it belongs. You also have utility pages such as the Apple mobileconfig and the dns-zone.

I found the following routes and my interpretation of it's use.

method path client/usage
GET / UI welcome page
GET /apple UI page to get the Apple mobileconfig
GET /email.mobileconfig?<email> Route that uses the email query and host header to generate the mobileconfig
GET /mail/config-v1.1.xml?<emailaddress> autodiscover Maily, KMail, Thunderbird, FairEmail, Evolution, Spark Email, MailTime, Profimail, K-9 Mail
GET /v1.1/mail/config-v1.1.xml?<emailaddress> autodiscover Android Nine
GET /.well-known/autoconfig/mail/config-v1.1.xml?<emailaddress> Not sure?
GET /autodiscover/autodiscover.json?<Email>&<Protocol>&<RedirectCount> autodiscover Android Nine, Outlook, Office Pro Plus 2021
GET /autodiscover/autodiscover.json/v1.0/infos?<Email>&<Protocol>&<RedirectCount> Office 2009
GET /autodiscover/autodiscover.xml autodiscover Android MyMail, Android Spike Email, Outlook Android, Office Pro Plus 2013 & 2021 (multiple routes for different letter casing)
POST /autodiscover/autodiscover.xml autodiscover Outlook Android, Office Pro Plus 2013 & 2021 (multiple routes for different letter casing)
GET /robots.txt Search engine indexing page
GET /version Report of the app version and description
GET /ping Pong response message

Most or all autodiscover routes also seem to use the host header to set the DomainName fields in the response.

I am expecting this project should be published on autodiscover.domain.tld to function properly, as suggested by the DNS records generated by dns-zone and the fact that a index path is used for the Apple mobileconfig page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant