=item Revision
-$Revision: 1.0 $
+$Revision: 1.2 $
=item Created:
=back
-=hade1 SYNOPSIS
+=head1 SYNOPSIS
Usage: announceEmail.pl [-usa|ge] [-h|elp] [-v|erbose] [-de|bug] [-da|emon]
[-use|rname <username>] [-p|assword <password>]
-v|erbose: Verbose mode (Default: -verbose)
-de|bug: Turn on debugging (Default: Off)
-da|emon: Run in daemon mode (Default: -daemon)
- -use|rname: User name to log in with (Default: $USER)
+ -user|name: User name to log in with (Default: $USER)
-p|assword: Password to use (Default: prompted)
-i|map: IMAP server to talk to (Default: defaria.com)
- -s|leep: Number of minutes to sleep inbetween checking mail (Default: 5)
+ -uses|sl: Whether or not to use SSL to connect (Default: False)
=head1 DESCRIPTION
use FindBin;
use Getopt::Long;
use Pod::Usage;
-use Net::IMAP::Simple;
-use Email::Simple;
+use Mail::IMAPTalk;
use MIME::Base64;
use lib "$FindBin::Bin/../lib";
use Display;
+use Logger;
use Utils;
my $defaultIMAPServer = 'defaria.com';
-my $defaultSleeptime = 5;
my $IMAP;
my %unseen;
+my $log;
+
+my @greetings = (
+ 'Incoming message',
+ 'You have received a new message',
+ 'Hey I found this in your inbox',
+ 'For some unknown reason this guy send you a message',
+ 'Did you know you just got a message',
+ 'Potential spam',
+ 'You received a communique',
+ 'I was looking in your inbox and found a message',
+ 'Not sure you want to hear this message',
+ 'Good news',
+);
my %opts = (
usage => sub { pod2usage },
debug => sub { set_debug },
daemon => 1,
username => $ENV{USER},
+ password => $ENV{PASSWORD},
imap => $defaultIMAPServer,
- sleep => $defaultSleeptime,
+ usessl => 0,
);
-sub unseenMsgs() {
- my %unseenMsgs;
+sub interrupted {
+ if (get_debug) {
+ $log->msg("Turning off debugging");
+ set_debug 0;
+ } else {
+ $log->msg("Turning on debugging");
+ set_debug 1;
+ } # if
- for (my $i = 1; $i <= $IMAP->status; $i++) {
- $unseenMsgs{$i} = 0 unless $IMAP->seen($i);
- } # for
+ return;
+} # interrupted
- return %unseenMsgs;
-} # unseenMsgs
+$SIG{USR1} = \&interrupted;
-sub Connect2IMAP() {
- verbose "Connecting to $opts{imap} as $opts{username}";
-
- $IMAP = Net::IMAP::Simple->new($opts{imap}) ||
- error("Unable to connect to IMAP server $opts{imap}: " . $Net::IMAP::Simple::errstr, 1);
+sub unseenMsgs() {
+ $IMAP->select('inbox') or
+ $log->err("Unable to select inbox: " . get_last_error(), 1);
- verbose "Connected";
+ return map { $_=> 0 } @{$IMAP->search('not', 'seen')};
+} # unseenMsgs
- verbose "Logging onto $opts{imap} as $opts{username}";
+sub Connect2IMAP() {
+ $log->msg("Connecting to $opts{imap} as $opts{username}");
- unless ($IMAP->login($opts{username}, $opts{password})) {
- error("Login to $opts{imap} as $opts{username} failed: " . $IMAP->errstr, 1);
- } # unless
+ $IMAP = Mail::IMAPTalk->new(
+ Server => $opts{imap},
+ Username => $opts{username},
+ Password => $opts{password},
+ UseSSL => $opts{usessl},
+ ) or $log->err("Unable to connect to IMAP server $opts{imap}: $@", 1);
- verbose "Logged on";
+ $log->msg('Connected');
# Focus on INBOX only
- $IMAP->select('INBOX');
+ $IMAP->select('inbox');
# Setup %unseen to have each unseen message index set to 0 meaning not read
# aloud yet
%unseen = unseenMsgs;
+
+ return;
} # Connect2IMAP
sub MonitorMail() {
- verbose "Monitoring email";
-
- while () {
- verbose "Looking for unread messages";
- # First close and reselect the INBOX to get its current status
- $IMAP->close;
- $IMAP->select('INBOX');
-
- # Go through all of the unseen messages and add them to %unseen if they were
- # not there already from a prior run and read
- my %newUnseen = unseenMsgs;
-
- # Now clean out any messages in %unseen that were not in the %newUnseen and
- # marked as previously read
- for (keys %unseen) {
- if (defined $newUnseen{$_}) {
- if ($unseen{$_}) {
- delete $newUnseen{$_};
- } # if
- } else {
- delete $unseen{$_}
+ # First close and reselect the INBOX to get its current status
+ $IMAP->close;
+ $IMAP->select('INBOX')
+ or $log->err("Unable to select INBOX - ". $IMAP->errstr(), 1);
+
+ # Go through all of the unseen messages and add them to %unseen if they were
+ # not there already from a prior run and read
+ my %newUnseen = unseenMsgs;
+
+ # Now clean out any messages in %unseen that were not in the %newUnseen and
+ # marked as previously read
+ for (keys %unseen) {
+ if (defined $newUnseen{$_}) {
+ if ($unseen{$_}) {
+ delete $newUnseen{$_};
} # if
- } # for
+ } else {
+ delete $unseen{$_}
+ } # if
+ } # for
- for (keys %newUnseen) {
- next if $unseen{$_};
+ for (keys %newUnseen) {
+ next if $unseen{$_};
- my $email = Email::Simple->new(join '', @{$IMAP->top($_)});
+ my $envelope = $IMAP->fetch($_, '(envelope)');
+ my $from = $envelope->{$_}{envelope}{From};
+ my $subject = $envelope->{$_}{envelope}{Subject};
+ $subject //= 'Unknown subject';
- my $from = $email->header('From');
+ # Extract the name only when the email is of the format "name <email>"
+ if ($from =~ /^"?(.*?)"?\s*\<(\S*)>/) {
+ $from = $1 if $1 ne '';
+ } # if
- # Extract the name only when the email is of the format "name <email>"
- if ($from =~ /^(.*)\<(\S*)>/) {
- $from = $1 if $1 ne '';
- } # if
+ if ($subject =~ /=?\S+?(Q|B)\?(.+)\?=/) {
+ $subject = decode_base64($2);
+ } # if
- my $subject = $email->header('Subject');
+ # Google Talk doesn't like #
+ $subject =~ s/\#//g;
- if ($subject =~ /=?\S+?(Q|B)\?(.+)\?=/) {
- $subject = decode_base64($2);
- } # if
+ # Now speak it!
+ my $logmsg = "From $from $subject";
+
+ my $greeting = $greetings[int rand $#greetings];
+ my $msg = "$greeting from $from... " . quotemeta $subject;
+ $msg =~ s/\"/\\"/g;
- # Now speak it!
- my $msg = "Message from $from... " . quotemeta $subject;
- $msg =~ s/\"/\\"/g;
+ # Log it
+ $log->msg($logmsg);
- verbose "Announcing $msg";
+ my $hour = (localtime)[2];
- Execute "/usr/local/bin/gt \"$msg\"";
+ # Only announce if after 6 Am. Note this will announce up until
+ # midnight but that's ok. I want midnight to 6 Am as silent time.
+ if ($hour > 6) {
+ my $cmd = "/usr/local/bin/gt \"$msg\"";
+ my ($status, @output) = Execute $cmd;
- $unseen{$_} = 1;
- } # for
+ if ($status) {
+ $log->err("Unable to execute $cmd" . join("\n", @output));
+ } # if
+ } # if
+
+ $unseen{$_} = 1;
+ } # for
+
+ # Re-establish callback
+ $IMAP->idle(\&MonitorMail);
- verbose "Sleeping for $opts{sleep} minutes";
- sleep 60 * $opts{sleep};
- verbose "Ah that was refreshing!";
- } # while
+ # Should not get here
+ $log->err("Unable to re-establish IDLE callback from IMAP server $opts{imap}", 1);
} # MonitorMail
END {
- $IMAP->quit;
+ $IMAP->quit if $IMAP;
+
+ $log->msg("$FindBin::Script ending unexpectedly!");
} # END
## Main
'username=s',
'password=s',
'imap=s',
+ 'usessl',
'sleep',
);
$opts{password} = GetPassword;
} # unless
-EnterDaemonMode if $opts{daemon};
+$opts{debug} = get_debug;
+
+if ($opts{daemon}) {
+ EnterDaemonMode unless defined $DB::OUT;
+} # if
+
+$log = Logger->new(
+ path => '/var/log',
+ timestamped => 'yes',
+ append => 'yes',
+);
Connect2IMAP;
-MonitorMail;
+
+my $msg = "Now monitoring email for $opts{username}\@$opts{imap}";
+
+$log->msg($msg);
+
+my $cmd = "/usr/local/bin/gt \"$msg\"";
+
+my ($status, @output) = Execute $cmd;
+
+$IMAP->idle(\&MonitorMail);
+
+# Should not get here
+$log->err("Falling off the edge of $0", 1);