2016-09-18 17:51:31 +02:00
## An extensible mail notification daemon
2011-06-25 18:29:11 +02:00
2014-05-31 14:29:15 +02:00
Mailnag is a daemon program that checks POP3 and IMAP servers for new mail.
On mail arrival it performs various actions provided by plugins.
Mailnag comes with a set of desktop-independent default plugins for
visual/sound notifications, script execution etc. and can be extended
with additional plugins easily.
2011-06-26 14:54:53 +02:00
2015-12-28 18:34:06 +01:00
__This project needs your support!__
2015-12-29 12:29:36 +01:00
If you like Mailnag, please help to keep it going by [contributing code ](https://github.com/pulb/mailnag ),
[reporting/fixing bugs ](https://github.com/pulb/mailnag/issues ), [translating strings into your native language ](https://translations.launchpad.net/mailnag ),
[writing docs ](https://github.com/pulb/mailnag/wiki ) or by [making a donation ](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=8F5FNJ3U4N7AW ).
2012-05-15 20:31:54 +02:00
2015-12-28 18:34:06 +01:00
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=8F5FNJ3U4N7AW" target="_blank">
<img src="https://www.paypalobjects.com/en_US/GB/i/btn/btn_donateCC_LG.gif" alt="PayPal — The safer, easier way to pay online."/></a>
2014-05-30 22:35:16 +02:00
## Installation
### Ubuntu
Mailnag has an official [Ubuntu PPA ](https://launchpad.net/~pulb/+archive/mailnag ).
Issue the following commands in a terminal to enable the PPA and install Mailnag.
sudo add-apt-repository ppa:pulb/mailnag
sudo apt-get update
sudo apt-get install mailnag
As of Ubuntu 13.04 (Raring), Mailnag is also available in the official repos.
Run `sudo apt-get install mailnag` in a terminal to install it.
### Debian
2016-07-02 12:37:44 +02:00
Mailnag is available in Debian stable and unstable.
2014-05-30 22:35:16 +02:00
Run `sudo apt-get install mailnag` in a terminal to install it.
### Fedora
As of Fedora 17, Mailnag is available in the official Fedora repos.
Just run `yum install mailnag` (as root) in a terminal to install the package.
2014-06-01 13:59:46 +02:00
### Arch Linux
2018-02-16 16:11:54 +01:00
Mailnag is available in the official repos.
Please run `pacman -Syu mailnag` (as root) to install the package.
2014-06-01 13:59:46 +02:00
2016-09-28 18:56:25 +02:00
### openSUSE
Mailnag is available in openSUSE Tumbleweed.
Run `sudo zypper install mailnag` in a terminal to install it.
2014-05-30 22:35:16 +02:00
### Generic Tarballs
2019-03-24 13:34:16 +01:00
Distribution independent tarball releases are available [here ](https://github.com/pulb/mailnag/releases ).
2014-05-30 22:35:16 +02:00
Just run `./setup.py install` (as root) to install Mailnag,
though make sure the requirements stated below are met.
2012-01-21 13:00:13 +01:00
###### Requirements
2019-10-19 18:21:55 +02:00
* python3
2012-09-29 16:39:02 +02:00
* pygobject
2013-10-19 20:11:46 +02:00
* gir-notify (>= 0.7.6)
2014-06-21 12:07:59 +02:00
* gir-gtk-3.0
2014-06-21 13:37:50 +02:00
* gir-gdkpixbuf-2.0
2012-09-29 16:39:02 +02:00
* gir-glib-2.0
2014-06-23 22:03:56 +02:00
* gir-gst-plugins-base-1.0
2012-10-20 17:56:17 +02:00
* python-dbus
2012-09-29 16:39:02 +02:00
* pyxdg
* gettext
2015-01-27 17:07:28 +01:00
* gir-gnomekeyring-1.0 (optional)
2014-12-19 22:07:31 +01:00
* networkmanager (optional)
2011-06-25 18:29:11 +02:00
2012-05-15 20:31:54 +02:00
2011-11-28 18:35:30 +01:00
## Configuration
2013-08-05 21:11:42 +02:00
Run `mailnag-config` to setup Mailnag.
2012-09-29 16:39:02 +02:00
Closing the configuration window will start Mailnag automatically.
2011-06-25 18:29:11 +02:00
2012-01-21 13:00:13 +01:00
### Default Mail Client
2015-12-28 17:02:28 +01:00
Clicking a mail notification popup will open the default mail client specified in `GNOME Control Center -> Details -> Default Applications` .
2011-11-29 19:15:54 +01:00
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 ](http://gnome-gmail.sourceforge.net ).
2015-12-29 12:29:36 +01:00
### Desktop Integration
2013-10-20 11:41:34 +02:00
By default, Mailnag 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
2013-10-20 11:43:44 +02:00
extension/plugin for your desktop shell. Currently the following desktop shells are supported:
2013-10-20 11:42:43 +02:00
* GNOME-Shell ([GNOME-Shell extension ](https://github.com/pulb/mailnag-gnome-shell ))
2016-09-17 20:23:01 +02:00
* Ubuntu Unity ([MessagingMenu plugin ](https://github.com/pulb/mailnag-messagingmenu-plugin ))
* Elementary Pantheon ([MessagingMenu plugin ](https://github.com/pulb/mailnag-messagingmenu-plugin ))
* XFCE ([MessagingMenu plugin ](https://github.com/pulb/mailnag-messagingmenu-plugin ))
2015-12-31 13:37:58 +01:00
* Cinnamon ([Applet by hyOzd ](https://bitbucket.org/hyOzd/mailnagapplet ))
2015-01-31 15:22:47 +01:00
2015-01-31 15:21:55 +01:00
Furthermore, I highly recommend GNOME users to install the [GOA plugin ](https://github.com/pulb/mailnag-goa-plugin ),
2015-01-31 15:24:01 +01:00
which makes Mailnag aware of email accounts specified in GNOME Online Accounts.
2012-05-15 20:31:54 +02:00
2016-09-18 15:30:15 +02:00
### Troubleshooting
If Mailnag doesn't work properly for you, either examine the system log for errors (`journalctl -b _COMM=mailnag` )
or run `mailnag` in a terminal and observe the output.
