unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
blob e207d90b72020f0a94fa46c72702a34a6a1ddc35 10230 bytes (raw)
name: completion/zsh/_notmuch 	 # 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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
#compdef notmuch -p notmuch-*

# ZSH completion for `notmuch`
# Copyright © 2018 Vincent Breitmoser <look@my.amazin.horse>

_notmuch_command() {
  local -a notmuch_commands
  notmuch_commands=(
    'help:display documentation for a subcommand'
    'setup:interactively configure notmuch'

    'address:output addresses from matching messages'
    'compact:compact the notmuch database'
    'config:access notmuch configuration file'
    'count:count messages matching the given search terms'
    'dump:creates a plain-text dump of the tags of each message'
    'insert:add a message to the maildir and notmuch database'
    'new:incorporate new mail into the notmuch database'
    'reindex:re-index a set of messages'
    'reply:constructs a reply template for a set of messages'
    'restore:restores the tags from the given file (see notmuch dump)'
    'search:search for messages matching the given search terms'
    'show:show messages matching the given search terms'
    'tag:add/remove tags for all messages matching the search terms'
  )

  if ((CURRENT == 1)); then
    _describe -t commands 'notmuch command' notmuch_commands
  else
      local curcontext="$curcontext"
      cmd=$words[1]
      if (( $+functions[_notmuch_$cmd] )); then
        _notmuch_$cmd
      else
        _message -e "unknown command $cmd"
      fi
  fi
}

_notmuch_term_tag _notmuch_term_is () {
  local ret=1 expl
  local -a notmuch_tags

  notmuch_tags=( ${(f)"$(notmuch search --output=tags '*')"} )

  _description notmuch-tag expl 'tag'
  compadd "$expl[@]" -a notmuch_tags && ret=0
  return $ret
}

_notmuch_term_to _notmuch_term_from() {
  _email_addresses -c
}

_notmuch_term_mimetype() {
  local ret=1 expl
  local -a commontypes
  commontypes=(
    'text/plain'
    'text/html'
    'application/pdf'
  )
  _description typical-mimetypes expl 'common types'
  compadd "$expl[@]" -a commontypes && ret=0

  _mime_types && ret=0
  return $ret
}

_notmuch_term_path() {
  local ret=1 expl
  local maildir="$(notmuch config get database.mail_root)"
  [[ -d $maildir ]] || { _message -e "database.mail_root not found" ; return $ret }

  _description notmuch-folder expl 'maildir folder'
  _files "$expl[@]" -W $maildir -/ && ret=0
  return $ret
}

_notmuch_term_folder() {
  local ret=1 expl
  local maildir="$(notmuch config get database.mail_root)"
  [[ -d $maildir ]] || { _message -e "database.mail_root not found" ; return $ret }

  _description notmuch-folder expl 'maildir folder'
  local ignoredfolders=( '*/(cur|new|tmp)' )
  _files "$expl[@]" -W $maildir -F ignoredfolders -/ && ret=0
  return $ret
}

