Difference between revisions of "Autodiscover"

From SME Server
Jump to navigationJump to search
 
(2 intermediate revisions by the same user not shown)
Line 31: Line 31:
  
 
=== Installation ===
 
=== Installation ===
 +
prerequisite you need a valide SSL certificate, redirection might fails if https uses a non valid certificate, try [[Letsencrypt]]
 
<tabs container><tab name="For SME 10">
 
<tabs container><tab name="For SME 10">
 
  yum --enablerepo=smecontribs install {{#var:smecontribname}}
 
  yum --enablerepo=smecontribs install {{#var:smecontribname}}
</tab><tab name="For SME 9">
+
</tab>
yum --enablerepo=smecontribs install {{#var:smecontribname}}
+
</tabs>
signal-event post-upgrade
 
signal-event reboot
 
</tab><tab name="For SME 8">
 
yum --enablerepo=smecontribs install {{#var:smecontribname}}
 
signal-event post-upgrade
 
signal-event reboot
 
</tab></tabs>
 
  
 
=== Configuration ===
 
=== Configuration ===
Line 103: Line 97:
 
  _pop3._tcp    SRV 0 1 110 pop3.example.com.
 
  _pop3._tcp    SRV 0 1 110 pop3.example.com.
 
  _pop3s._tcp    SRV 0 1 995 pop3.example.com.
 
  _pop3s._tcp    SRV 0 1 995 pop3.example.com.
 +
{{Note box|Cladav and cardav are not yet implemented for thunderbird xml autoconfig. It relies on RFC 6764, meaning only way is to use th SRV records.}}
 +
caldav with or without TLS , could use a TXT field too, if no txt value is present then client will check /.well-known/caldav
 +
_caldav._tcp    SRV 0 1 80 calendar.example.com.
 +
_caldavs._tcp    SRV 0 1 443 calendar.example.com.
 +
_caldav._tcp    TXT path=/caldav
 +
_caldavs._tcp    TXT path=/caldav
 +
 +
cardav ,  could use a TXT field too, if no txt value is present then client will check /.well-known/cardav
 +
_cardav._tcp    SRV 0 1 80 calendar.example.com.
 +
_cardavs._tcp    SRV 0 1 443 calendar.example.com.
 +
_cardav._tcp    TXT path=/caldav
 +
_cardavs._tcp  TXT path=/caldav
 +
 +
==== DNS and file for MTA-STS and TLS-RPT ====
 +
as you are there you can inform the worl you use along side with DKIM, SPF and DMARC properly configured this. See
  
 +
create a subdomain  ''mta-sts.yourdomain.com , make it point to your server, and set [[Letsencrypt|Let's Encrypt]] to create a certificate for it''
  
 +
fill the content  of the file /home/e-smith/files/ibays/Primary/''.well-known/mta-sts.txt with''<syntaxhighlight lang="console">
 +
version: STSv1
 +
mode: testing
 +
mx: yourdomain.com
 +
max_age: 604800
 +
</syntaxhighlight>fill the following records at your dns. (fill the id field with current timestamp, and update the domain/ email to your needs)<syntaxhighlight lang="console">
 +
_smtp._tls.yourdomain.com. 900 IN TXT "v=TLSRPTv1; rua=mailto:admin@yourdomain.com"
 +
_mta-sts.yourdomain.com. 900 IN TXT "v=STSv1; id=1575556993"
 +
</syntaxhighlight>
 +
 +
==== DNS and BIMI Record ====
 +
add a picture as svg accessible with your web srver, be sure DMARC fields are ok. and then file the DNS field, with the correct URL. You might need to check if your SVG is compatible <syntaxhighlight lang="console">
 +
default._bimi            IN TXT    "v=BIMI1; l=https://yourdomain.com/images/Logo.svg"
 +
</syntaxhighlight>you might also obtain a certificate for your logo after having validate your ownership see:  Verified Mark Certificates (VMC). As of 2023 this is a paid certificate for about 1500 USD a year, after registering for your trademark. So this will be kept out of scope of this page for the moment
 +
 +
# https://authindicators.github.io/rfc-brand-indicators-for-message-identification/
 +
# https://mxtoolbox.com/dmarc/bimi/how-to-create-bimi-record
 +
# https://bimigroup.org/using-the-rnc-schema-to-validate-bimi-svg-images/
 +
 +
==== DNS DKIM /SPF and DMARC ====
 +
see [[Email#DKIM Setup - qpsmtpd version .3E.3D 0.96]]
  
 
====DNS CNAME Record ====
 
====DNS CNAME Record ====
Line 152: Line 183:
  
 
===Sources===
 
===Sources===
* https://docs.microsoft.com/en-us/previous-versions/office/exchange-server-2007-technical-articles/bb332063(v=exchg.80)?redirectedfrom=MSDN#SupportedScenariosConnecting
+
Microsoft clients
* https://docs.microsoft.com/en-us/exchange/client-developer/exchange-web-services/autodiscover-for-exchange#options-for-using-autodiscover
+
*https://docs.microsoft.com/en-us/previous-versions/office/exchange-server-2007-technical-articles/bb332063(v=exchg.80)?redirectedfrom=MSDN#SupportedScenariosConnecting
* https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/soap-autodiscover-web-service-reference-for-exchange?redirectedfrom=MSDN
+
*https://docs.microsoft.com/en-us/exchange/client-developer/exchange-web-services/autodiscover-for-exchange#options-for-using-autodiscover
* https://docs.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxdscli/48d23e06-f884-44b5-993e-75b7a115827c
+
*https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/soap-autodiscover-web-service-reference-for-exchange?redirectedfrom=MSDN
* https://support.microsoft.com/en-us/topic/outlook-2016-implementation-of-autodiscover-0d7b2709-958a-7249-1c87-434d257b9087
+
*https://docs.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxdscli/48d23e06-f884-44b5-993e-75b7a115827c
* https://admx.help/HKCU/software/policies/microsoft/office/16.0/outlook/setup
+
*https://support.microsoft.com/en-us/topic/outlook-2016-implementation-of-autodiscover-0d7b2709-958a-7249-1c87-434d257b9087
* https://www.howto-outlook.com/howto/autodiscoverconfiguration.htm
+
*https://admx.help/HKCU/software/policies/microsoft/office/16.0/outlook/setup
* https://github.com/mailcow/mailcow-dockerized/blob/master/data/web/autodiscover-json.php
+
*https://www.howto-outlook.com/howto/autodiscoverconfiguration.htm
* https://github.com/mailcow/mailcow-dockerized/blob/master/data/web/inc/vars.inc.php
+
Multiple configuration
* https://forum.virtualmin.com/t/autodiscover-mail-settings-outlook/108570
+
*https://github.com/mailcow/mailcow-dockerized/blob/master/data/web/autodiscover-json.php
* https://github.com/mailcow/mailcow-dockerized/issues/615 (trouble with Outlook 2016)
+
*https://github.com/mailcow/mailcow-dockerized/blob/master/data/web/inc/vars.inc.php
* https://github.com/mailcow/mailcow-dockerized/blob/master/data/web/autodiscover.php
+
*https://forum.virtualmin.com/t/autodiscover-mail-settings-outlook/108570
* https://github.com/gronke/email-autodiscover/blob/master/mail/autodiscover.xml
+
*https://github.com/mailcow/mailcow-dockerized/issues/615 (trouble with Outlook 2016)
* https://mcmilk.de/projects/autoconfig/ (MS TB and Apple)
+
*https://github.com/mailcow/mailcow-dockerized/blob/master/data/web/autodiscover.php
 +
*https://github.com/gronke/email-autodiscover/blob/master/mail/autodiscover.xml
 +
*https://mcmilk.de/projects/autoconfig/ (MS TB and Apple)
 +
* https://roll.urown.net/server/mail/autoconfig.html
 +
* https://github.com/smartlyway/email-autoconfig-php
  
about new json file
+
about new MS json file
 
* https://blog.icewolf.ch/archive/2020/12/09/autodiscover-v2-json-requests.aspx (TODO create this file)
 
* https://blog.icewolf.ch/archive/2020/12/09/autodiscover-v2-json-requests.aspx (TODO create this file)
 
* https://github.com/mailcow/mailcow-dockerized/blob/master/data/web/autodiscover-json.php
 
* https://github.com/mailcow/mailcow-dockerized/blob/master/data/web/autodiscover-json.php
Line 173: Line 208:
 
* https://github.com/gronke/email-autodiscover/blob/master/settings.json.sample
 
* https://github.com/gronke/email-autodiscover/blob/master/settings.json.sample
 
* https://github.com/mailcow/mailcow-dockerized/pull/636
 
* https://github.com/mailcow/mailcow-dockerized/pull/636
 +
about Mozilla
 +
 +
* https://wiki.mozilla.org/Thunderbird:Autoconfiguration:ConfigFileFormat
 +
 +
generic
 +
 +
* https://datatracker.ietf.org/doc/html/rfc6764<!-- list of category you want to see this page in -->
  
<!-- list of category you want to see this page in -->
 
 
[[Category: Contrib]]
 
[[Category: Contrib]]
  
 
<!-- Please keep there the template revision  number as is -->
 
<!-- Please keep there the template revision  number as is -->
 
[[contribtemplate::2| ]]
 
[[contribtemplate::2| ]]
[[contriblang:: {{#var:lang}} | ]]
 

Latest revision as of 21:54, 13 December 2023




autodiscover
NeedImage.svg
autodiscover logo
MaintainerUnnilennium
Urlhttps://wiki.koozali.org/Autodiscover
LicenceGPL
Category

Mail

Tags autodiscoverEmailPOP3POP3SIMAPIMAPSSMTPautoconfigconfig-v1.1.xml


Maintainer

Jean-Philippe Pialasse

Version

Contrib 10:
smeserver-autodiscover
The latest version of smeserver-autodiscover is available in the SME repository, click on the version number(s) for more information.


Description

This contribs will deploy Microsoft Autodiscover and Mozilla autoconfig to configure your IMAP POP and SMTP accoutn to your mails clients. Plan is to also support creation of apple configuration file in the future.


Installation

prerequisite you need a valide SSL certificate, redirection might fails if https uses a non valid certificate, try Letsencrypt

yum --enablerepo=smecontribs install smeserver-autodiscover

Configuration

Client Side

Mozilla compatible products

Thunderbird, Evolution and any software compatible with the Mozilla Thunderbird .well-known/autoconfig/mail/config-v1.1.xml config file will work by just filling your email and password.

Outlook before 2016

Will also work out of the box by just filling your email and password.


Outlook 2016

Out of the box, it does not support IMAP POP3 and SMTP autodiscover, but only exchange type server. There are two methods you can use to workaround that. First is using the old style outlook profile configurator

C:\Program Files (x86)\Microsoft Office\root\Office16\OLCFG.EXE

then button email accounts or

C:\Program Files\Microsoft Office\root\Office16\OLCFG.EXE

then button email accounts

Second would be to force Outlook to use old detection configuration by manipulating Registry, as a priviledged user run in a windows shell:

reg add "HKEY_CURRENT_USER\SOFTWARE\Policies\Microsoft\Office\16.0\Outlook\setup /T REG_DWORD /F /V DisableOffice365SimplifiedAccountCreation /D 1"
Outlook 2019

Out of the box, it does not support IMAP POP3 and SMTP autodiscover, but only exchange type server. You will need to enable old Outlook 2016 accounts. see : https://wiki.contribs.org/Email#Outlook_365_.2F_Outlook_2019_IMAP_Configuration

alternatively the Outlook 2016 should work

C:\Program Files (x86)\Microsoft Office\root\Office19\OLCFG.EXE

then button email accounts or

C:\Program Files\Microsoft Office\root\Office19\OLCFG.EXE

then button email accounts

Second would be to force Outlook to use old detection configuration by manipulating Registry, as a priviledged user run in a windows shell:

reg add HKEY_CURRENT_USER\SOFTWARE\Policies\Microsoft\Office\19.0\Outlook\setup /T REG_DWORD /F /V DisableOffice365SimplifiedAccountCreation /D 1"
Outlook 365

Need testing,, does not support IMAP POP3 and SMTP autodiscover. Only exchange type server.

Outlook for Android

Need testing, but mostly work as Outlook 365.

Apple products

see bug https://bugs.koozali.org/show_bug.cgi?id=12100


DNS SRV Record alternate method

smtp

_smtp._tcp     SRV 0 1 25 mail.example.com.

smtps

_smtps._tcp     SRV 0 1 465 mail.example.com.

submission (not in use on SME)

_submission._tcp     SRV 0 1 587 mail.example.com.

imap

_imap._tcp     SRV 0 1 143 imap.example.com.
_imaps._tcp    SRV 0 1 993 imap.example.com.

pop3

_pop3._tcp     SRV 0 1 110 pop3.example.com.
_pop3s._tcp    SRV 0 1 995 pop3.example.com.
Important.png Note:
Cladav and cardav are not yet implemented for thunderbird xml autoconfig. It relies on RFC 6764, meaning only way is to use th SRV records.


caldav with or without TLS , could use a TXT field too, if no txt value is present then client will check /.well-known/caldav

_caldav._tcp     SRV 0 1 80 calendar.example.com.
_caldavs._tcp    SRV 0 1 443 calendar.example.com.
_caldav._tcp    TXT path=/caldav
_caldavs._tcp    TXT path=/caldav

cardav , could use a TXT field too, if no txt value is present then client will check /.well-known/cardav

_cardav._tcp     SRV 0 1 80 calendar.example.com.
_cardavs._tcp    SRV 0 1 443 calendar.example.com.
_cardav._tcp    TXT path=/caldav
_cardavs._tcp   TXT path=/caldav

DNS and file for MTA-STS and TLS-RPT

as you are there you can inform the worl you use along side with DKIM, SPF and DMARC properly configured this. See

create a subdomain mta-sts.yourdomain.com , make it point to your server, and set Let's Encrypt to create a certificate for it

fill the content of the file /home/e-smith/files/ibays/Primary/.well-known/mta-sts.txt with

version: STSv1 
mode: testing 
mx: yourdomain.com 
max_age: 604800

fill the following records at your dns. (fill the id field with current timestamp, and update the domain/ email to your needs)

_smtp._tls.yourdomain.com. 900 IN TXT "v=TLSRPTv1; rua=mailto:admin@yourdomain.com"
_mta-sts.yourdomain.com. 900 IN TXT "v=STSv1; id=1575556993"

DNS and BIMI Record

add a picture as svg accessible with your web srver, be sure DMARC fields are ok. and then file the DNS field, with the correct URL. You might need to check if your SVG is compatible

default._bimi             IN TXT    "v=BIMI1; l=https://yourdomain.com/images/Logo.svg"

you might also obtain a certificate for your logo after having validate your ownership see: Verified Mark Certificates (VMC). As of 2023 this is a paid certificate for about 1500 USD a year, after registering for your trademark. So this will be kept out of scope of this page for the moment

  1. https://authindicators.github.io/rfc-brand-indicators-for-message-identification/
  2. https://mxtoolbox.com/dmarc/bimi/how-to-create-bimi-record
  3. https://bimigroup.org/using-the-rnc-schema-to-validate-bimi-svg-images/

DNS DKIM /SPF and DMARC

see Email#DKIM Setup - qpsmtpd version .3E.3D 0.96

DNS CNAME Record

having a CNAME for autodiscover pointing to your server could help but is not mandatory.

Server Side

you can list the available configuration with the following command :

config show autodiscover

Some of the properties are not shown, but are defaulted in a template or a script. Here a more comprehensive list with default and expected values :

property default values
DocURL string url on your server without the domain, to point to your local documentation about your mail service for Thunderbird like configurations.
access private private, public
status enabled enabled,disabled


Uninstall

yum remove smeserver-autodiscover

Bugs

Please raise bugs under the SME-Contribs section in bugzilla

and select the smeserver-autodiscover component or use this link


Below is an overview of the current issues for this contrib:

IDProductVersionStatusSummary (2 tasks)
12104SME Contribs10.0CONFIRMEDNFR: support autodiscover v2 with json file
12100SME Contribs10.0CONFIRMEDNFR: apple mail autoconfig

Changelog

Only released version in smecontrib are listed here.

smeserver-autodiscover Changelog: SME 10 (smecontribs)
2022/07/13 Jean-Philippe Pialasse 1.0.0-1.sme
- initial release [SME: 10842]


Sources

Microsoft clients

Multiple configuration

about new MS json file

about Mozilla

generic