Authen...::POP3(3pm)

✨ Authen::Simple::POP3 ✨

okay so bestie, this is a page from the User Contributed Perl Documentation for Authen::Simple::POP3 — aka the little module that lets you check a username and password against a POP3 server. it's giving "gatekeeper but make it polite." 💅

---

🌸 NAME 🌸

Authen::Simple::POP3 — simple POP3 authentication. no cap, that's literally the whole pitch.

---

🎀 SYNOPSIS 🎀

use it like this, queen:

use Authen::Simple::POP3;

my $pop3 = Authen::Simple::POP3->new(
    host => 'pop3.company.com'
);

if ( $pop3->authenticate( $username, $password ) ) {
    # successfull authentication
}

# or as a mod_perl Authen handler

PerlModule Authen::Simple::Apache
PerlModule Authen::Simple::POP3

PerlSetVar AuthenSimplePOP3_host "pop3.company.com"

<Location /protected>
  PerlAuthenHandler Authen::Simple::POP3
  AuthType          Basic
  AuthName          "Protected Area"
  Require           valid-user
</Location>

(yes the comment says successfull, with the double L. we don't fix it, we respect it. ✨)

---

🦋 DESCRIPTION 🦋

you're authenticating against a POP3 service. that's the vibe. that's the whole vibe. 🫶

---

💖 METHODS 💖

⭐ new

this method takes a hash of parameters, and honestly? the options are the main characters. here's every single one:

• host — the connection host, and it can be a hostname or an IP number. defaults to "localhost". iconic default behaviour.

host => 'ftp.company.com'
host => '10.0.0.1'

• port — the connection port. defaults to 110.

port => 110

• timeout — the connection timeout. defaults to 60.

timeout => 60

• method — the authentication method, defaults to "plain". the valid options are "apop", "plain", and "sasl". pick your fighter 💀

method => 'plain'

• log — any object that supports debug, info, error and warn. give it your lil logger bestie.

log => Log::Log4perl->get_logger('Authen::Simple::POP3')

---

🔥 authenticate( $username, $password )

returns true on success and false on failure. that's it. that's the whole method. slay. 👑

---

🌈 SEE ALSO 🌈

• Authen::Simple.
• Net::POP3.

go read those too, iykyk. 📚

---

💜 AUTHOR 💜

Christian Hansen ch@ngmedia.com — thank you for your service 🫡

---

👑 COPYRIGHT 👑

this program is free software, you can redistribute it and/or modify it under the same terms as Perl itself. free as in freedom, bestie. 🕊️

---

and that's the whole page!! this was perl v5.34.0, dated 2022-06-08, so if you're reading this from the future just know she was built different back then 💖✨🎀 mwah, go authenticate something 🦋