github-com-docker-mailserver/docker-mailserver
1
0
Fork 0
mirror of https://github.com/docker-mailserver/docker-mailserver.git synced 2024-01-19 02:48:50 +00:00
Code Issues Projects Releases Wiki Activity
docker-mailserver/docs/content/examples/uses-cases/imap-folders.md
hnws 630e083c9a
docs: Add example for customizing IMAP folders (#2045) 
* docs: Add example for customizing IMAP folders (mailboxes)

* chore: Update `15-mailboxes.conf` to sync with upstream

This config has not been updated since 2016 (ignoring the Junk autosubscribe addition).

Synced to upstream equivalent at https://github.com/dovecot/core/blob/master/doc/example-config/conf.d/15-mailboxes.conf

Retains the `Archive` example definition from this PR and prior `auto = subscribe` additions.

---

Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
2021-06-23 10:28:43 +12:00

4.4 KiB
Raw Blame History

title hide
Use Cases | Customize Mailbox Folders
toc

Mailboxes (aka IMAP Folders)

INBOX is setup as the private inbox namespace. By default target/dovecot/15-mailboxes.conf configures the special IMAP folders Drafts, Sent, Junk and Trash to be automatically created and subscribed. They are all assigned to the private inbox namespace (which implicitly provides the INBOX folder).

These IMAP folders are considered special because they add a "SPECIAL-USE" attribute, which is a standardized way to communicate to mail clients that the folder serves a purpose like storing spam/junk mail (\Junk) or deleted mail (\Trash). This differentiates them from regular mail folders that you may use for organizing.

Adding a mailbox folder

See target/dovecot/15-mailboxes.conf for existing mailbox folders which you can modify or uncomment to enable some other common mailboxes. For more information try the official Dovecot documentation.

The Archive special IMAP folder may be useful to enable. To do so, make a copy of target/dovecot/15-mailboxes.conf and uncomment the Archive mailbox definition. Mail clients should understand that this folder is intended for archiving mail due to the \Archive "SPECIAL-USE" attribute.

With the provided docker-compose.yml example, a volume bind mounts the host directory config to the container location /tmp/docker-mailserver. Config file overrides should instead be mounted to a different location as described in Overriding Configuration for Dovecot:

volumes:
  ...
  - ./config/dovecot/15-mailboxes.conf:/etc/dovecot/conf.d/15-mailboxes.conf:ro

Caution

Adding folders to an existing setup

Handling of newly added mailbox folders can be inconsistent across mail clients:

  • Users may experience issues such as archived emails only being available locally.
  • Users may need to migrate emails manually between two folders.

Support for SPECIAL-USE attributes

Not all mail clients support the SPECIAL-USE attribute for mailboxes (defined in RFC 6154). These clients will treat the mailbox folder as any other, using the name assigned to it instead.

Some clients may still know to treat these folders for their intended purpose if the mailbox name matches the common names that the SPECIAL-USE attributes represent (eg Sent as the mailbox name for \Sent).

Internationalization (i18n)

Usually the mail client will know via context such as the SPECIAL-USE attribute or common English mailbox names, to provide a localized label for the users preferred language.

Take care to test localized names work well as well.

Email Clients Support

  • If a new mail account is added without the SPECIAL-USE attribute enabled for archives:
    • Thunderbird suggests and may create an Archives folder on the server.
    • Outlook for Android archives to a local folder.
    • Spark for Android archives to server folder named Archive.
  • If a new mail account is added after the SPECIAL-USE attribute is enabled for archives:
    • Thunderbird, Outlook for Android and Spark for Android will use the mailbox folder name assigned.

!!! caution "Windows Mail"

**Windows Mail** has been said to ignore `SPECIAL-USE` attribute and look only at the mailbox folder name assigned.

!!! note "Needs citation"

This information is provided by the community.

It presently lacks references to confirm the behaviour. If any information is incorrect please let us know! :smile: