managesieve(3)

💖 NAME — managesieve(3) 💖

okay bestie, you're on the managesieve(3) page from User Contributed Perl Documentation, and the module is Cyrus::SIEVE::managesieve — a Perl client for the SIEVE protocol. slay. 💅

✨ SYNOPSIS ✨

use Cyrus::SIEVE::managesieve;

🦋 DESCRIPTION 🦋

This is a Perl module that gives you a client for the SIEVE protocol. It supports SASL authentication and communication encryption, using the Cyrus SASL infrastructure. iconic, honestly. ✨

It provides the following functions. 👑

• sieve_get_handle($servername, &username_cb, &authname_cb, &password_cb, &realm_cb) — creates and returns a new Sieve object you can use for communicating with the SIEVE server. The server is connected to and a login sequence is performed, using some combination of the given callbacks to fetch from the calling program any data needed for authentication. main character energy.
  • The servername may take any of these forms, fr fr:
    • hostname
    • hostname:port
    • ipv4address
    • ipv4address:port
    • [ipv6address]
    • [ipv6address]:port
  • If not explicitly specified in the servername, the port defaults to the port named "sieve" in the client machine's service database (for example the "/etc/services" files), or 4190. 🫶
  • All the callbacks are called with the following arguments: $string = callback($which, $prompt); where $which is one of the strings "username", "authname", "getpass", or "realm" respectively, and $prompt is a human-readable English language prompt string for the user's benefit. Each callback should return a string containing the required information. 💖
  • The function will return undef on error, so use sieve_get_global_error to get a description of the error. important, bestie!
• sieve_get_error($sieveobj) — returns a human-readable English language string describing the last error encountered on the object $sieveobj. oof, error lore. 💔
• sieve_get_global_error() — returns a human-readable English language string describing the last error encountered while creating a Sieve object. global error check, no cap. ⚠️
• sieve_logout($sieveobj) — logs out from the SIEVE server.

after this, $sieveobj will become unusable. do not touch it after logout, bestie. 💀

• sieve_put_file($sieveobj, $filename) — installs a SIEVE script contained in a local file named by $filename to the server. The name of the script on the server will be the basename of $filename. Returns zero on success and non-zero on failure. 📥
• sieve_put_file_withdest($sieveobj, $filename, $destname) — like sieve_put_file but also specifies the name of the file on the server. Any directory part of $destname is ignored. same vibe, custom destination. 🎀
• sieve_put($sieveobj obj, $name, $data) — installs a SIEVE script contained in the scalar $data to the server, with the script name $name. Returns zero on success and non-zero on failure. 🧚
• sieve_delete($sieveobj obj, $name) — removes a SIEVE script from the server. Returns zero on success and non-zero on failure. 🗑️
• sieve_list($sieveobj obj, &callback) — lists existing SIEVE scripts on the server. The &callback returns no value and is called once for each script on the server, with arguments callback($name, $is_active). sieve_list returns zero on success and non-zero on failure. listing era. 📋
• sieve_activate($sieveobj, $name) — makes the script named $name the active script on the server. Only one script is active at a time; activating a script de-activates any others. Returns zero on success and non-zero on failure. one active script at a time, periodt. 👑
• sieve_get($sieveobj, $name, $output) — retrieves the SIEVE script named <$name> from the server, and stores it in the scalar $output. Returns zero on success and non-zero on failure. grab that script. 🍓

🎀 AUTHOR 🎀

Big shoutout to T. Martin, tmartin@andrew.cmu.edu. 💖

🌈 SEE ALSO 🌈

RFC5804, A Protocol for Remotely Managing Sieve Scripts. go read it, iykyk. 📖✨

okay that's the whole vibe — this was managesieve(3) from perl v5.42.3, dated 1980-01-01. bye bestie 🫶✨