{"id":13547915,"url":"https://github.com/tsto/notmuchfs","last_synced_at":"2025-04-02T20:31:11.166Z","repository":{"id":4854207,"uuid":"6008760","full_name":"tsto/notmuchfs","owner":"tsto","description":"A virtual maildir file system for notmuch queries","archived":false,"fork":false,"pushed_at":"2018-10-10T23:40:51.000Z","size":41,"stargazers_count":91,"open_issues_count":4,"forks_count":11,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-11-03T16:37:57.920Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"wildabeast/BarcodeScanner","license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tsto.png","metadata":{"files":{"readme":"README.MUTT.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-09-29T12:03:41.000Z","updated_at":"2024-10-30T12:56:14.000Z","dependencies_parsed_at":"2022-09-04T18:21:46.151Z","dependency_job_id":null,"html_url":"https://github.com/tsto/notmuchfs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tsto%2Fnotmuchfs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tsto%2Fnotmuchfs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tsto%2Fnotmuchfs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tsto%2Fnotmuchfs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tsto","download_url":"https://codeload.github.com/tsto/notmuchfs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246887944,"owners_count":20850170,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T12:01:03.115Z","updated_at":"2025-04-02T20:31:08.548Z","avatar_url":"https://github.com/tsto.png","language":"C","readme":"notmuchfs - A virtual maildir file system for notmuch queries\n=============================================================\n\nNotmuchfs is free software, released under the GNU General Public\nLicense version 3 (or later).\n\nCopyright © 2012 Tim Stoakes\n\n\nQuick start - using notmuchfs with mutt\n---------------------------------------\nSuper quick start:\n* Add 'notmuchfs/mutt/bin' to $PATH.\n* Add 'source /path/to/notmuchfs/mutt/.muttrc' to the top of your '.muttrc', and\n  edit that file to taste, etc.\n* Mount notmuchfs, being sure to pass the option '-o mutt_2476_workaround'.\n* Run mutt!\n\n\nLonger - using notmuchfs with mutt\n----------------------------------\nNotmuchfs was developed because I wanted to use mutt with notmuch, but the mutt\ncodebase was... difficult.\n\nMutt understands maildirs, so the simplest thing I could think of was to\nemulate maildirs on top of notmuch, and point mutt at them. See mutt/.muttrc\nfor a complete example.\n\nIt is assumed that notmuchfs is up and running already. If not, get started\nby reading README.md, for example:\n\n~~~ sh\n  $ mkdir ~/my_notmuchfs_backing\n  $ cd ~/my_notmuchfs_mountpoint\n  $ mkdir \"tag:unread and not tag:spam\"\n  $ ln -s \"tag:unread and not tag:spam\" inbox\n  $ notmuchfs ~/my_notmuchfs_mountpoint \\\n      -o backing_dir=~/my_notmuchfs_backing \\\n      -o mail_dir=~/.maildir \\\n      -o mutt_2476_workaround\n~~~\n\nNow, just like any other maildir, simply point the 'folder' variable at\nnotmuchfs and our new notmuchfs inbox:\n\n~~~\n  set folder=~/my_notmuchfs_mountpoint/\n  set spoolfile=+inbox/\n~~~\n\nWhen the search results have changed e.g. delivery of new mail, mutt will not\nautomatically notice. So we need to reload the inbox - with a handy macro such\nas:\n~~~\n  macro index \"#\" '\u003csync-mailbox\u003e\u003cchange-folder\u003e^\u003center\u003e' \"Reload mailbox\"\n~~~\n\nIt may be nice to colorise messages with particular flags in the index,\nperhaps something like:\n~~~\n  color index    red      default        \"~h '^X-Label: .*interesting_tag.*$'\"\n~~~\n\n\nThis is however, essentially read-only - not so useful.\n\n\n(The following section assumes that notmuchfs/mutt/bin/ is in your $PATH, and\n'formail' is installed on the system.)\n\nRemembering that notmuchfs queries are just directories, making a new search is\nsimple. With a macro like this, use the included 'mutt/bin/prompt_mkdir' script\nto create new query directories from within mutt:\n\n~~~\n  macro index \"S\" \"\u003cshell-escape\u003eprompt_mkdir $folder \u003center\u003e\u003cchange-folder\u003e?\" \"Create a new notmuchfs query mailbox\"\n~~~\n\n\n\nNow we need a way to modify the tags on messages. Again, with a macro like\nthis, use the included 'notmuch_tag' script to alter the tags on a single\nmessage, or a (mutt) tagged set of messages interactively:\n\n~~~\n  macro index,pager \",T\" \"\u003cpipe-message\u003eformail -d -xMessage-id: -s | tr -d \\\"\u003c\u003e\\\" | notmuch_tag\u003center\u003e\" \"Manage notmuch tags\"\n~~~\n\nFind yourself entering the same interactive tag modifications over and over?\nPerhaps add new macros to taste:\n\n~~~\n  macro index,pager \",tw\"   \"\u003cpipe-message\u003eformail -d -xMessage-id: -s | tr -d \\\"\u003c\u003e\\\" | notmuch_tag +watch\u003center\u003e\" \"Add 'watch' tag\"\n~~~\n\n\n\nMutt bug 2476\n-------------\nMutt is not compliant with the maildir specification, see:\n* http://dev.mutt.org/trac/ticket/2476\n* http://notmuchmail.org/pipermail/notmuch/2011/004833.html\n\nNotmuchfs can work around this issue, if mounted with the\n~~~ sh\n  '-o mutt_2476_workaround'\n~~~\nmount option. If you use mutt, you want to use this option. Mutt is basically\nunusable without it.\n\n","funding_links":[],"categories":["C","others"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftsto%2Fnotmuchfs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftsto%2Fnotmuchfs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftsto%2Fnotmuchfs/lists"}