Skip to content

tikank/mailnagger

Repository files navigation

Mailnagger

An extensible mail notification daemon

Mailnagger is a daemon program that checks POP3 and IMAP servers for new mail. On mail arrival it performs various actions provided by plugins. Mailnagger comes with a set of desktop-independent default plugins for visual/sound notifications, script execution etc. and can be extended with additional plugins easily.

Mailnagger is a fork of Mailnag.

This project needs your support!

If you like Mailnagger, please help to keep it going by contributing code, reporting/fixing bugs, translating strings into your native language, or writing docs.

Installation

Easiest way to install Mailnagger from PyPI is to use pipx.

Run

    pipx install mailnagger

though make sure the requirements stated below are met.

Requirements

  • python (>= 3.9)
  • pygobject
  • gir-notify (>= 0.7.6)
  • gir-gtk-3.0
  • gir-gdkpixbuf-2.0
  • gir-glib-2.0
  • gir-gst-plugins-base-1.0
  • python-dbus
  • pyxdg
  • gettext
  • gir1.2-secret-1 (optional)

Configuration

Run mailnagger-config to setup Mailnagger.

Closing the configuration window will start Mailnagger automatically.

Note: Mailnagger uses same configuration files and secret storage as Mailnag. They are currently compatible, but there will be someday some kind of migration to Mailnagger's own configuration files.

Default Mail Client

Clicking a mail notification popup will open the default mail client specified in GNOME Control Center -> Details -> Default Applications. If you're a webmail (e.g. gmail) user and want your account to be launched in a browser, please install a tool like gnome-gmail.

Desktop Integration

By default, Mailnagger emits libnotify notifications, which work fine on most desktop environments but are visible for a few seconds only. If you like to have a tighter desktop integration (e.g. a permanently visible indicator in your top panel) you have to install an appropriate extension/plugin for your desktop shell.

Mailnag has following desktop extensions:

Since Mailnagger is essentially same as Mailnag, those extensions should/might work with Mailnagger.

Furthermore, GNOME users can also install the GOA plugin, which makes Mailnagger aware of email accounts specified in GNOME Online Accounts.

Troubleshooting

Gmail doesn't work

If Mailnagger is unable to connect to your Gmail account, please try the following solutions:

  • Install the GOA plugin to connect via GNOME online accounts
  • Have a look at the FAQ
  • Try to apply this workaround

Other issues

If Mailnagger doesn't work properly for you, either examine the system log for errors (journalctl -b _COMM=mailnagger) or run mailnagger in a terminal and observe the output.