unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
blob 141e5cb93ba9198633b7663d2f6c881ae8a4f075 4671 bytes (raw)
name: doc/man1/notmuch-insert.rst 	 # note: path name is non-authoritative(*)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
.. _notmuch-insert(1):

==============
notmuch-insert
==============

SYNOPSIS
========

**notmuch** **insert** [option ...] [+<*tag*>|-<*tag*> ...]

DESCRIPTION
===========

**notmuch insert** reads a message from standard input and delivers it
into the maildir directory given by configuration option
:nmconfig:`database.mail_root`, then incorporates the message into the notmuch
database. It is an alternative to using a separate tool to deliver the
message then running :any:`notmuch-new(1)` afterwards.

The new message will be tagged with the tags specified by the
:nmconfig:`new.tags` configuration option, then by operations specified on the
command-line: tags prefixed by '+' are added while those prefixed by '-'
are removed.

If the new message is a duplicate of an existing message in the database
(it has same Message-ID), it will be added to the maildir folder and
notmuch database, but the tags will not be changed.

The **insert** command supports hooks. See :any:`notmuch-hooks(5)` for
more details on hooks.

Option arguments must appear before any tag operation arguments.
Supported options for **insert** include

.. program:: insert

.. option:: --folder=<folder>

   Deliver the message to the specified folder, relative to the
   top-level directory given by the value of :nmconfig:`database.mail_root`. The
   default is the empty string, which means delivering to the
   top-level directory.

.. option:: --create-folder

   Try to create the folder named by the ``--folder`` option, if it
   does not exist. Otherwise the folder must already exist for mail
   delivery to succeed.

.. option:: --keep

   Keep the message file if indexing fails, and keep the message
   indexed if applying tags or maildir flag synchronization
   fails. Ignore these errors and return exit status 0 to indicate
   successful mail delivery.

.. option:: --no-hooks

   Prevent hooks from being run.

.. option:: --world-readable

   When writing mail to the mailbox, allow it to be read by users
   other than the current user.  Note that this does not override
   umask.  By default, delivered mail is only readable by the current
   user.

.. option:: --emit-message-id

   If the message was successfully inserted into the database,
   print the message ID of the newly indexed message.

.. option:: --decrypt=(true|nostash|auto|false)

   If ``true`` and the message is encrypted, try to decrypt the
   message while indexing, stashing any session keys discovered.  If
   ``auto``, and notmuch already knows about a session key for the
   message, it will try decrypting using that session key but will
   not try to access the user's secret keys.  If decryption is
   successful, index the cleartext itself.  Either way, the message
   is always stored to disk in its original form (ciphertext).

   ``nostash`` is the same as ``true`` except that it will not stash
   newly-discovered session keys in the database.

   Be aware that the index is likely sufficient (and a stashed
   session key is certainly sufficient) to reconstruct the cleartext
   of the message itself, so please ensure that the notmuch message
   index is adequately protected. DO NOT USE ``--decrypt=true`` or
   ``--decrypt=nostash`` without considering the security of your
   index.

   See also :nmconfig:`index.decrypt` in :any:`notmuch-config(1)`.

CONFIGURATION
=============

Indexing is influenced by the configuration options
:nmconfig:`index.decrypt` and :nmconfig:`index.header.\<prefix\>`.  Tagging
is controlled by options :nmconfig:`new.tags` and
:nmconfig:`maildir.synchronize_flags`.  See
:any:`notmuch-config(1)` for details.

EXIT STATUS
===========

This command returns exit status 0 on successful mail delivery,
non-zero otherwise. The default is to indicate failed mail delivery on
any errors, including message file delivery to the filesystem, message
indexing to Notmuch database, changing tags, and synchronizing tags to
maildir flags. The ``--keep`` option may be used to settle for
successful message file delivery.

This command supports the following special exit status code for
errors most likely to be temporary in nature, e.g. failure to get a
database write lock.

``75 (EX_TEMPFAIL)``
    A temporary failure occurred; the user is invited to retry.

The exit status of the **post-insert** hook does not affect the exit
status of the **insert** command.

SEE ALSO
========

:any:`notmuch(1)`,
:any:`notmuch-config(1)`,
:any:`notmuch-count(1)`,
:any:`notmuch-dump(1)`,
:any:`notmuch-hooks(5)`,
:any:`notmuch-reply(1)`,
:any:`notmuch-restore(1)`,
:any:`notmuch-search(1)`,
:any:`notmuch-search-terms(7)`,
:any:`notmuch-show(1)`,
:any:`notmuch-tag(1)`

debug log:

solving 141e5cb9 ...
found 141e5cb9 in https://yhetil.org/notmuch/87a5fukvqo.fsf@denver.mail-host-address-is-not-set/
found e05bd0b5 in https://yhetil.org/notmuch.git/
preparing index
index prepared:
100644 e05bd0b5730507bd1bed22ee30016713ed36d569	doc/man1/notmuch-insert.rst

applying [1/1] https://yhetil.org/notmuch/87a5fukvqo.fsf@denver.mail-host-address-is-not-set/
diff --git a/doc/man1/notmuch-insert.rst b/doc/man1/notmuch-insert.rst
index e05bd0b5..141e5cb9 100644

Checking patch doc/man1/notmuch-insert.rst...
Applied patch doc/man1/notmuch-insert.rst cleanly.

index at:
100644 141e5cb93ba9198633b7663d2f6c881ae8a4f075	doc/man1/notmuch-insert.rst

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).