From 1d3d7b9ec29774424d4913e0d4389c2217ce4109 Mon Sep 17 00:00:00 2001
From: short <>
Date: Sun, 19 Oct 2003 13:15:35 +0000
Subject: [PATCH] +Config comments.

---
 PerlMail/Config.pm | 36 ++++++++++++++++++++++++++++++++++--
 1 file changed, 34 insertions(+), 2 deletions(-)

diff --git a/PerlMail/Config.pm b/PerlMail/Config.pm
index 5b2fbd9..49f6a58 100644
--- a/PerlMail/Config.pm
+++ b/PerlMail/Config.pm
@@ -51,33 +51,48 @@ BEGIN {
 
 # perlmail-accept & perlmail-sendmail
 
+# Various configuration files location is derived from it:
 our $HOME="/home/lace";
 
 
 # perlmail-accept
 
+# Mail folder:
 our $Mail="$HOME/Mail";
+# Users respected for the 'idle' state (see $IdleMax):
 our @ValidUsers=qw(root lace short kratochvil _local);
+# Maximum number of local console idle seconds while still considered as 'active user':
 our $IdleMax=10;
-our $MaxBodySMS=0x1000;	# max bytes to pass to Lingua::EN::Squeeze
+# Maxium number of bytes to pass to Lingua::EN::Squeeze (performance optimization):
+our $MaxBodySMS=0x1000;
+# Telephone number to send SMSes by WWW::SMS to:
 our @SMSwebRcpt=qw(420 602 431329);
+# Some WWW::SMS modules require username:
 our $SMSwebRcpt_username="lace2";
 
 
 # perlmail-submit
 
+# Global system lock for exclusive $DB_table access:
 our $Lock_pathname="/tmp/PerlMail.lock";
+# 'workstation' hostname and port. Hostname may be dyndns:
 our $PeerAddr="exuhome.dyn.jankratochvil.net.:852";
 #our $PeerAddr="127.0.0.1:2852";
-our $Socket_timeout=7600;       # 15sec is NOT enough!
+# 15sec is NOT enough as the remote peer must complete mail store:
+our $Socket_timeout=7600;
+# MySQL table name:
 our $DB_table="PerlMail_folder";
+# MySQL database name:
 our $DBI_database="short";
+# MySQL user name:
 our $DBI_user="short";
+# MySQL user password:
 our $DBI_pwd=$ENV{"HOME"}."/priv/mysql.".$DBI_user.".pwd";
 
 
 # perlmail-sendmail
 
+# Lists where <rcpt-USER.AT.HOST@jankratochvil.net> address is generated:
 my @lists=qw(
 		tacplus-l@disaster.com
 		gsm@sh.cvut.cz
@@ -101,7 +116,9 @@ my @lists=qw(
 		captive-devel-list@jankratochvil.net
 		);
 
+# Pathname of the original sendmail(8) binary:
 our $sendmail_orig=(-x ($_="/usr/sbin/sendmail-orig") ? $_ : "/usr/sbin/sendmail");
+# List of addresses to locally Bcc all mails to:
 # Mail-Alias-1.12 defaults to "/etc/mail/aliases" which does not exist on RedHat sendmail-8.12.5-7
 # Mail-Alias-1.12 will clutter $_ !
 our @addr_addon=(Mail::Alias->new("/etc/aliases")->exists("sentout") ? ("sentout") : ());
@@ -109,6 +126,9 @@ our @addr_addon=(Mail::Alias->new("/etc/aliases")->exists("sentout") ? ("sentout
 our $opt_F;	# imported
 our $is_pgp;	# imported
 my %lists=map(($_=>1),@lists);
+# Generate new From address for the target $rcpt of type Mail::Address.
+# $iserror is true for "MAIL FROM" RFC821 address, false for "From:" RFC822 address.
+# Returns: Mail::Address instance.
 sub FromAddress
 {
 my($rcpt,$iserror)=@_;
@@ -162,6 +182,12 @@ our @h_from=(
 
 # My-Audit
 
+# Setup profile names.
+# First element of /^=/ form copies it referenced profile to be extended.
+# 'did'    =>did() subroutine will return true for it.
+# 'syslog' =>Use syslog(3).
+# 'bell'   =>Bell sound.
+# 'sms=\d+'=>Send SMS by WWW::SMS with specified maximum # of parts
 our %audit_profile=(
 		"btw"   =>[],
 		"silent"=>["=btw"   ,"did"],
@@ -170,6 +196,7 @@ our %audit_profile=(
 		"sms"   =>["=bell"  ,"sms=1"],
 		"crit"  =>["=sms"   ,"sms=3"],
 		);
+# Try the squeezing methods in this order:
 our @sms_squeezes=(
 		{ "SqueezeControl"=>"noconv"                         },
 		{ "SqueezeControl"=>"conv"  ,"SQZ_OPTIMIZE_LEVEL"=>0 },
@@ -179,11 +206,13 @@ our @sms_squeezes=(
 		{ "SqueezeControl"=>"max"   ,"SQZ_OPTIMIZE_LEVEL"=>0 },
 		{ "SqueezeControl"=>"max"   ,"SQZ_OPTIMIZE_LEVEL"=>1 },
 		);
+# Hostnames where we had alternate e-mail addresses:
 our @alternates_host=(
 		"jabberwock.ucw.cz",	# short@ucw.cz
 		"atrey.karlin.mff.cuni.cz",	# short@atrey.karlin.mff.cuni.cz
 		"k332.feld.cvut.cz",	# short@k332.feld.cvut.cz
 		);
+# Override DNS blacklists:
 our @dnsbl_whitelist=(
 		"195.250.128.83",	# smtp3.vol.cz; vol.cz.multistage.blackholes.five-ten-sg.com.
 		"64.49.222.22",		# mail.pm.org: rackspace.com.spam-support.blackholes.five-ten-sg.com.
@@ -385,6 +414,9 @@ my($obj)=@_;
 	return $_;
 }
 
+# $args{"from"}
+# $args{"subject"}
+# $args{"body"}
 sub audit_sms
 {
 my(%args)=@_;
-- 
1.8.3.1