IMAPROWL(1)

📦
version 1.2.1 · 4 versions
, in ubuntu noble, ubuntu questing

💖 IMAPROWL 💖

ok so bestie, welcome to the IMAProwl User Manual — this is the IMAPROWL(1) page, and honestly? it's giving "tiny script, huge main character energy". sit down, grab a boba, we're doing this 🧋✨

✨ NAME ✨

imaprowl — IMAP new mail notification utility for iPhone using Prowl Public API 💅

🌸 SYNOPSIS 🌸

imaprowl -c FILENAME [--config FILENAME] [{-q | --daemon}]
         [{-d | --debug}]

imaprowl [{-h | --help} | {-v | --version}]

🦋 DESCRIPTION 🦋

okay so real talk: this manual page is just a quick lil rundown of the imaprowl command. that's it. that's the vibe.

fun lore tho — this page was written for the Debian distribution because the original program literally does not have a manual page. so we made one. you're welcome. 🎀

imaprowl is an IMAP new mail notification utility for iPhone using Prowl Public API.

Prowl is a service and an App for iPhone's Push Notification service (APNs). See id1338 for more about Prowl. iykyk 🔥

IMAProwl is a utility script to notify new mail of IMAP server with Prowl service. It's very useful to push notification of GMail or any other IMAP mail service to your iPhone. literally so handy.

this program uses IMAP/IDLE (RFC2177) or IMAP/NOOP to check the new mail on IMAP server, and uses Prowl Public API via HTTPS. no cap. 👑

⭐ REQUIREMENTS ⭐

okay before you get all excited, you gotta have these. no skipping bestie 🫶

  • Ruby script language version >= 1.9.0
  • OpenSSL extension library for Ruby
  • IMAP server must support SSL/TLS connection.
  • The Prowl service account. It's free, you can register at http://prowl.weks.net/ ✨
  • Your iPhone and the Prowl.app from AppStore 📱

💅 OPTIONS 💅

so the program follows the usual GNU command line syntax, with long options starting with two dashes (`-`). a summary of options is included below. slay:

  • -c FILENAME, --config FILENAME — Configuration file to load. 🗂️
  • -q, --daemon — Enable daemon mode. imaprowl will launch as background process. 🌙
  • -d, --debug — Enable debug output. 🐛
  • -h, --help — Show summary of options. 🆘
  • -v, --version — Show version of program. 🏷️

🎀 FILES 🎀

  • ${HOME}/.imaprowl.conf — The per-user configuration file to control the behaviour of imaprowl. See /usr/share/doc/imaprowl/examples/config.yml for further details. 📄

😭 ISSUES 😭

ngl there's some stuff to know:

👑 AUTHOR 👑

Takuo Kitame <kitame@debian.org> Wrote this manpage for the Debian system. 🫡

Copyright © 2009 Takuo Kitame

This manual page was written for the Debian system (and may be used by others).

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or (at your option) any later version published by the Free Software Foundation.

On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.

and that's the whole page bestie, you ate that 💖

okay bye, this was imaprowl, from the IMAPROWL(1) manual, dated 03/23/2024 — go forth and get your notifications, periodt 🦋✨💅

📦 where this page comes from