_notmuch_term_query() {
  local ret=1
  local line query_name
  local -a query_names query_content
  for line in ${(f)"$(notmuch config list | grep '^query.')"}; do
    query_name=${${line%%=*}#query.}
    query_names+=( $query_name )
    query_content+=( "$query_name = ${line#*=}" )
  done

  _description notmuch-named-query expl 'named query'
  compadd "$expl[@]" -d query_content -a query_names && ret=0
  return $ret
}

_notmuch_search_term() {
  local ret=1 expl match
  setopt localoptions extendedglob

  typeset -a notmuch_search_terms
  notmuch_search_terms=(
    'from' 'to' 'subject' 'attachment' 'mimetype' 'tag' 'id' 'thread' 'path' 'folder' 'date' 'lastmod' 'query' 'property'
  )

  if compset -P '(#b)([^:]#):'; then
    if (( $+functions[_notmuch_term_$match[1]] )); then
      _notmuch_term_$match[1] && ret=0
      return $ret
    elif (( $+notmuch_search_terms[(r)$match[1]] )); then
      _message "search term '$match[1]'" && ret=0
      return $ret
    else
      _message -e "unknown search term '$match[1]'"
      return $ret
    fi
  fi

  _description notmuch-term expl 'search term'
  compadd "$expl[@]" -S ':' -a notmuch_search_terms && ret=0

  if [[ $CURRENT -gt 1 && $words[CURRENT-1] != '--' ]]; then
    _description notmuch-op expl 'boolean operator'
    compadd "$expl[@]" -- and or not xor && ret=0
  fi

  return $ret
}

_notmuch_tagging_or_search() {
  setopt localoptions extendedglob
  local ret=1 expl
  local -a notmuch_tags

  # first arg that is a search term, or $#words+1
  integer searchtermarg=$(( $words[(I)--] != 0 ? $words[(i)--] : $words[(i)^(-|+)*] ))

  if (( CURRENT > 1 )); then
    () {
      local -a words=( $argv )
      local CURRENT=$(( CURRENT - searchtermarg + 1 ))
      _notmuch_search_term && ret=0
    } $words[searchtermarg,$]
  fi

  # only complete +/- tags if we're before the first search term
  if (( searchtermarg >= CURRENT )); then
    if compset -P '+'; then
      notmuch_tags=( ${(f)"$(notmuch search --output=tags '*')"} )
      _description notmuch-tag expl 'add tag'
      compadd "$expl[@]" -a notmuch_tags
      return 0
    elif compset -P '-'; then
      notmuch_tags=( ${(f)"$(notmuch search --output=tags '*')"} )
      _description notmuch-tag expl 'remove tag'
      compadd "$expl[@]" -a notmuch_tags
      return 0
    else
      _description notmuch-tag expl 'add or remove tags'
      compadd "$expl[@]" -S '' -- '+' '-' && ret=0
    fi
  fi

  return $ret
}

_notmuch_address() {
  _arguments -S \
    '--format=[set output format]:output format:(json sexp text text0)' \
    '--format-version=[set output format version]:format version: ' \
    '--sort=[sort results]:sorting:((newest-first\:"reverse chronological order" oldest-first\:"chronological order"))' \
    '--output=[select output format]:output format:(sender recipients count address)' \
    '--deduplicate=[deduplicate results]:deduplication mode:(no mailbox address)' \
    '--exclude=[respect excluded tags setting]:exclude tags:(true false)' \
    '*::search term:_notmuch_search_term'
}

_notmuch_compact() {
  _arguments \
    '--backup=[save a backup before compacting]:backup directory:_files -/' \
    '--quiet[do not print progress or results]'
}

_notmuch_count() {
  _arguments \
     - normal \
        '--lastmod[append lastmod and uuid to output]' \
        '--exclude=[respect excluded tags setting]:exclude tags:(true false)' \
        '--output=[select what to count]:output format:(messages threads files)' \
        '*::search term:_notmuch_search_term' \
    - batch \
      '--batch[operate in batch mode]' \
      '(--batch)--input=[read batch operations from file]:batch file:_files'
}

_notmuch_dump() {
  _arguments -S \
    '--gzip[compress output with gzip]' \
    '--format=[specify output format]:output format:(batch-tag sup)' \
    '*--include=[configure metadata to output (default all)]:metadata type:(config properties tags)' \
    '--output=[write output to file]:output file:_files' \
    '*::search term:_notmuch_search_term'
}

_notmuch_new() {
  _arguments \
    '--no-hooks[prevent hooks from being run]' \
    '--quiet[do not print progress or results]' \
    '--full-scan[don''t rely on directory modification times for scan]' \
    '--decrypt=[decrypt messages]:decryption setting:((false\:"never decrypt" auto\:"decrypt if session key is known (default)" true\:"decrypt using secret keys" stash\:"decrypt, and store session keys"))'
}

_notmuch_reindex() {
  _arguments \
    '--decrypt=[decrypt messages]:decryption setting:((false\:"never decrypt" auto\:"decrypt if session key is known (default)" true\:"decrypt using secret keys" stash\:"decrypt, and store session keys"))' \
    '*::search term:_notmuch_search_term'
}

_notmuch_search() {
  _arguments -S \
    '--max-threads=[display only the first x threads from the search results]:number of threads to show: ' \
    '--first=[omit the first x threads from the search results]:number of threads to omit: ' \
    '--sort=[sort results]:sorting:((newest-first\:"reverse chronological order" oldest-first\:"chronological order"))' \
    '--output=[select what to output]:output:(summary threads messages files tags)' \
    '*::search term:_notmuch_search_term'
}

_notmuch_show() {
  _arguments -S \
    '--entire-thread=[output entire threads]:show thread:(true false)' \
    '--format=[set output format]:output format:(text json sexp mbox raw)' \
    '--format-version=[set output format version]:format version: ' \
    '--part=[output a single decoded mime part]:part number: ' \
    '--verify[verify signed MIME parts]' \
    '--decrypt=[decrypt messages]:decryption setting:((false\:"never decrypt" auto\:"decrypt if session key is known (default)" true\:"decrypt using secret keys" stash\:"decrypt, and store session keys"))' \
    '--exclude=[respect excluded tags setting]:exclude tags:(true false)' \
    '--body=[output body]:output body content:(true false)' \
    '--include-html[include text/html parts in the output]' \
    '*::search term:_notmuch_search_term'
}

_notmuch_reply() {
  _arguments \
    '--format=[set output format]:output format:(default json sexp headers-only)' \
    '--format-version=[set output format version]:output format version: ' \
    '--reply-to=[specify recipient types]:recipient types:(all sender)' \
    '--decrypt=[decrypt messages]:decryption setting:((false\:"never decrypt" auto\:"decrypt if session key is known (default)" true\:"decrypt using secret keys"))' \
    '*::search term:_notmuch_search_term'
}

_notmuch_restore() {
  _arguments \
    '--acumulate[add data to db instead of replacing]' \
    '--format=[specify input format]:input format:(auto batch-tag sup)' \
    '*--include=[configure metadata to import (default all)]:metadata type:(config properties tags)' \
    '--input=[read from file]:notmuch dump file:_files'
}

_notmuch_tag() {
  _arguments \
    - normal \
      '--remove-all[remove all tags from matching messages]:*:search term:_notmuch_search_term' \
      '*::tag or search:_notmuch_tagging_or_search' \
    - batch \
      '--batch[operate in batch mode]' \
      '(--batch)--input=[read batch operations from file]:batch file:_files'
}

_notmuch() {
  if [[ $service == notmuch-* ]]; then
    local compfunc=_${service//-/_}
    (( $+functions[$compfunc] )) || return 1
    $compfunc "$@"
  else
    _arguments \
      '(* -)--help[show help]' \
      '(* -)--version[show version]' \
      '--config=-[specify config file]:config file:_files' \
      '--uuid=-[check against database uuid or exit]:uuid: ' \
      '*::notmuch commands:_notmuch_command'
  fi
}

_notmuch "$@"

debug log:

solving e207d90b ...
found e207d90b in https://yhetil.org/notmuch.git/

(*) 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).