{"id":13897284,"url":"https://github.com/mkcms/maildirwatch","last_synced_at":"2025-07-31T09:32:01.906Z","repository":{"id":57439237,"uuid":"174993960","full_name":"mkcms/maildirwatch","owner":"mkcms","description":"Watch Maildir for new email and display notifications","archived":false,"fork":false,"pushed_at":"2024-04-05T21:17:52.000Z","size":39,"stargazers_count":4,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-25T03:32:11.525Z","etag":null,"topics":["email","maildir","notification","python"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mkcms.png","metadata":{"files":{"readme":"README.rst","changelog":"ChangeLog","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-03-11T12:19:08.000Z","updated_at":"2024-04-05T21:17:56.000Z","dependencies_parsed_at":"2024-06-08T23:41:44.607Z","dependency_job_id":null,"html_url":"https://github.com/mkcms/maildirwatch","commit_stats":{"total_commits":19,"total_committers":3,"mean_commits":6.333333333333333,"dds":"0.10526315789473684","last_synced_commit":"d7230b0fe93f0c15f3a189dc2eb492ec9145aa4f"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkcms%2Fmaildirwatch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkcms%2Fmaildirwatch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkcms%2Fmaildirwatch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkcms%2Fmaildirwatch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mkcms","download_url":"https://codeload.github.com/mkcms/maildirwatch/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228232974,"owners_count":17889025,"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":["email","maildir","notification","python"],"created_at":"2024-08-06T18:03:29.202Z","updated_at":"2024-12-05T04:22:35.854Z","avatar_url":"https://github.com/mkcms.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":".. image:: https://badge.fury.io/py/maildirwatch.svg\n    :target: https://badge.fury.io/py/maildirwatch\n\n=====================================================================\n maildirwatch - Watch Maildir for new mail and display notifications\n=====================================================================\n\nThis program allows you to watch a Maildir_ for incoming email and display\nnotifications when new messages arrive.\n\nThe displayed notifications are interactive - programs can be run when the user\nclicks on them.\n\nInstallation\n============\n\nInstallation from PyPI::\n\n  pip3 install --user maildirwatch\n\nPython3 is required.\n\n**Note**: PyGObject_ is a dependency of this program.  To install it, you might\nhave to install GObject development libraries on your system.  On Debian, the\npackages ``libgirepository1.0-dev`` and ``gir1.2-notify-0.7`` provide these\nlibraries.\n\nUsage\n=====\n\nUse the ``maildirwatch`` command, or::\n\n  python3 -m maildirwatch\n\nThe program will run forever or until you interrupt it with `Ctrl-C`.\n\nTo list available options, run::\n\n  maildirwatch --help\n\nConfiguration\n=============\n\nThe program looks for the configuration file in\n``$XDG_CONFIG_HOME/maildirwatch.conf`` or ``~/.config/maildirwatch.conf`` if\n``XDG_CONFIG_HOME`` is not defined.\n\nThe configuration file is in Python's standard config format (understood by the\n``configparser`` module).\n\nGlobal options\n--------------\n\nThese options should be put in the ``[global]`` section.\n\n* ``maildir``\n\n  The directory to scan for maildirs.  Default value: ``~/Maildir``.\n\n* ``ignore``\n\n  Comma-separated list of maildir patterns to ignore.  Each pattern must be in\n  fnmatch_ style.  By default, no maildirs are ignored.\n\n* ``whitelist``\n\n  Comma-separated list of maildir patterns to watch, even if they're matched by\n  ``ignore``.\n\n  You can explicitly select maildirs to watch by setting ``ignore`` to\n  ``**/**`` and ``whitelist`` to patterns that you want to watch,\n  e.g. ``*Inbox*,*Important*``.\n\n* ``inhibit-command``\n\n  Command to run to check if notifications should be inhibited.  If the command\n  exits with 0, the notification is NOT displayed and only a message is logged.\n  Otherwise the notification is displayed.\n\n  If this is undefined, notifications are always displayed.\n\nActions\n-------\n\nEach action is a path to a program and a list of arguments.  Every action also\nhas a name that is displayed to the user.\n\nActions are typically displayed as text buttons below the notification body.\nWhen the user clicks on the action button, the action program is started.\n\nAction definitions must be put in ``[actions]`` section.  Each action is\ndefined like this::\n\n  action name = /path/to/program arg1 arg2 arg3...\n\nOne action name is special - the ``default`` action.  The default action's\nvalue should be the name of another action instead of path to a program.  The\nprogram associated with default action is run when the user clicks on the\nnotification itself, not an action button.\n\nExample configuration\n---------------------\n\nBelow is an example configuration file that modifies path to the Maildir,\nignores spam folder, defines two actions and disables notifications if VLC is\nrunning::\n\n  [global]\n  maildir = ~/mail\n  ignore = *Spam,*foo/bar*\n  inhibit-command = pgrep vlc\n\n  [actions]\n  default = Show mu4e\n  Show mu4e = emacs -f mu4e\n  Start thunderbird = thunderbird\n\n\nLicense\n=======\n\n::\n\n   Copyright (C) 2019-2024 Michał Krzywkowski\n\n   This program is free software: you can redistribute it and/or modify\n   it under the terms of the GNU General Public License as published by\n   the Free Software Foundation, either version 3 of the License, or\n   (at your option) any later version.\n\n   This program is distributed in the hope that it will be useful,\n   but WITHOUT ANY WARRANTY; without even the implied warranty of\n   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n   GNU General Public License for more details.\n\n   You should have received a copy of the GNU General Public License\n   along with this program.  If not, see \u003chttps://www.gnu.org/licenses/\u003e.\n\n.. _Maildir: https://en.wikipedia.org/wiki/Maildir\n.. _PyGObject: https://pypi.org/project/PyGObject/\n.. _fnmatch: https://docs.python.org/3/library/fnmatch.html\n\n..\n   Local Variables:\n   coding: utf-8\n   fill-column: 79\n   End:\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkcms%2Fmaildirwatch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmkcms%2Fmaildirwatch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkcms%2Fmaildirwatch/lists"}