5 Send-reminders - send email reminders for special occasions
9 Send emails reminders set by users for special occasions.
13 Email-reminder allows users to define events that they want to be
14 reminded of by email. Possible events include birthdays,
15 anniversaries and yearly events. Reminders can be sent on the day of
16 the event and a few days beforehand.
18 This script is meant to be invoked everyday by a cron job. It mails
19 the actual reminders out.
21 When run by the root user, it processes all of the spooled reminders.
22 When run by a specific user, it only processes reminders set by that
31 Displays basic usage message.
35 Does not actually send any emails out.
39 Prints out information about what the program is doing, including the
40 full emails being sent out.
44 Displays the version number.
50 F<~/.email-reminders>, F</etc/email-reminder.conf>
54 Francois Marier <francois@fmarier.org>
58 email-reminder-editor, collect-reminders
62 Copyright (C) 2004-2014 by Francois Marier
64 Email-Reminder is free software; you can redistribute it and/or
65 modify it under the terms of the GNU General Public License as
66 published by the Free Software Foundation; either version 3 of the
67 License, or (at your option) any later version.
69 Email-Reminder is distributed in the hope that it will be useful,
70 but WITHOUT ANY WARRANTY; without even the implied warranty of
71 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
72 General Public License for more details.
74 You should have received a copy of the GNU General Public License
75 along with Email-Reminder; if not, write to the Free Software
76 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
87 use MIME
::QuotedPrint
;
90 use EmailReminder
::EventList
;
91 use EmailReminder
::Utils
;
92 use Date
::Manip
qw(ParseDate UnixDate);
95 my $PREFERENCE_FILE = '/etc/email-reminder.conf';
97 $preferences{"send_reminders"} = 1;
98 $preferences{"smtp_server"} = 'localhost';
99 $preferences{"smtp_ssl"} = 0;
100 $preferences{"smtp_username"} = '';
101 $preferences{"smtp_password"} = '';
102 $preferences{"mail_from"} = 'root@localhost';
109 # Command-line parameters
114 GetOptions
( "verbose" => \
$verbose,
115 "simulate" => \
$simulate,
116 "version" => \
$version,
120 # Override preferences with system values
123 print "Reading preferences from '$PREFERENCE_FILE'\n" if $verbose;
125 if (open my $config_fh, '<', $PREFERENCE_FILE) {
126 # Stolen off of the Cookbook (section 8.16)
127 while (<$config_fh>) {
129 s/#.*//; # no comments
130 s/^\s+//; # no leading white
131 s/\s+$//; # no trailing white
132 next unless length; # anything left?
133 my ($var, $value) = split(/\s*=\s*/, $_, 2);
134 $value = 1 if $value eq 'true' or $value eq 'yes';
135 $value = 0 if $value eq 'false' or $value eq 'no';
136 $preferences{$var} = $value;
141 print "Warning: cannot read configuration file at $PREFERENCE_FILE.\nMake sure that the user running $0 has read permissions on that configuration file.\n";
151 my $user_name = shift;
152 my $user_email = shift;
154 unless ($user_email) {
158 my $to = $user_email;
159 $to = "$user_name <$user_email>" if ($user_name);
161 print "--> Emailing '$to':\n".encode
("UTF-8", $subject."\n\n".$message) if $verbose;
164 my $smtp_server = '';
165 if ($preferences{"smtp_server"} =~ /^([A-Za-z_0-9\-\/.]+)$/) {
169 if ($preferences{"smtp_ssl"}) {
170 eval 'use Net::SMTP::SSL';
171 die "Couldn't load module : $!" if ($@
);
172 $smtp = Net
::SMTP
::SSL
->new($smtp_server, Port
=> 465, Debug
=> 0);
176 $smtp = Net
::SMTP
->new($smtp_server, Debug
=> 0);
178 die "Error: couldn't connect to server '$smtp_server'\n" unless $smtp;
180 # SMTP SASL authentication (if necessary)
181 if ($preferences{"smtp_username"} and $preferences{"smtp_password"}) {
182 unless ($smtp->auth($preferences{"smtp_username"}, $preferences{"smtp_password"})) {
183 die "Error: authentication with the SMTP server failed with error code ".$smtp->status."\n";
187 unless ($smtp->mail($preferences{"mail_from"})) {
188 die "Error: the sending address was not accepted. Try setting the 'mail_from' variable to a valid email address in the configuration file\n";
192 $ok = $ok && $smtp->to($to);
193 $ok = $ok && $smtp->data();
194 $ok = $ok && $smtp->datasend("From: Email-Reminder <" . $preferences{"mail_from"} . ">\n");
196 # Create an RFC822 compliant date (current time)
197 my $rfc822_format = "%a, %d %b %Y %H:%M %z";
198 my $today = ParseDate
("Now");
199 my $rfc822_date = UnixDate
($today,$rfc822_format);
200 $ok = $ok && $smtp->datasend("Date: $rfc822_date\n");
202 $ok = $ok && $smtp->datasend("To: $to\n");
203 $ok = $ok && $smtp->datasend("Subject: =?utf-8?B?".encode_base64
(encode
("UTF-8", $subject), '')."?=\n");
204 $ok = $ok && $smtp->datasend("Mime-Version: 1.0\n");
205 $ok = $ok && $smtp->datasend("Content-Type: text/plain; charset=utf-8\n");
206 $ok = $ok && $smtp->datasend("Content-Disposition: inline\n");
207 $ok = $ok && $smtp->datasend("Content-Transfer-Encoding: quoted-printable\n");
208 $ok = $ok && $smtp->datasend("\n");
209 $ok = $ok && $smtp->datasend(encode_qp
(encode
("UTF-8", $message)));
210 $ok = $ok && $smtp->dataend();
214 die "Error: could not mail the reminder out\n" unless $ok;
224 print "==> Processing $file\n" if $verbose;
226 my $list = EmailReminder
::EventList
->new($file);
228 my @fullname = $list->get_user_name();
229 my $user_fname = $fullname[0];
230 my $user_lname = $fullname[1];
231 my $user_name = $user_fname;
232 $user_name .= " " . $user_lname if defined($user_lname);
233 my $user_email = $list->get_user_email();
235 foreach my $event ($list->get_events()) {
236 print '--> Processing event '.$event->get_name()."\n" if $verbose;
238 if ($event->is_occurring()) {
239 print '--> Event '.$event->get_name()." is occurring\n" if $verbose;
242 if (!process_event
($event, $user_name, $user_email)) {
247 print '!!! Error while sending reminder for '.$event->get_name()."\n" if $verbose;
249 my $msg = 'WARNING: Due to an error, the email reminder for Event "' . $event->get_name() .
250 '" cannot be processed and all I could do was to let you know that there was a problem.';
251 $msg .= "\n\n".'Since this event is OCCURRING TODAY, you should really check your reminders manually.';
252 $msg .= "\n\n".'Please forward this email to the email-reminder author so that this problem can be fixed in future versions:';
253 $msg .= "\n\n".' Francois Marier <francois@fmarier.org>';
254 $msg .= "\n\n".'Thanks!';
255 $msg .= "\n\n--------------------------------------------------------------";
256 $msg .= EmailReminder
::Utils
::debug_info
($event, 2);
257 my $subject = 'Email-reminder ERROR: ' . $event->get_name();
259 if (!send_email
($msg, $subject, $user_name, $user_email)) {
269 # Send reminders for an event which is occurring
273 my $user_name = shift;
274 my $user_email = shift;
276 my $subject = $event->get_subject();
278 my @recipients = @
{$event->get_recipients()};
279 if ($#recipients > -1) {
280 foreach my $recipient (@recipients) {
281 my $recipient_email = shift @
{$recipient};
282 my $recipient_fname = shift @
{$recipient};
283 my $recipient_lname = shift @
{$recipient};
285 my $recipient_name = $recipient_fname;
286 $recipient_name .= " $recipient_lname" if defined($recipient_lname);
288 my $msg = $event->get_message($recipient_fname);
289 if ($msg && !send_email
($msg, $subject, $recipient_name, $recipient_email)) {
294 my $msg = $event->get_message($user_fname);
295 if ($msg && !send_email
($msg, $subject, $user_name, $user_email)) {
303 my $running_uid = $>;
304 if (0 == $running_uid) {
305 print STDERR
"Warning: for security reasons, this script should not be not as root.\n";
308 my $spool_dir = $EmailReminder::Utils
::SPOOL_DIRECTORY
;
310 # Iterate through all spooled files
311 while (defined(my $file = glob("$spool_dir/*"))) {
313 if ($file =~ /^([A-Za-z_0-9\-\/]+)$/) {
316 print STDERR
"Skipped unclean filename" if $verbose;
320 unless (process_file
($file, 0, 1)) {
324 # Delete the file once we're done with it
325 unless (unlink($file)) {
326 print STDERR
"Could not remove $file.\n" if $verbose;
331 # Normal users only get to test their own reminders
332 my @pwinfo = getpwuid($>);
333 my $homedir = $pwinfo[7];
334 my $file = "$homedir/" . $EmailReminder::Utils
::USER_CONFIG_FILE
;
337 return process_file
($file, 0, 1);
339 print STDERR
"Warning: could not find your .email-reminders file.\n";
345 if ($help || $version) {
346 print "send-reminders $EmailReminder::Utils::VERSION\n";
351 } elsif ($preferences{"send_reminders"}) {
353 print STDERR
"Could not send reminders.\n";