imap-mailbox-exporter

Imap Mailbox Exporter

Export the amount of mails in a mailbox for use in prometheus.

Usage

Configuration

IMAP_SERVER=""
IMAP_USERNAME=""
IMAP_PASSWORD=""

Probe

http://127.0.0.1:9101/probe?target=INBOX

Provided metrics

# HELP probe_mailbox_count Displays the count of mails found in the mailbox
# TYPE probe_mailbox_count gauge
probe_mailbox_count 0

Example Usage

You can find a example docker compose configuration.

Make sure to update examples/imap-exporter.env with your imap credentials.

Start the example container

pushd examples

docker compose pull
docker compose up -d

License

This project is licensed under the MIT License