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>]
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)
50 -an|nounce Announce startup (Default: False)
51 -ap|pend Append to logfile (Default: Noappend)
52 -da|emon Run in daemon mode (Default: -daemon)
53 -n|ame Name of account (Default: imap)
54 -uses|sl Whether or not to use SSL to connect (Default: False)
55 -useb|locking Whether to block on socket (Default: False)
58 $SIG{USR1}: Toggles debug option
59 $SIG{USR2}: Reestablishes connection to IMAP server
63 This script will connect to an IMAP server, login and then monitor the user's
64 INBOX. When new messages arrive it will extract the From address and Subject
65 from the message and compose a message to be used by "Google Talk" to announce
66 the email. The message will be similar to:
68 "<From> emailed <Subject>"
81 use lib "$FindBin::Bin/../lib";
89 my $defaultIMAPServer = 'defaria.com';
96 'You have received a new message',
97 'Hey I found this in your inbox',
98 'For some unknown reason this guy send you a message',
99 'Did you know you just got a message',
101 'You received a communique',
102 'I was looking in your inbox and found a message',
103 'Not sure you want to hear this message',
105 "What's this? A new message",
109 usage => sub { pod2usage },
110 help => sub { pod2usage(-verbose => 2)},
111 verbose => sub { set_verbose },
112 debug => sub { set_debug },
114 username => $ENV{USER},
115 password => $ENV{PASSWORD},
116 imap => $defaultIMAPServer,
121 $log->msg("Turning off debugging");
124 $log->msg("Turning on debugging");
134 $log->dbug("Re-establishing connection to $opts{imap} as $opts{username}");
140 $SIG{USR1} = \&interrupted;
141 $SIG{USR2} = \&restart;
144 $IMAP->select('inbox') or
145 $log->err("Unable to select inbox: " . get_last_error(), 1);
147 return map { $_=> 0 } @{$IMAP->search('not', 'seen')};
151 $log->dbug("Connecting to $opts{imap} as $opts{username}");
153 # Destroy any old connections
156 $IMAP = Mail::IMAPTalk->new(
157 Server => $opts{imap},
158 Username => $opts{username},
159 Password => $opts{password},
160 UseSSL => $opts{usessl},
161 UseBlocking => $opts{useblocking},
162 ) or $log->err("Unable to connect to IMAP server $opts{imap}: $@", 1);
164 $log->dbug("Connected to $opts{imap} as $opts{username}");
166 # Focus on INBOX only
167 $IMAP->select('inbox');
169 # Setup %unseen to have each unseen message index set to 0 meaning not read
171 %unseen = unseenMsgs;
178 $log->dbug("Top of MonitorMail loop");
180 # First close and reselect the INBOX to get its current status
182 $IMAP->select('INBOX')
183 or $log->err("Unable to select INBOX - ". $IMAP->errstr(), 1);
185 $log->dbug("Closed and reselected INBOX");
186 # Go through all of the unseen messages and add them to %unseen if they were
187 # not there already from a prior run and read
188 my %newUnseen = unseenMsgs;
190 # Now clean out any messages in %unseen that were not in the %newUnseen and
191 # marked as previously read
192 $log->dbug("Cleaning out unseen");
194 if (defined $newUnseen{$_}) {
196 delete $newUnseen{$_};
203 $log->dbug("Processing new unseen messages");
204 for (keys %newUnseen) {
207 my $envelope = $IMAP->fetch($_, '(envelope)');
208 my $from = $envelope->{$_}{envelope}{From};
209 my $subject = $envelope->{$_}{envelope}{Subject};
210 $subject //= 'Unknown subject';
212 # Extract the name only when the email is of the format "name <email>"
213 if ($from =~ /^"?(.*?)"?\s*\<(\S*)>/) {
214 $from = $1 if $1 ne '';
217 if ($subject =~ /=?\S+?(Q|B)\?(.+)\?=/) {
218 $subject = decode_base64($2);
221 # Google Talk doesn't like #
225 my $logmsg = "From $from $subject";
227 my $greeting = $greetings[int rand $#greetings];
228 my $msg = "$greeting from $from... $subject";
231 my $hour = (localtime)[2];
233 # Only announce if after 6 Am. Note this will announce up until
234 # midnight but that's ok. I want midnight to 6 Am as silent time.
235 $log->dbug("About to speak/log");
237 $log->dbug("Calling speak");
241 $log->msg("$logmsg [silent]");
248 my $startTime = time;
250 # Re-establish callback
251 $log->dbug("Evaling idle");
252 eval { $IMAP->idle(\&MonitorMail) };
254 # If we return from idle then the server went away for some reason. With Gmail
255 # the server seems to time out around 30-40 minutes. Here we simply reconnect
256 # to the imap server and continue to MonitorMail.
263 # If $log is not yet defined then the exit is not unexpected
265 my $msg = "$FindBin::Script ending unexpectedly!";
291 unless ($opts{password}) {
292 verbose "I need $opts{username}'s password";
293 $opts{password} = GetPassword;
296 $opts{name} //= $opts{imap};
298 if ($opts{username} =~ /.*\@(.*)$/) {
303 # Perl complains if we reference $DB::OUT only once
305 EnterDaemonMode unless defined $DB::OUT or get_debug;
310 path => '/var/local/log',
311 name => "$Logger::me.$opts{name}",
312 timestamped => 'yes',
313 append => $opts{append},
318 if ($opts{username} =~ /(.*)\@/) {
321 $opts{user} = $opts{username};
324 my $msg = "Now monitoring email for $opts{user}\@$opts{name}";
326 speak $msg, $log if $opts{announce};
332 # Should not get here
333 $log->err("Falling off the edge of $0", 1);