Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mikkun/imap-email-notifier
Email notifier for IMAP mailboxes
https://github.com/mikkun/imap-email-notifier
email imap perl perl-script smtp
Last synced: 8 days ago
JSON representation
Email notifier for IMAP mailboxes
- Host: GitHub
- URL: https://github.com/mikkun/imap-email-notifier
- Owner: mikkun
- License: artistic-2.0
- Created: 2023-09-14T15:25:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-14T08:15:16.000Z (about 1 month ago)
- Last Synced: 2024-12-14T09:20:25.717Z (about 1 month ago)
- Topics: email, imap, perl, perl-script, smtp
- Language: Perl
- Homepage:
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# imap-email-notifier
> :mailbox: Email notifier for IMAP mailboxes
## Description
This script connects to an IMAP server, retrieves unread messages from specified folders, and sends notification emails about new unread messages via an SMTP server.
## Requirements
- [Perl](https://www.perl.org/) (>= 5.12.0)
- [cpanm](https://github.com/miyagawa/cpanminus)
- [Carton](https://github.com/perl-carton/carton)
- [OpenSSL](https://www.openssl.org/)/[LibreSSL](https://www.libressl.org/) headers
- [zlib](https://zlib.net/) headers
## Installation
### Install the build dependencies
```shell
# Debian-based distributions
sudo apt install build-essential
sudo apt install libssl-dev zlib1g-dev
# Fedora-based distributions
sudo dnf groupinstall "Development Tools" "Development Libraries"
sudo dnf install openssl-devel zlib-devel
# Arch-based distributions
sudo pacman -S base-devel
sudo pacman -S openssl zlib
```
### Install cpanm
```shell
# Debian-based distributions
sudo apt install cpanminus
# Fedora-based distributions
sudo dnf install cpanminus
# Arch-based distributions
sudo pacman -S cpanminus
```
### Install Carton
```shell
sudo cpanm Carton
```
### Clone the repository
```shell
git clone https://github.com/mikkun/imap-email-notifier.git
```
### Install dependent modules
```shell
cd imap-email-notifier
carton install --deployment
```
## Usage
```shell
./imap-email-notifier.pl
```
## Options
There are no command-line options for this script. Configuration should be done within the script.
## Configuration
The configuration information is stored in the `$CONFIG` hash within the script.
## License
[Artistic License 2.0](./LICENSE)
## Author
[KUSANAGI Mitsuhisa](https://github.com/mikkun)
## References
- [Mail::IMAPClient](https://metacpan.org/pod/Mail::IMAPClient)
- [Net::SMTP](https://metacpan.org/pod/Net::SMTP)