Arsnael commented on a change in pull request #882: URL: https://github.com/apache/james-project/pull/882#discussion_r802488462
########## File path: examples/imap-autoconf/README.adoc ########## @@ -0,0 +1,86 @@ += Auto-configuration of Mail User Agents + +== RFC-6186 use of SRV records + +link:https://tools.ietf.org/html/rfc6186[RFC-6186] defines the usage of SRV records in order +to help users configuring their Mail User Agents in order to access your service, as it allows +to locate your services (hostnames and ports). + +You would then need to publish SRV records on your DNS. + +---- +_imaps._tcp.domain.tld. 3600 IN SRV 0 1 993 imap.domain.tld. +_submission._tcp.domain.tld. 3600 IN SRV 0 1 587 smtp.domain.tld. +_jmap._tcp.domain.tld. 3600 IN SRV 0 1 443 jmap.domain.tld. +---- + +== Thunderbird + +Thunderbird relies on a custom XML payload being served on a subdomain. + +For `[email protected]` an HTTP GET request would be done at `http://autoconfig.domain.tld/mail/config-v1.1.xml` + +You could for instance serve the following XML payload: + +[xml] +---- +<clientConfig version="1.1"> + <emailProvider id="MessagingEngine"> + <domain>domain.tld</domain> + <displayName>My company</displayName> + <displayShortName>My company</displayShortName> + <incomingServer type="imap"> + <hostname>imap.domain.tld</hostname> + <port>993</port> + <socketType>SSL</socketType> + <authentication>password-cleartext</authentication> + <username>%EMAILADDRESS%</username> + </incomingServer> + <outgoingServer type="smtp"> + <hostname>smtp.domain.tld</hostname> + <port>465</port> + <socketType>SSL</socketType> + <authentication>password-cleartext</authentication> + <username>%EMAILADDRESS%</username> + </outgoingServer> + </emailProvider> +</clientConfig> +---- + +== JMAP + +link:https://datatracker.ietf.org/doc/html/rfc8620[RFC-8620] defining JMAP core RFC defines precisely service location. + +James already redirects `http://jmap.domain.tld/.well-known/jmap` to the JMAP session. + +You can further help your clients by publishing extra SRV records (see above). + +== Example + +We ship a little example hereby to ease set up. + +It is comprised of a docker-compose starting a James and a side container to serve Thunderbird auto-configuration. + + - 1. Start the docker-compose + +---- +docker-compose up +---- + + - 2. Create `domain.tld` and a user `[email protected]` with a strong password (`123456`) Review comment: Strong password indeed :D ########## File path: examples/imap-autoconf/docker-compose.yml ########## @@ -0,0 +1,21 @@ +version: '3' + +services: + + james: + image: apache/james:memory-latest + container_name: james + hostname: james.local + volumes: + - ./keystore:/root/conf/keystore + ports: + - "587:587" Review comment: shouldn't it be 465 (ssl smtp port)? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
