3 * StatusNet, the distributed open-source microblogging tool
5 * utilities for sending email
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Evan Prodromou <evan@status.net>
25 * @author Zach Copley <zach@status.net>
26 * @author Robin Millette <millette@status.net>
27 * @author Sarven Capadisli <csarven@status.net>
28 * @copyright 2008 StatusNet, Inc.
29 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
30 * @link http://status.net/
33 if (!defined('STATUSNET') && !defined('LACONICA')) {
37 require_once 'Mail.php';
40 * return the configured mail backend
42 * Uses the $config array to make a mail backend. Cached so it is safe to call
45 * @return Mail backend
47 function mail_backend()
49 static $backend = null;
52 $backend = Mail::factory(common_config('mail', 'backend'),
53 (common_config('mail', 'params')) ?
54 common_config('mail', 'params') :
56 if (PEAR::isError($backend)) {
57 common_server_error($backend->getMessage(), 500);
64 * send an email to one or more recipients
66 * @param array $recipients array of strings with email addresses of recipients
67 * @param array $headers array mapping strings to strings for email headers
68 * @param string $body body of the email
70 * @return boolean success flag
72 function mail_send($recipients, $headers, $body)
74 // XXX: use Mail_Queue... maybe
75 $backend = mail_backend();
76 if (!isset($headers['Content-Type'])) {
77 $headers['Content-Type'] = 'text/plain; charset=UTF-8';
79 assert($backend); // throws an error if it's bad
80 $sent = $backend->send($recipients, $headers, $body);
81 if (PEAR::isError($sent)) {
82 common_log(LOG_ERR, 'Email error: ' . $sent->getMessage());
89 * returns the configured mail domain
91 * Defaults to the server name.
93 * @return string mail domain, suitable for making email addresses.
95 function mail_domain()
97 $maildomain = common_config('mail', 'domain');
99 $maildomain = common_config('site', 'server');
105 * returns a good address for sending email from this server
107 * Uses either the configured value or a faked-up value made
108 * from the mail domain.
110 * @return string notify from address
112 function mail_notify_from()
114 $notifyfrom = common_config('mail', 'notifyfrom');
118 $domain = mail_domain();
120 $notifyfrom = '"'. str_replace('"', '\\"', common_config('site', 'name')) .'" <noreply@'.$domain.'>';
127 * sends email to a user
129 * @param User &$user user to send email to
130 * @param string $subject subject of the email
131 * @param string $body body of the email
132 * @param array $headers optional list of email headers
133 * @param string $address optional specification of email address
135 * @return boolean success flag
137 function mail_to_user(&$user, $subject, $body, $headers=array(), $address=null)
140 $address = $user->email;
143 $recipients = $address;
144 $profile = $user->getProfile();
146 $headers['From'] = mail_notify_from();
147 $headers['To'] = $profile->getBestName() . ' <' . $address . '>';
148 $headers['Subject'] = $subject;
150 return mail_send($recipients, $headers, $body);
154 * Send an email to confirm a user's control of an email address
156 * @param User $user User claiming the email address
157 * @param string $code Confirmation code
158 * @param string $nickname Nickname of user
159 * @param string $address email address to confirm
161 * @see common_confirmation_code()
163 * @return success flag
165 function mail_confirm_address($user, $code, $nickname, $address, $url=null)
168 $url = common_local_url('confirmaddress', array('code' => $code));
171 // TRANS: Subject for address confirmation email.
172 $subject = _('Email address confirmation');
174 // TRANS: Body for address confirmation email.
175 // TRANS: %1$s is the addressed user's nickname, %2$s is the StatusNet sitename,
176 // TRANS: %3$s is the URL to confirm at.
177 $body = sprintf(_("Hey, %1\$s.\n\n".
178 "Someone just entered this email address on %2\$s.\n\n" .
179 "If it was you, and you want to confirm your entry, ".
180 "use the URL below:\n\n\t%3\$s\n\n" .
181 "If not, just ignore this message.\n\n".
182 "Thanks for your time, \n%2\$s\n"),
184 common_config('site', 'name'),
189 return mail_to_user($user, $subject, $body, $headers, $address);
193 * notify a user of subscription by another user
195 * This is just a wrapper around the profile-based version.
197 * @param User $listenee user who is being subscribed to
198 * @param User $listener user who is subscribing
200 * @see mail_subscribe_notify_profile()
204 function mail_subscribe_notify($listenee, $listener)
206 $other = $listener->getProfile();
207 mail_subscribe_notify_profile($listenee, $other);
211 * notify a user of subscription by a profile (remote or local)
213 * This function checks to see if the listenee has an email
214 * address and wants subscription notices.
216 * @param User $listenee user who's being subscribed to
217 * @param Profile $other profile of person who's listening
221 function mail_subscribe_notify_profile($listenee, $other)
223 if ($other->hasRight(Right::EMAILONSUBSCRIBE) &&
224 $listenee->email && $listenee->emailnotifysub) {
226 $profile = $listenee->getProfile();
228 $name = $profile->getBestName();
230 $long_name = ($other->fullname) ?
231 ($other->fullname . ' (' . $other->nickname . ')') : $other->nickname;
233 $recipients = $listenee->email;
235 // use the recipient's localization
236 common_switch_locale($listenee->language);
238 $headers = _mail_prepare_headers('subscribe', $listenee->nickname, $other->nickname);
239 $headers['From'] = mail_notify_from();
240 $headers['To'] = $name . ' <' . $listenee->email . '>';
241 // TRANS: Subject of new-subscriber notification e-mail.
242 // TRANS: %1$s is the subscribing user's nickname, %2$s is the StatusNet sitename.
243 $headers['Subject'] = sprintf(_('%1$s is now listening to '.
244 'your notices on %2$s.'),
245 $other->getBestName(),
246 common_config('site', 'name'));
248 // TRANS: This is a paragraph in a new-subscriber e-mail.
249 // TRANS: %s is a URL where the subscriber can be reported as abusive.
250 $blocklink = sprintf(_("If you believe this account is being used abusively, " .
251 "you can block them from your subscribers list and " .
252 "report as spam to site administrators at %s"),
253 common_local_url('block', array('profileid' => $other->id)));
255 // TRANS: Main body of new-subscriber notification e-mail.
256 // TRANS: %1$s is the subscriber's long name, %2$s is the StatusNet sitename,
257 // TRANS: %3$s is the subscriber's profile URL, %4$s is the subscriber's location (or empty)
258 // TRANS: %5$s is the subscriber's homepage URL (or empty), %6%s is the subscriber's bio (or empty)
259 // TRANS: %7$s is a link to the addressed user's e-mail settings.
260 $body = sprintf(_('%1$s is now listening to your notices on %2$s.'."\n\n".
265 "\n".'Faithfully yours,'."\n".'%2$s.'."\n\n".
267 "Change your email address or ".
268 "notification options at ".'%7$s' ."\n"),
270 common_config('site', 'name'),
273 // TRANS: Profile info line in new-subscriber notification e-mail.
274 // TRANS: %s is a location.
275 sprintf(_("Location: %s"), $other->location) . "\n" : '',
277 // TRANS: Profile info line in new-subscriber notification e-mail.
278 // TRANS: %s is a homepage.
279 sprintf(_("Homepage: %s"), $other->homepage) . "\n" : '',
281 // TRANS: Profile info line in new-subscriber notification e-mail.
282 // TRANS: %s is biographical information.
283 sprintf(_("Bio: %s"), $other->bio) . "\n" : '') .
284 "\n\n" . $blocklink . "\n",
285 common_local_url('emailsettings'));
287 // reset localization
288 common_switch_locale();
289 mail_send($recipients, $headers, $body);
294 * notify a user of their new incoming email address
296 * User's email and incoming fields should already be updated.
298 * @param User $user user with the new address
302 function mail_new_incoming_notify($user)
304 $profile = $user->getProfile();
306 $name = $profile->getBestName();
308 $headers['From'] = $user->incomingemail;
309 $headers['To'] = $name . ' <' . $user->email . '>';
310 // TRANS: Subject of notification mail for new posting email address.
311 // TRANS: %s is the StatusNet sitename.
312 $headers['Subject'] = sprintf(_('New email address for posting to %s'),
313 common_config('site', 'name'));
315 // TRANS: Body of notification mail for new posting email address.
316 // TRANS: %1$s is the StatusNet sitename, %2$s is the e-mail address to send
317 // TRANS: to to post by e-mail, %3$s is a URL to more instructions.
318 $body = sprintf(_("You have a new posting address on %1\$s.\n\n".
319 "Send email to %2\$s to post new messages.\n\n".
320 "More email instructions at %3\$s.\n\n".
321 "Faithfully yours,\n%1\$s"),
322 common_config('site', 'name'),
323 $user->incomingemail,
324 common_local_url('doc', array('title' => 'email')));
326 mail_send($user->email, $headers, $body);
330 * generate a new address for incoming messages
332 * @todo check the database for uniqueness
334 * @return string new email address for incoming messages
336 function mail_new_incoming_address()
338 $prefix = common_confirmation_code(64);
339 $suffix = mail_domain();
340 return $prefix . '@' . $suffix;
344 * broadcast a notice to all subscribers with SMS notification on
346 * This function sends SMS messages to all users who have sms addresses;
347 * have sms notification on; and have sms enabled for this particular
350 * @param Notice $notice The notice to broadcast
352 * @return success flag
354 function mail_broadcast_notice_sms($notice)
356 // Now, get users subscribed to this profile
360 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
361 $user->query('SELECT nickname, smsemail, incomingemail ' .
362 "FROM $UT JOIN subscription " .
363 "ON $UT.id = subscription.subscriber " .
364 'WHERE subscription.subscribed = ' . $notice->profile_id . ' ' .
365 'AND subscription.subscribed != subscription.subscriber ' .
366 "AND $UT.smsemail IS NOT null " .
367 "AND $UT.smsnotify = 1 " .
368 'AND subscription.sms = 1 ');
370 while ($user->fetch()) {
372 'Sending notice ' . $notice->id . ' to ' . $user->smsemail,
374 $success = mail_send_sms_notice_address($notice,
376 $user->incomingemail);
378 // XXX: Not sure, but I think that's the right thing to do
379 common_log(LOG_WARNING,
380 'Sending notice ' . $notice->id . ' to ' .
381 $user->smsemail . ' FAILED, cancelling.',
394 * send a notice to a user via SMS
396 * A convenience wrapper around mail_send_sms_notice_address()
398 * @param Notice $notice notice to send
399 * @param User $user user to receive notice
401 * @see mail_send_sms_notice_address()
403 * @return boolean success flag
405 function mail_send_sms_notice($notice, $user)
407 return mail_send_sms_notice_address($notice,
409 $user->incomingemail);
413 * send a notice to an SMS email address from a given address
415 * We use the user's incoming email address as the "From" address to make
416 * replying to notices easier.
418 * @param Notice $notice notice to send
419 * @param string $smsemail email address to send to
420 * @param string $incomingemail email address to set as 'from'
422 * @return boolean success flag
424 function mail_send_sms_notice_address($notice, $smsemail, $incomingemail)
426 $to = $nickname . ' <' . $smsemail . '>';
428 $other = $notice->getProfile();
430 common_log(LOG_INFO, 'Sending notice ' . $notice->id .
431 ' to ' . $smsemail, __FILE__);
435 $headers['From'] = ($incomingemail) ? $incomingemail : mail_notify_from();
436 $headers['To'] = $to;
437 // TRANS: Subject line for SMS-by-email notification messages.
438 // TRANS: %s is the posting user's nickname.
439 $headers['Subject'] = sprintf(_('%s status'),
440 $other->getBestName());
442 $body = $notice->content;
444 return mail_send($smsemail, $headers, $body);
448 * send a message to confirm a claim for an SMS number
450 * @param string $code confirmation code
451 * @param string $nickname nickname of user claiming number
452 * @param string $address email address to send the confirmation to
454 * @see common_confirmation_code()
458 function mail_confirm_sms($code, $nickname, $address)
460 $recipients = $address;
462 $headers['From'] = mail_notify_from();
463 $headers['To'] = $nickname . ' <' . $address . '>';
464 // TRANS: Subject line for SMS-by-email address confirmation message.
465 $headers['Subject'] = _('SMS confirmation');
467 // TRANS: Main body heading for SMS-by-email address confirmation message.
468 // TRANS: %s is the addressed user's nickname.
469 $body = sprintf(_("%s: confirm you own this phone number with this code:"), $nickname);
474 mail_send($recipients, $headers, $body);
478 * send a mail message to notify a user of a 'nudge'
480 * @param User $from user nudging
481 * @param User $to user being nudged
483 * @return boolean success flag
485 function mail_notify_nudge($from, $to)
487 common_switch_locale($to->language);
488 // TRANS: Subject for 'nudge' notification email.
489 // TRANS: %s is the nudging user.
490 $subject = sprintf(_('You have been nudged by %s'), $from->nickname);
492 $from_profile = $from->getProfile();
494 // TRANS: Body for 'nudge' notification email.
495 // TRANS: %1$s is the nuding user's long name, $2$s is the nudging user's nickname,
496 // TRANS: %3$s is a URL to post notices at, %4$s is the StatusNet sitename.
497 $body = sprintf(_("%1\$s (%2\$s) is wondering what you are up to ".
498 "these days and is inviting you to post some news.\n\n".
499 "So let's hear from you :)\n\n".
501 "Don't reply to this email; it won't get to them.\n\n".
502 "With kind regards,\n".
504 $from_profile->getBestName(),
506 common_local_url('all', array('nickname' => $to->nickname)),
507 common_config('site', 'name'));
508 common_switch_locale();
510 $headers = _mail_prepare_headers('nudge', $to->nickname, $from->nickname);
512 return mail_to_user($to, $subject, $body, $headers);
516 * send a message to notify a user of a direct message (DM)
518 * This function checks to see if the recipient wants notification
519 * of DMs and has a configured email address.
521 * @param Message $message message to notify about
522 * @param User $from user sending message; default to sender
523 * @param User $to user receiving message; default to recipient
525 * @return boolean success code
527 function mail_notify_message($message, $from=null, $to=null)
529 if (is_null($from)) {
530 $from = User::staticGet('id', $message->from_profile);
534 $to = User::staticGet('id', $message->to_profile);
537 if (is_null($to->email) || !$to->emailnotifymsg) {
541 common_switch_locale($to->language);
542 // TRANS: Subject for direct-message notification email.
543 // TRANS: %s is the sending user's nickname.
544 $subject = sprintf(_('New private message from %s'), $from->nickname);
546 $from_profile = $from->getProfile();
548 // TRANS: Body for direct-message notification email.
549 // TRANS: %1$s is the sending user's long name, %2$s is the sending user's nickname,
550 // TRANS: %3$s is the message content, %4$s a URL to the message,
551 // TRANS: %5$s is the StatusNet sitename.
552 $body = sprintf(_("%1\$s (%2\$s) sent you a private message:\n\n".
553 "------------------------------------------------------\n".
555 "------------------------------------------------------\n\n".
556 "You can reply to their message here:\n\n".
558 "Don't reply to this email; it won't get to them.\n\n".
559 "With kind regards,\n".
561 $from_profile->getBestName(),
564 common_local_url('newmessage', array('to' => $from->id)),
565 common_config('site', 'name'));
567 $headers = _mail_prepare_headers('message', $to->nickname, $from->nickname);
569 common_switch_locale();
570 return mail_to_user($to, $subject, $body, $headers);
574 * notify a user that one of their notices has been chosen as a 'fave'
576 * Doesn't check that the user has an email address nor if they
577 * want to receive notification of faves. Maybe this happens higher
580 * @param User $other The user whose notice was faved
581 * @param User $user The user who faved the notice
582 * @param Notice $notice The notice that was faved
586 function mail_notify_fave($other, $user, $notice)
588 if (!$user->hasRight(Right::EMAILONFAVE)) {
592 $profile = $user->getProfile();
593 if ($other->hasBlocked($profile)) {
594 // If the author has blocked us, don't spam them with a notification.
598 $bestname = $profile->getBestName();
600 common_switch_locale($other->language);
602 // TRANS: Subject for favorite notification e-mail.
603 // TRANS: %1$s is the adding user's long name, %2$s is the adding user's nickname.
604 $subject = sprintf(_('%1$s (@%2$s) added your notice as a favorite'), $bestname, $user->nickname);
606 // TRANS: Body for favorite notification e-mail.
607 // TRANS: %1$s is the adding user's long name, $2$s is the date the notice was created,
608 // TRANS: %3$s is a URL to the faved notice, %4$s is the faved notice text,
609 // TRANS: %5$s is a URL to all faves of the adding user, %6$s is the StatusNet sitename,
610 // TRANS: %7$s is the adding user's nickname.
611 $body = sprintf(_("%1\$s (@%7\$s) just added your notice from %2\$s".
612 " as one of their favorites.\n\n" .
613 "The URL of your notice is:\n\n" .
615 "The text of your notice is:\n\n" .
617 "You can see the list of %1\$s's favorites here:\n\n" .
619 "Faithfully yours,\n" .
622 common_exact_date($notice->created),
623 common_local_url('shownotice',
624 array('notice' => $notice->id)),
626 common_local_url('showfavorites',
627 array('nickname' => $user->nickname)),
628 common_config('site', 'name'),
631 $headers = _mail_prepare_headers('fave', $other->nickname, $user->nickname);
633 common_switch_locale();
634 mail_to_user($other, $subject, $body, $headers);
638 * notify a user that they have received an "attn:" message AKA "@-reply"
640 * @param User $user The user who recevied the notice
641 * @param Notice $notice The notice that was sent
645 function mail_notify_attn($user, $notice)
647 if (!$user->email || !$user->emailnotifyattn) {
651 $sender = $notice->getProfile();
653 if ($sender->id == $user->id) {
657 if (!$sender->hasRight(Right::EMAILONREPLY)) {
661 $bestname = $sender->getBestName();
663 common_switch_locale($user->language);
665 if ($notice->hasConversation()) {
666 $conversationUrl = common_local_url('conversation',
667 array('id' => $notice->conversation)).'#notice-'.$notice->id;
668 // TRANS: Line in @-reply notification e-mail. %s is conversation URL.
669 $conversationEmailText = sprintf(_("The full conversation can be read here:\n\n".
670 "\t%s"), $conversationUrl) . "\n\n";
672 $conversationEmailText = '';
675 // TRANS: E-mail subject for notice notification.
676 // TRANS: %1$s is the sending user's long name, %2$s is the adding user's nickname.
677 $subject = sprintf(_('%1$s (@%2$s) sent a notice to your attention'), $bestname, $sender->nickname);
679 // TRANS: Body of @-reply notification e-mail.
680 // TRANS: %1$s is the sending user's long name, $2$s is the StatusNet sitename,
681 // TRANS: %3$s is a URL to the notice, %4$s is the notice text,
682 // TRANS: %5$s is a URL to the full conversion if it exists (otherwise empty),
683 // TRANS: %6$s is a URL to reply to the notice, %7$s is a URL to all @-replied for the addressed user,
684 // TRANS: %8$s is a URL to the addressed user's e-mail settings, %9$s is the sender's nickname.
685 $body = sprintf(_("%1\$s (@%9\$s) just sent a notice to your attention (an '@-reply') on %2\$s.\n\n".
686 "The notice is here:\n\n".
691 "You can reply back here:\n\n".
693 "The list of all @-replies for you here:\n\n" .
695 "Faithfully yours,\n" .
697 "P.S. You can turn off these email notifications here: %8\$s\n"),
699 common_config('site', 'name'),//%2
700 common_local_url('shownotice',
701 array('notice' => $notice->id)),//%3
702 $notice->content,//%4
703 $conversationEmailText,//%5
704 common_local_url('newnotice',
705 array('replyto' => $sender->nickname, 'inreplyto' => $notice->id)),//%6
706 common_local_url('replies',
707 array('nickname' => $user->nickname)),//%7
708 common_local_url('emailsettings'), //%8
709 $sender->nickname); //%9
711 $headers = _mail_prepare_headers('mention', $user->nickname, $sender->nickname);
713 common_switch_locale();
714 mail_to_user($user, $subject, $body, $headers);
718 * Prepare the common mail headers used in notification emails
720 * @param string $msg_type type of message being sent to the user
721 * @param string $to nickname of the receipient
722 * @param string $from nickname of the user triggering the notification
724 * @return array list of mail headers to include in the message
726 function _mail_prepare_headers($msg_type, $to, $from)
729 'X-StatusNet-MessageType' => $msg_type,
730 'X-StatusNet-TargetUser' => $to,
731 'X-StatusNet-SourceUser' => $from,
732 'X-StatusNet-Domain' => common_config('site', 'server')