extern/egroupware_official
1
0
Fork 0
mirror of https://github.com/EGroupware/egroupware.git synced 2024-11-25 09:23:28 +01:00
Code Issues Packages Projects Releases Wiki Activity
0287ce0e0d
egroupware_official/notifications/inc/class.notifications_email.inc.php

181 lines
5.7 KiB
PHP
Raw Normal View History

Extended notification-app and egwpopup. Added winpopup-backend and email-backend. PHP5.1+ is now mandatory in trunk. For more infos look at the egw-developers list.
2007-11-22 09:29:16 +01:00
<?php
/**
use new API for notifiations
2016-05-06 11:19:36 +02:00
* EGroupware - Notifications
Extended notification-app and egwpopup. Added winpopup-backend and email-backend. PHP5.1+ is now mandatory in trunk. For more infos look at the egw-developers list.
2007-11-22 09:29:16 +01:00
*
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* @package notifications
little re-design of notifications: cleaned up relation between main class and backends. main class is responsible for notification routing. backends are responsible for sending one message to one user. relocated ajax functions to a separate file.
2007-12-18 16:53:38 +01:00
* @subpackage backends
Extended notification-app and egwpopup. Added winpopup-backend and email-backend. PHP5.1+ is now mandatory in trunk. For more infos look at the egw-developers list.
2007-11-22 09:29:16 +01:00
* @link http://www.egroupware.org
* @author Christian Binder <christian@jaytraxx.de>
added version
2008-07-30 08:49:55 +02:00
* @version $Id$
Extended notification-app and egwpopup. Added winpopup-backend and email-backend. PHP5.1+ is now mandatory in trunk. For more infos look at the egw-developers list.
2007-11-22 09:29:16 +01:00
*/
use new API for notifiations
2016-05-06 11:19:36 +02:00
use EGroupware\Api;
Extended notification-app and egwpopup. Added winpopup-backend and email-backend. PHP5.1+ is now mandatory in trunk. For more infos look at the egw-developers list.
2007-11-22 09:29:16 +01:00
/**
* User notification via email.
*/
enabled class autoloading for notifications, let admins enable or disable notification backends, security fixes for email and egwpopup backend, unified link arrays used for notifications
2008-01-30 19:58:00 +01:00
class notifications_email implements notifications_iface {
Extended notification-app and egwpopup. Added winpopup-backend and email-backend. PHP5.1+ is now mandatory in trunk. For more infos look at the egw-developers list.
2007-11-22 09:29:16 +01:00
/**
* Appname
*/
const _appname = 'notifications';
added version
2008-07-30 08:49:55 +02:00
Extended notification-app and egwpopup. Added winpopup-backend and email-backend. PHP5.1+ is now mandatory in trunk. For more infos look at the egw-developers list.
2007-11-22 09:29:16 +01:00
/**
* holds account object for user who sends the message
*
* @var object
*/
private $sender;
added version
2008-07-30 08:49:55 +02:00
Extended notification-app and egwpopup. Added winpopup-backend and email-backend. PHP5.1+ is now mandatory in trunk. For more infos look at the egw-developers list.
2007-11-22 09:29:16 +01:00
/**
* holds account object for user to notify
*
* @var object
*/
private $recipient;
added version
2008-07-30 08:49:55 +02:00
Extended notification-app and egwpopup. Added winpopup-backend and email-backend. PHP5.1+ is now mandatory in trunk. For more infos look at the egw-developers list.
2007-11-22 09:29:16 +01:00
/**
* holds config object (sitewide application config)
*
* @var object
*/
private $config;
added version
2008-07-30 08:49:55 +02:00
Extended notification-app and egwpopup. Added winpopup-backend and email-backend. PHP5.1+ is now mandatory in trunk. For more infos look at the egw-developers list.
2007-11-22 09:29:16 +01:00
/**
* holds preferences object of user to notify
*
use new API for notifiations
2016-05-06 11:19:36 +02:00
* @var Api\Preferences
Extended notification-app and egwpopup. Added winpopup-backend and email-backend. PHP5.1+ is now mandatory in trunk. For more infos look at the egw-developers list.
2007-11-22 09:29:16 +01:00
*/
private $preferences;
/**
* holds mail object
*
allow to add attachments by giving a path, instead of a string, eg. egw_vfs::PREFIX.$path for a vfs path in $path
2011-06-23 11:05:25 +02:00
* @var send
Extended notification-app and egwpopup. Added winpopup-backend and email-backend. PHP5.1+ is now mandatory in trunk. For more infos look at the egw-developers list.
2007-11-22 09:29:16 +01:00
*/
private $mail;
added version
2008-07-30 08:49:55 +02:00
Extended notification-app and egwpopup. Added winpopup-backend and email-backend. PHP5.1+ is now mandatory in trunk. For more infos look at the egw-developers list.
2007-11-22 09:29:16 +01:00
/**
enabled class autoloading for notifications, let admins enable or disable notification backends, security fixes for email and egwpopup backend, unified link arrays used for notifications
2008-01-30 19:58:00 +01:00
* constructor of notifications_email
Extended notification-app and egwpopup. Added winpopup-backend and email-backend. PHP5.1+ is now mandatory in trunk. For more infos look at the egw-developers list.
2007-11-22 09:29:16 +01:00
*
notification-app is now ready for non-eGW users as sender and recipients. deleted the old-style sending part from bo_tracking. this is not needed anymore.
2007-12-10 09:26:29 +01:00
* @param object $_sender
Extended notification-app and egwpopup. Added winpopup-backend and email-backend. PHP5.1+ is now mandatory in trunk. For more infos look at the egw-developers list.
2007-11-22 09:29:16 +01:00
* @param object $_recipient
notification-app is now ready for non-eGW users as sender and recipients. deleted the old-style sending part from bo_tracking. this is not needed anymore.
2007-12-10 09:26:29 +01:00
* @param object $_config
Extended notification-app and egwpopup. Added winpopup-backend and email-backend. PHP5.1+ is now mandatory in trunk. For more infos look at the egw-developers list.
2007-11-22 09:29:16 +01:00
* @param object $_preferences
*/
little re-design of notifications: cleaned up relation between main class and backends. main class is responsible for notification routing. backends are responsible for sending one message to one user. relocated ajax functions to a separate file.
2007-12-18 16:53:38 +01:00
public function __construct($_sender, $_recipient, $_config = null, $_preferences = null) {
if(!is_object($_sender)) { throw new Exception("no sender given."); }
if(!is_object($_recipient)) { throw new Exception("no recipient given."); }
$this->sender = $_sender;
$this->recipient = $_recipient;
$this->config = $_config;
$this->preferences = $_preferences;
rewrite of r33861, a bit more elegant
2011-02-21 17:30:27 +01:00
if(is_object($this->mail))
make sure the mail object is ALWAYS created new, as it may cause problems with the sender information, if notification is running as cronjob and trying to notify users with different senderinformation
2011-02-21 13:12:29 +01:00
{
unset($this->mail);
}
Notifications: Add configuration for account / address to use for sending notification emails If the app specifies a different sender (Calendar) that is still used instead. (cherry picked from commit 7d15c2f3521c64a412b03d6f5e643d0bbe112eb8)
2021-06-08 18:22:48 +02:00
allow notification to set sender different from current user / async-job owner
2024-02-29 08:56:40 +01:00
// Use configured mail account
Notifications: Add configuration for account / address to use for sending notification emails If the app specifies a different sender (Calendar) that is still used instead. (cherry picked from commit 7d15c2f3521c64a412b03d6f5e643d0bbe112eb8)
2021-06-08 18:22:48 +02:00
$ident = null;
* Notifications: Admins now configure the mail account to use for email notifications instead of the user account
2022-02-09 21:48:16 +01:00
if($this->config->async_identity)
Notifications: Add configuration for account / address to use for sending notification emails If the app specifies a different sender (Calendar) that is still used instead. (cherry picked from commit 7d15c2f3521c64a412b03d6f5e643d0bbe112eb8)
2021-06-08 18:22:48 +02:00
{
* Notifications/Async service: fix caching in mail account always used sender from first notification
2024-02-21 08:04:23 +01:00
$ident = Api\Mail\Account::read($this->config->async_identity, $_sender->account_id ?? null);
* Notifications: Admins now configure the mail account to use for email notifications instead of the user account
2022-02-09 21:48:16 +01:00
}
allow notification to set sender different from current user / async-job owner
2024-02-29 08:56:40 +01:00
$this->mail = new Api\Mailer($ident, $_sender->account_id ?? null);
Extended notification-app and egwpopup. Added winpopup-backend and email-backend. PHP5.1+ is now mandatory in trunk. For more infos look at the egw-developers list.
2007-11-22 09:29:16 +01:00
}
added version
2008-07-30 08:49:55 +02:00
Extended notification-app and egwpopup. Added winpopup-backend and email-backend. PHP5.1+ is now mandatory in trunk. For more infos look at the egw-developers list.
2007-11-22 09:29:16 +01:00
/**
* sends notification
*
* @param array $_messages
little re-design of notifications: cleaned up relation between main class and backends. main class is responsible for notification routing. backends are responsible for sending one message to one user. relocated ajax functions to a separate file.
2007-12-18 16:53:38 +01:00
* @param string $_subject
* @param array $_links
Extended notification-app and egwpopup. Added winpopup-backend and email-backend. PHP5.1+ is now mandatory in trunk. For more infos look at the egw-developers list.
2007-11-22 09:29:16 +01:00
* @param array $_attachments
* Notification: instead of overwritting From address use ReplyTo as mail provider might not allow to have a From different from envelope sender
2019-09-13 14:30:55 +02:00
* @param array $_data value for key "reply_to" to use a custom ReplyTo address
Extended notification-app and egwpopup. Added winpopup-backend and email-backend. PHP5.1+ is now mandatory in trunk. For more infos look at the egw-developers list.
2007-11-22 09:29:16 +01:00
*/
W.I.P restructuring of Notifications actions
2018-01-24 19:02:35 +01:00
public function send(array $_messages, $_subject = false, $_links = false, $_attachments = false, $_data = false)
get notifications working again with new egw_mailer
2014-11-25 15:22:16 +01:00
{
next chunk of fixed PHP Warning: Undefined array key or variable in main repo
2022-04-26 21:04:16 +02:00
$body_plain = $_messages['plain'].$this->render_links($_links, false, $this->preferences->external_mailclient??false);
$body_html = "<html><body>\n".$_messages['html'].$this->render_links($_links, true, $this->preferences->external_mailclient??false)."</body>\n</html>\n";
added version
2008-07-30 08:49:55 +02:00
Extended notification-app and egwpopup. Added winpopup-backend and email-backend. PHP5.1+ is now mandatory in trunk. For more infos look at the egw-developers list.
2007-11-22 09:29:16 +01:00
$this->mail->ClearAddresses();
$this->mail->ClearAttachments();
get notifications working again with new egw_mailer
2014-11-25 15:22:16 +01:00
$this->mail->addAddress($this->recipient->account_email, $this->recipient->account_fullname);
$this->mail->addHeader('X-EGroupware-Type', 'notification-mail');
$this->mail->addHeader('X-EGroupware-Install', $GLOBALS['egw_info']['server']['install_id'].'@'.$GLOBALS['egw_info']['server']['default_domain']);
//$this->mail->AddHeader('X-EGroupware-URL', 'notification-mail');
//$this->mail->AddHeader('X-EGroupware-Tracker', 'notification-mail');
rework sender/from/replyTo Information on notification
2014-11-18 11:50:35 +01:00
//error_log(__METHOD__.__LINE__."preparing notification message via email.".array2string($this->mail));
get notifications working again with new egw_mailer
2014-11-25 15:22:16 +01:00
* Notification: instead of overwritting From address use ReplyTo as mail provider might not allow to have a From different from envelope sender
2019-09-13 14:30:55 +02:00
if ( $_data && !empty( $_data['reply_to'] ) )
{
$this->mail->addReplyTo($_data['reply_to']);
}
// do NOT set sender as From, as this might not be allowed, set it instead as ReplyTo, if that one it not explicitly set already
elseif ($this->mail->getHeader('From') != Api\Mailer::add_personal($this->sender->account_email, $this->sender->account_fullname))
{
$this->mail->addReplyTo($this->sender->account_email, $this->sender->account_fullname);
Set replyTo header when it is set
2019-03-12 22:26:35 +01:00
}
* Notification/Mail: Fix / work around for BAD Header problem encountered in notifications for insufficiently encoded subject when sending alarm messages on extended notification format
2015-02-26 15:56:23 +01:00
$this->mail->addHeader('Subject', trim($_subject)); // trim the subject to avoid strange wrong encoding problem
Embed attached images of Notification html message as inline image
2017-10-27 19:03:54 +02:00
if ($_messages['html'])
{
// embed images as inline
\EGroupware\Api\Mail::processURL2InlineImages($this->mail, $body_html, null);
}
get notifications working again with new egw_mailer
2014-11-25 15:22:16 +01:00
$this->mail->setHtmlBody($body_html, null, false); // no automatic alternativ
$this->mail->setBody($body_plain);
allow to add attachments by giving a path, instead of a string, eg. egw_vfs::PREFIX.$path for a vfs path in $path
2011-06-23 11:05:25 +02:00
if(is_array($_attachments) && count($_attachments) > 0)
{
foreach($_attachments as $attachment)
{
if ($attachment->string)
{
$this->mail->AddStringAttachment($attachment->string, $attachment->filename, $attachment->encoding, $attachment->type);
}
elseif($attachment->path)
{
$this->mail->AddAttachment($attachment->path, $attachment->filename, $attachment->encoding, $attachment->type);
}
* Calendar Notification: handle calendar requests correctly as multipart/alternative; adding AltExtended to phpmailer; beware parts of multipartAlternative must be in decreasing order of preference (text/calendar as the last part)
2011-05-26 15:26:09 +02:00
}
Extended notification-app and egwpopup. Added winpopup-backend and email-backend. PHP5.1+ is now mandatory in trunk. For more infos look at the egw-developers list.
2007-11-22 09:29:16 +01:00
}
rework sender/from/replyTo Information on notification
2014-11-18 11:50:35 +01:00
//error_log(__METHOD__.__LINE__."about sending notification message via email.".array2string($this->mail));
get notifications working again with new egw_mailer
2014-11-25 15:22:16 +01:00
$this->mail->send();
Extended notification-app and egwpopup. Added winpopup-backend and email-backend. PHP5.1+ is now mandatory in trunk. For more infos look at the egw-developers list.
2007-11-22 09:29:16 +01:00
}
added version
2008-07-30 08:49:55 +02:00
little re-design of notifications: cleaned up relation between main class and backends. main class is responsible for notification routing. backends are responsible for sending one message to one user. relocated ajax functions to a separate file.
2007-12-18 16:53:38 +01:00
/**
* renders plaintext/html links from given link array
*
* @param array $_links
* @param boolean $_render_html
* @param boolean $_render_external
* @return plain or html rendered link(s) as complete string
*/
private function render_links($_links = false, $_render_html = false, $_render_external = true) {
if(!is_array($_links) || count($_links) == 0) { return false; }
added version
2008-07-30 08:49:55 +02:00
little re-design of notifications: cleaned up relation between main class and backends. main class is responsible for notification routing. backends are responsible for sending one message to one user. relocated ajax functions to a separate file.
2007-12-18 16:53:38 +01:00
// provide defaults if given arguments are null
// php distinguishes between missing and present(null) arguments
if(is_null($_render_html)) { $_render_html = false; }
if(is_null($_render_external)) { $_render_external = true; }
enabled class autoloading for notifications, let admins enable or disable notification backends, security fixes for email and egwpopup backend, unified link arrays used for notifications
2008-01-30 19:58:00 +01:00
$newline = $_render_html ? "<br />" : "\n";
use new API for notifiations
2016-05-06 11:19:36 +02:00
$hruler = $_render_html ? Api\Html::hr() : '';
added version
2008-07-30 08:49:55 +02:00
enabled class autoloading for notifications, let admins enable or disable notification backends, security fixes for email and egwpopup backend, unified link arrays used for notifications
2008-01-30 19:58:00 +01:00
$rendered_links = array();
little re-design of notifications: cleaned up relation between main class and backends. main class is responsible for notification routing. backends are responsible for sending one message to one user. relocated ajax functions to a separate file.
2007-12-18 16:53:38 +01:00
foreach($_links as $link) {
enabled class autoloading for notifications, let admins enable or disable notification backends, security fixes for email and egwpopup backend, unified link arrays used for notifications
2008-01-30 19:58:00 +01:00
if($_render_external || ! $link->popup) { $link->view['no_popup'] = 1; }
// do not expose sensitive data
use new API for notifiations
2016-05-06 11:19:36 +02:00
$url = preg_replace('/(sessionid|kp3|domain)=[^&]+&?/','',Api\Html::link('/index.php', $link->view));
enabled class autoloading for notifications, let admins enable or disable notification backends, security fixes for email and egwpopup backend, unified link arrays used for notifications
2008-01-30 19:58:00 +01:00
// complete missing protocol and domain part if needed
new method Api\Framework::getUrl() to get a full / externally usable Url
2018-03-21 12:40:59 +01:00
if ($url[0] == '/' && $_render_external) $url = Api\Framework::getUrl($url);
fixed: links rendered through both html::link and html::a_href get a wrong url
2009-10-09 21:51:25 +02:00
$a_href = '<a href="'.$url.'" target="_blank">'.$link->text.'</a>';
$rendered_links[] = $_render_html ? $a_href : $url;
little re-design of notifications: cleaned up relation between main class and backends. main class is responsible for notification routing. backends are responsible for sending one message to one user. relocated ajax functions to a separate file.
2007-12-18 16:53:38 +01:00
}
enabled class autoloading for notifications, let admins enable or disable notification backends, security fixes for email and egwpopup backend, unified link arrays used for notifications
2008-01-30 19:58:00 +01:00
return $hruler.$newline.lang('Linked entries:').$newline.implode($newline,$rendered_links);
little re-design of notifications: cleaned up relation between main class and backends. main class is responsible for notification routing. backends are responsible for sending one message to one user. relocated ajax functions to a separate file.
2007-12-18 16:53:38 +01:00
}
Extended notification-app and egwpopup. Added winpopup-backend and email-backend. PHP5.1+ is now mandatory in trunk. For more infos look at the egw-developers list.
2007-11-22 09:29:16 +01:00
remove not used/existing async_identity configuration
2022-03-28 18:47:56 +02:00
}
Reference in New Issue Copy Permalink