5 =head1 NAME $RCSfile: announceEmail.pl,v $
7 Monitors an IMAP Server and announce incoming emails by extracting the subject
8 line and from line and then pushing that into "GoogleTalk".
16 Andrew DeFaria <Andrew@DeFaria.com>
24 Thu Apr 4 13:40:10 MST 2019
28 $Date: 2019/04/04 13:40:10 $
34 Usage: announceEmail.pl [-usa|ge] [-h|elp] [-v|erbose] [-de|bug]
35 [-use|rname <username>] [-p|assword <password>]
36 [-i|map <server>] [-t|imeout <secs>]
37 [-an|nouce] [-ap|pend] [-da|emon] [-n|name <name>]
38 [-uses|sl] [-useb|locking]
41 -usa|ge Print this usage
43 -v|erbose Verbose mode (Default: -verbose)
44 -de|bug Turn on debugging (Default: Off)
46 -user|name User name to log in with (Default: $USER)
47 -p|assword Password to use (Default: prompted)
48 -i|map IMAP server to talk to (Default: defaria.com)
49 -t|imeout <s> Timeout IMAP idle call (Sefault: 1200 seconds or 20 minutes)
51 -an|nounce Announce startup (Default: False)
52 -ap|pend Append to logfile (Default: Noappend)
53 -da|emon Run in daemon mode (Default: -daemon)
54 -n|ame Name of account (Default: imap)
55 -uses|sl Whether or not to use SSL to connect (Default: False)
56 -useb|locking Whether to block on socket (Default: False)
59 $SIG{USR1}: Toggles debug option
60 $SIG{USR2}: Reestablishes connection to IMAP server
64 This script will connect to an IMAP server, login and then monitor the user's
65 INBOX. When new messages arrive it will extract the From address and Subject
66 from the message and compose a message to be used by "Google Talk" to announce
67 the email. The message will be similar to:
69 "<From> emailed <Subject>"
82 use lib "$FindBin::Bin/../lib";
90 local $0 = "$FindBin::Script " . join ' ', @ARGV;
92 my $defaultIMAPServer = 'defaria.com';
99 'You have received a new message',
100 'Hey I found this in your inbox',
101 'For some unknown reason this guy send you a message',
102 'Did you know you just got a message',
104 'You received a communique',
105 'I was looking in your inbox and found a message',
106 'Not sure you want to hear this message',
108 "What's this? A new message",
111 my $icon = '/home/andrew/.icons/Thunderbird.jpg';
112 my $notifyTimeout = 5 * 1000;
113 my $IMAPTimeout = 20 * 60;
116 usage => sub { pod2usage },
117 help => sub { pod2usage(-verbose => 2)},
118 verbose => sub { set_verbose },
119 debug => sub { set_debug },
121 timeout => $IMAPTimeout,
122 username => $ENV{USER},
123 password => $ENV{PASSWORD},
124 imap => $defaultIMAPServer,
130 my $cmd = "notify-send -i $icon -t $notifyTimeout '$msg'";
139 notify 'Turning off debugging';
142 notify ('Turning on debugging');
153 my $msg = "Re-establishing connection to $opts{imap} as $opts{username}";
162 $SIG{USR1} = \&interrupted;
163 $SIG{USR2} = \&restart;
166 $IMAP->select('inbox') or
167 $log->err("Unable to select inbox: " . get_last_error(), 1);
169 return map { $_=> 0 } @{$IMAP->search('not', 'seen')};
173 $log->dbug("Connecting to $opts{imap} as $opts{username}");
175 # Destroy any old connections
178 $IMAP = Mail::IMAPTalk->new(
179 Server => $opts{imap},
180 Username => $opts{username},
181 Password => $opts{password},
182 UseSSL => $opts{usessl},
183 UseBlocking => $opts{useblocking},
184 ) or $log->err("Unable to connect to IMAP server $opts{imap}: $@", 1);
186 $log->dbug("Connected to $opts{imap} as $opts{username}");
188 # Focus on INBOX only
189 $IMAP->select('inbox');
191 # Setup %unseen to have each unseen message index set to 0 meaning not read
193 %unseen = unseenMsgs;
200 $log->dbug("Top of MonitorMail loop");
202 # First close and reselect the INBOX to get its current status
204 $IMAP->select('INBOX')
205 or $log->err("Unable to select INBOX - ". $IMAP->errstr(), 1);
207 $log->dbug("Closed and reselected INBOX");
208 # Go through all of the unseen messages and add them to %unseen if they were
209 # not there already from a prior run and read
210 my %newUnseen = unseenMsgs;
212 # Now clean out any messages in %unseen that were not in the %newUnseen and
213 # marked as previously read
214 $log->dbug("Cleaning out unseen");
216 if (defined $newUnseen{$_}) {
218 delete $newUnseen{$_};
225 $log->dbug("Processing new unseen messages");
226 for (keys %newUnseen) {
229 my $envelope = $IMAP->fetch($_, '(envelope)');
230 my $from = $envelope->{$_}{envelope}{From};
231 my $subject = $envelope->{$_}{envelope}{Subject};
232 $subject //= 'Unknown subject';
234 # Extract the name only when the email is of the format "name <email>"
235 if ($from =~ /^"?(.*?)"?\s*\<(\S*)>/) {
236 $from = $1 if $1 ne '';
239 if ($subject =~ /=?\S+?(Q|B)\?(.+)\?=/) {
240 $subject = decode_base64($2);
243 # Google Talk doesn't like #
246 # Remove long strings of numbers like order numbers. They are uninteresting
248 $subject =~ s/\s+\S*\d{$longNumber,}\S*\s*//g;
251 my $logmsg = "From $from $subject";
253 my $greeting = $greetings[int rand $#greetings];
254 my $msg = "$greeting from $from... $subject";
255 my $hour = (localtime)[2];
257 # Only announce if after 6 Am. Note this will announce up until
258 # midnight but that's ok. I want midnight to 6 Am as silent time.
259 $log->dbug("About to speak/log");
262 $log->dbug("Calling speak");
265 $log->msg("$logmsg [silent nighttime]");
272 my $startTime = time;
274 # Re-establish callback
275 $log->dbug("Calling IMAP->idle");
277 $IMAP->idle(\&MonitorMail, $opts{timeout})
280 my $msg = 'Returned from IMAP->idle ';
283 speak($msg . $@, $log);
285 $log->msg($msg . 'no error');
288 # If we return from idle then the server went away for some reason. With Gmail
289 # the server seems to time out around 30-40 minutes. Here we simply reconnect
290 # to the imap server and continue to MonitorMail.
291 unless ($IMAP->get_response_code('timeout')) {
292 $msg = "IMAP Idle for $opts{name} timed out in " . howlong $startTime, time;
303 # If $log is not yet defined then the exit is not unexpected
305 my $msg = "$FindBin::Script $opts{name} ending unexpectedly!";
332 unless ($opts{password}) {
333 verbose "I need $opts{username}'s password";
334 $opts{password} = GetPassword;
337 $opts{name} //= $opts{imap};
339 if ($opts{username} =~ /.*\@(.*)$/) {
344 # Perl complains if we reference $DB::OUT only once
346 EnterDaemonMode unless defined $DB::OUT or get_debug;
351 path => '/var/local/log',
352 name => "$Logger::me.$opts{name}",
353 timestamped => 'yes',
354 append => $opts{append},
359 if ($opts{username} =~ /(.*)\@/) {
362 $opts{user} = $opts{username};
365 my $msg = "Now monitoring email for $opts{user}\@$opts{name}";
367 speak $msg, $log if $opts{announce};
373 # Should not get here
374 $log->err("Falling off the edge of $0", 1);