unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
blob 3e6f538d4aac81287650672078b4ec1ff2bd23af 3739 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
 
==============
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
**database.path**, then incorporates the message into the notmuch
database. It is an alternative to using a separate tool to deliver the
message then running **notmuch new** afterwards.

The new message will be tagged with the tags specified by the
**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 **notmuch-hooks(5)** for
more details on hooks.

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

    ``--folder=<``\ folder\ **>**
        Deliver the message to the specified folder, relative to the
        top-level directory given by the value of **database.path**. The
        default is to deliver to the top-level directory.

    ``--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.

    ``--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.

    ``--no-hooks``
        Prevent hooks from being run.

    ``--try-decrypt=(true|auto|false)``

        If ``true`` and the message is encrypted, try to decrypt the
        message while indexing, storing 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).

        Be aware that the index is likely sufficient to reconstruct
        the cleartext of the message itself, so please ensure that the
        notmuch message index is adequately protected. DO NOT USE
        ``--try-decrypt=true`` without considering the security of
        your index.

        See also ``index.try_decrypt`` in **notmuch-config(1)**.

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
========

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

debug log:

solving 3e6f538d ...
found 3e6f538d in https://yhetil.org/notmuch/20171025065203.24403-16-dkg@fifthhorseman.net/
found a5505b5b in https://yhetil.org/notmuch/20171025065203.24403-12-dkg@fifthhorseman.net/
found e2bf37d0 in https://yhetil.org/notmuch.git/
preparing index
index prepared:
100644 e2bf37d04c79e49f6a8127bf36949a84470d2f86	doc/man1/notmuch-insert.rst

applying [1/2] https://yhetil.org/notmuch/20171025065203.24403-12-dkg@fifthhorseman.net/
diff --git a/doc/man1/notmuch-insert.rst b/doc/man1/notmuch-insert.rst
index e2bf37d0..a5505b5b 100644


applying [2/2] https://yhetil.org/notmuch/20171025065203.24403-16-dkg@fifthhorseman.net/
diff --git a/doc/man1/notmuch-insert.rst b/doc/man1/notmuch-insert.rst
index a5505b5b..3e6f538d 100644

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

index at:
100644 3e6f538d4aac81287650672078b4ec1ff2bd23af	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).