conf.d/15-mailboxes.conf

   1 ##
   2 ## Mailbox definitions
   3 ##
   4
   5 # Each mailbox is specified in a separate mailbox section. The section name
   6 # specifies the mailbox name. If it has spaces, you can put the name
   7 # "in quotes". These sections can contain the following mailbox settings:
   8 #
   9 # auto:
  10 #   Indicates whether the mailbox with this name is automatically created
  11 #   implicitly when it is first accessed. The user can also be automatically
  12 #   subscribed to the mailbox after creation. The following values are
  13 #   defined for this setting:
  14 #
  15 #     no        - Never created automatically.
  16 #     create    - Automatically created, but no automatic subscription.
  17 #     subscribe - Automatically created and subscribed.
  18 #
  19 # special_use:
  20 #   A space-separated list of SPECIAL-USE flags (RFC 6154) to use for the
  21 #   mailbox. There are no validity checks, so you could specify anything
  22 #   you want in here, but it's not a good idea to use flags other than the
  23 #   standard ones specified in the RFC:
  24 #
  25 #     \All      - This (virtual) mailbox presents all messages in the
  26 #                 user's message store.
  27 #     \Archive  - This mailbox is used to archive messages.
  28 #     \Drafts   - This mailbox is used to hold draft messages.
  29 #     \Flagged  - This (virtual) mailbox presents all messages in the
  30 #                 user's message store marked with the IMAP \Flagged flag.
  31 #     \Junk     - This mailbox is where messages deemed to be junk mail
  32 #                 are held.
  33 #     \Sent     - This mailbox is used to hold copies of messages that
  34 #                 have been sent.
  35 #     \Trash    - This mailbox is used to hold messages that have been
  36 #                 deleted.
  37 #
  38 # comment:
  39 #   Defines a default comment or note associated with the mailbox. This
  40 #   value is accessible through the IMAP METADATA mailbox entries
  41 #   "/shared/comment" and "/private/comment". Users with sufficient
  42 #   privileges can override the default value for entries with a custom
  43 #   value.
  44
  45 # NOTE: Assumes "namespace inbox" has been defined in 10-mail.conf.
  46 namespace inbox {
  47   # These mailboxes are widely used and could perhaps be created automatically:
  48   mailbox Drafts {
  49     special_use = \Drafts
  50   }
  51   mailbox Junk {
  52     special_use = \Junk
  53   }
  54   mailbox Trash {
  55     special_use = \Trash
  56   }
  57
  58   # For \Sent mailboxes there are two widely used names. We'll mark both of
  59   # them as \Sent. User typically deletes one of them if duplicates are created.
  60   mailbox Sent {
  61     special_use = \Sent
  62   }
  63   mailbox "Sent Messages" {
  64     special_use = \Sent
  65   }
  66
  67   # If you have a virtual "All messages" mailbox:
  68   #mailbox virtual/All {
  69   #  special_use = \All
  70   #  comment = All my messages
  71   #}
  72
  73   # If you have a virtual "Flagged" mailbox:
  74   #mailbox virtual/Flagged {
  75   #  special_use = \Flagged
  76   #  comment = All my flagged messages
  77   #}
  78 }