git.notmuchmail.org Git - notmuch/blob - test/setup.expected-output/config-with-comments

   1 # .notmuch-config - Configuration file for the notmuch mail system
   2 #
   3 # For more information about notmuch, see https://notmuchmail.org
   4 # Database configuration
   5 #
   6 # The only value supported here is 'path' which should be the top-level
   7 # directory where your mail currently exists and to where mail will be
   8 # delivered in the future. Files should be individual email messages.
   9 # Notmuch will store its database within a sub-directory of the path
  10 # configured here named ".notmuch".
  11 #
  12 [database]
  13 path=/path/to/maildir
  14 # User configuration
  15 #
  16 # Here is where you can let notmuch know how you would like to be
  17 # addressed. Valid settings are
  18 #
  19 #       name            Your full name.
  20 #       primary_email   Your primary email address.
  21 #       other_email     A list (separated by ';') of other email addresses
  22 #                       at which you receive email.
  23 #
  24 # Notmuch will use the various email addresses configured here when
  25 # formatting replies. It will avoid including your own addresses in the
  26 # recipient list of replies, and will set the From address based on the
  27 # address to which the original email was addressed.
  28 #
  29 [user]
  30 name=Test Suite
  31 primary_email=test.suite@example.com
  32 other_email=another.suite@example.com
  33 # Configuration for "notmuch new"
  34 #
  35 # The following options are supported here:
  36 #
  37 #       tags    A list (separated by ';') of the tags that will be
  38 #               added to all messages incorporated by "notmuch new".
  39 #
  40 #       ignore  A list (separated by ';') of file and directory names
  41 #               that will not be searched for messages by "notmuch new".
  42 #
  43 #               NOTE: *Every* file/directory that goes by one of those
  44 #               names will be ignored, independent of its depth/location
  45 #               in the mail store.
  46 #
  47 [new]
  48 tags=foo;bar;
  49 # Search configuration
  50 #
  51 # The following option is supported here:
  52 #
  53 #       exclude_tags
  54 #               A ;-separated list of tags that will be excluded from
  55 #               search results by default.  Using an excluded tag in a
  56 #               query will override that exclusion.
  57 #
  58 [search]
  59 exclude_tags=baz
  60 # Maildir compatibility configuration
  61 #
  62 # The following option is supported here:
  63 #
  64 #       synchronize_flags      Valid values are true and false.
  65 #
  66 #       If true, then the following maildir flags (in message filenames)
  67 #       will be synchronized with the corresponding notmuch tags:
  68 #
  69 #               Flag    Tag
  70 #               ----    -------
  71 #               D       draft
  72 #               F       flagged
  73 #               P       passed
  74 #               R       replied
  75 #               S       unread (added when 'S' flag is not present)
  76 #
  77 #       The "notmuch new" command will notice flag changes in filenames
  78 #       and update tags, while the "notmuch tag" and "notmuch restore"
  79 #       commands will notice tag changes and update flags in filenames
  80 #
  81 [maildir]