1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
|
<?php
/**
* IMP Hooks configuration file.
*
* THE HOOKS PROVIDED IN THIS FILE ARE EXAMPLES ONLY. DO NOT ENABLE THEM
* BLINDLY IF YOU DO NOT KNOW WHAT YOU ARE DOING. YOU HAVE TO CUSTOMIZE THEM
* TO MATCH YOUR SPECIFIC NEEDS AND SYSTEM ENVIRONMENT.
*
* For more information please see the horde/config/hooks.php.dist file.
*
* $Horde: imp/config/hooks.php.dist,v 1.3.2.4 2008/03/10 17:13:06 slusarz Exp $
*/
// Here is an example signature hook function to set the signature from the
// system taglines file; the string "%TAG%" (if present in a user's signature)
// will be replaced by the content of the file "/usr/share/tagline" (generated
// by the "TaRT" utility).
//
// Notice how we global in the $prefs array to get the user's current
// signature.
// if (!function_exists('_prefs_hook_signature')) {
// function _prefs_hook_signature($username = null)
// {
// $sig = $GLOBALS['prefs']->getValue('signature');
// if (preg_match('/%TAG%/', $sig)) {
// $tag = `cat /usr/share/tagline`;
// $sig = preg_replace('|%TAG%|', $tag, $sig);
// }
// return $sig;
// }
// }
// Here is an example _imp_hook_postlogin function to redirect to a
// custom server after login.
// if (!function_exists('_imp_hook_postlogin')) {
// function _imp_hook_postlogin($actionID, $isLogin)
// {
// header('Location: http://mail' . mt_rand(1, 9) . '.example.com/horde/');
// exit;
// }
// }
// This is an example for a post-sending hook that automatically prints all
// messages that have been sent successfully.
// if (!function_exists('_imp_hook_postsent')) {
// function _imp_hook_postsent($message, $headers)
// {
// require_once IMP_BASE . '/lib/MIME/Contents.php';
// require_once IMP_BASE . '/lib/UI/Message.php';
//
// IMP::printMode(true);
// $contents = new IMP_Contents($message);
// $contents->showSummaryLinks(false);
// $contents->buildMessage();
// $attachments = $contents->getAttachments();
// $msgText = $contents->getMessage();
//
// $imp_ui = new IMP_UI_Message();
// $basic_headers = $imp_ui->basicHeaders();
// $headers->setValueByFunction('date', array('nl2br', array($headers, 'addLocalTime'), 'htmlspecialchars'));
// if (($subject = $headers->getValue('subject'))) {
// $subject = IMP::filterText($subject);
// require_once 'Horde/Text.php';
// $headers->setValue('subject', Text::htmlSpaces($subject));
// } else {
// $headers->addHeader('Subject', _("[No Subject]"));
// }
// $headers->buildAddressLinks('from', null, true, false);
// foreach (array('to', 'cc', 'bcc') as $val) {
// $headers->buildAddressLinks($val, null, true, false);
// }
// if ($reply_to = $headers->buildAddressLinks('reply-to', null, false, false)) {
// if (!($from = $headers->getValue('from')) || ($from != $reply_to)) {
// $headers->setValue('Reply-to', $reply_to);
// } else {
// $headers->removeHeader('reply-to');
// }
// }
// $hdrs = array();
// foreach ($basic_headers as $head => $str) {
// if ($val = $headers->getValue($head)) {
// $hdrs[] = array('name' => $str, 'val' => $val, 'i' => 0);
// }
// }
// if ($val = $headers->getValue('priority')) {
// $hdrs[] = array('name' => _("Priority"), 'val' => $val, 'i' => 0);
// }
// if (!empty($attachments)) {
// $hdrs[] = array('name' => _("Part(s)"), 'val' => '<table cellspacing="2">' . $attachments . '</table>', 'i' => 0);
// }
//
// require_once IMP_BASE . '/lib/Template.php';
// $template = new IMP_Template();
// $template->set('headers', $hdrs);
// $template->set('msgtext', $msgText);
// $printer_friendly = true;
// require IMP_TEMPLATES . '/common-header.inc';
// echo $template->fetch(IMP_TEMPLATES . '/message/message.html');
// require $GLOBALS['registry']->get('templates', 'horde') . '/javascript/print.js';
// require $GLOBALS['registry']->get('templates', 'horde') . '/common-footer.inc';
// exit;
// }
// }
// Here is an example _imp_hook_trailer function to set the trailer from the
// system taglines file; the string "@@TAG@@" (if present in a trailer) will be
// replaced by the content of the file "/usr/share/tagline" (generated by the
// "TaRT" utility).
// if (!function_exists('_imp_hook_trailer')) {
// function _imp_hook_trailer($trailer)
// {
// if (preg_match('/@@TAG@@/', $trailer)) {
// $tag = `cat /usr/share/tagline`;
// $trailer = preg_replace('|@@TAG@@|', $tag, $trailer);
// }
// return $trailer;
// }
// }
// Here is an another example _imp_hook_trailer function to set the trailer
// from the LDAP directory for each domain. This function replaces the current
// trailer with the data it gets from ispmanDomainSignature.
// if (!function_exists('_imp_hook_trailer')) {
// function _imp_hook_trailer($trailer)
// {
// $vdomain = getenv('HTTP_HOST');
// $vdomain = preg_replace('|^.*?\.|i', '', $vdomain);
// $vdomain = String::lower($vdomain);
// $ldapServer = 'localhost';
// $ldapPort = '389';
// $searchBase = 'ispmanDomain=' . $vdomain . ",o=ispman";
//
// $ds = @ldap_connect($ldapServer, $ldapPort);
// $searchResult = @ldap_search($ds, $searchBase, 'uid=' . $vdomain);
// $information = @ldap_get_entries($ds, $searchResult);
// $trailer= $information[0]['ispmandomainsignature'][0];
// ldap_close($ds);
//
// return $trailer;
// }
// }
// Here is an example _imp_hook_vinfo function. If $type == 'vdomain', this
// function returns the HTTP_HOST variable after removing the 'mail.'
// subdomain.
//
// If $type == 'username', this function returns a unique username composed of
// $_SESSION['imp']['user'] + vdomain.
//
// ex. $HTTP_HOST = 'mail.mydomain.com', $_SESSION['imp']['user'] = 'myname':
// $vdomain = 'mydomain.com'
// $username = 'myname_mydomain_com'
// if (!function_exists('_imp_hook_vinfo')) {
// function _imp_hook_vinfo($type = 'username')
// {
// $vdomain = getenv('HTTP_HOST');
// $vdomain = preg_replace('|^mail\.|i', '', $vdomain);
// $vdomain = String::lower($vdomain);
//
// if ($type == 'username') {
// return preg_replace('|\.|', '_', $_SESSION['imp']['user'] . '_' . $vdomain);
// } elseif ($type == 'vdomain') {
// return $vdomain;
// } else {
// return PEAR::raiseError('invalid type: ' . $type);
// }
// }
// }
// Here is an example of the _imp_hook_fetchmail_filter function to run
// SpamAssassin on email before it is written to the mailbox.
// Note: to use the spamassassin instead of spamd, change 'spamc' to
// 'spamassassin -P' and add any other important arguments, but realize spamc
// is MUCH faster than spamassassin.
// WARNING: Make sure to use the --noadd-from filter on spamd or spamassassin
// if (!function_exists('_imp_hook_fetchmail_filter')) {
// function _imp_hook_fetchmail_filter($message)
// {
// // Where does SpamAssassin live, and what username should we use
// // for preferences?
// $cmd = '/usr/local/bin/spamc';
// $username = Auth::getAuth();
// // If you use the _sam_hook_username() hook, uncomment the next line
// //$username = _sam_hook_username($username);
// $username = escapeshellarg($username);
//
// // Also, we remove the file ourselves; this hook may be called
// // hundreds of times per run depending on how many messages we fetch
// $file = Horde::getTempFile('horde', false);
//
// // Call SpamAssassin; pipe the new message to our tempfile
// $fp = popen("$cmd -u $username > $file", 'w');
// fwrite($fp, $message);
// pclose($fp);
//
// // Read the new message from the temporary file
// $message = file_get_contents($file);
// unlink($file);
// return $message;
// }
// }
// Here is an example signature hook function to set the signature from the
// system taglines file; the string "%TAG%" (if present in a user's signature)
// will be replaced by the content of the file "/usr/share/tagline" (generated
// by the "TaRT" utility).
// if (!function_exists('_imp_hook_signature')) {
// function _imp_hook_signature($sig)
// {
// if (preg_match('/%TAG%/', $sig)) {
// $tag = `cat /usr/share/tagline`;
// $sig = preg_replace('/%TAG%/', $tag, $sig);
// }
//
// return $sig;
// }
// }
// This is an example hook function for displaying additional message
// information in the message listing screen for a mailbox. This example hook
// will add a icon if the message contains attachments and will change the
// display of the message entry based on the X-Priority header.
// if (!function_exists('_imp_hook_msglist_format')) {
// function _imp_hook_msglist_format($mailbox, $uid)
// {
// // Required return (array):
// // 'class' - An array of CSS classnames that will be added to
// // the row.
// // 'flagbits' - An integer value which will be OR'd with the
// // current flags set for the row. The IMAP flag
// // constants used in IMP can be found at the top
// // of lib/IMP.php.
// // 'status' - HTML code to add to the status column for the row.
// $ret = array('class' => array(), 'flagbits' => 0, 'status' => '');
//
// require_once IMP_BASE . '/lib/IMAP/MessageCache.php';
// $cache = &IMP_MessageCache::singleton();
// $cache_entry = $cache->retrieve($mailbox, array($uid), 8 | 32);
// $ob = reset($cache_entry);
//
// // Add attachment information
// require_once IMP_BASE . '/lib/UI/Mailbox.php';
// $imp_ui = new IMP_UI_Mailbox();
// if (($attachment = $imp_ui->getAttachmentType($ob->structure))) {
// $ret['status'] = Horde::img($attachment . '.png', $imp_ui->getAttachmentAlt($attachment), array('title' => $imp_ui->getAttachmentAlt($attachment)));
// }
//
// // Add xpriority information
// switch ($ob->header->getXpriority()) {
// case 'high':
// $ret['flagbits'] = IMP_FLAGGED;
// $ret['status'] .= Horde::img('mail_priority_high.png', _("High Priority"), array('title' => _("High Priority")));
// $ret['class'][] = 'important';
// break;
//
// case 'low':
// $ret['status'] .= Horde::img('mail_priority_low.png', _("Low Priority"), array('title' => _("Low Priority")));
// $ret['class'][] = 'unimportant';
// break;
// }
//
// return $ret;
// }
// }
// This is an example hook function for the IMP redirection scheme. This
// function is called when the user opens a mailbox in IMP, and allows the
// client to be redirected based on the mailbox name. The return value of this
// function should be a valid page within a horde application which will be
// placed in a "Location" header to redirect the client. The only parameter
// is the name of the mailbox which the user has opened. If an empty string
// is returned the user is not redirected.
// if (!function_exists('_imp_hook_mbox_redirect')) {
// function _imp_hook_mbox_redirect($mailbox)
// {
// require_once 'Horde/Kolab.php';
//
// if (strpos($mailbox, "INBOX/Calendar") !== false
// || preg_match("!^user/[^/]+/Calendar!", $mailbox)) {
// return $GLOBALS['registry']->get('webroot', 'kronolith');
// } elseif (strpos($mailbox, "INBOX/Tasks") !== false
// || preg_match("!^user/[^/]+/Tasks!", $mailbox)) {
// return $GLOBALS['registry']->get('webroot', 'nag');
// } elseif (strpos($mailbox, "INBOX/Notes") !== false
// || preg_match("!^user/[^/]+/Notes!", $mailbox)) {
// return $GLOBALS['registry']->get('webroot', 'mnemo');
// } elseif (strpos($mailbox, "INBOX/Contacts") !== false
// || preg_match("!^user/[^/]+/Contacts!", $mailbox)) {
// return $GLOBALS['registry']->get('webroot', 'turba');
// }
//
// return '';
// }
// }
// This is an example hook function for the IMP mailbox icon scheme. This
// function is called when the folder list is created and a "standard" folder
// is to be displayed - it allows custom folder icons to be specified.
// ("Standard" means all folders except the INBOX, sent-mail folders and
// trash folders.)
// If a mailbox name doesn't appear in the below list, the default mailbox
// icon is displayed.
// Note that in IMP 4.2.x, the expected return value from this hook has
// changed. See the below examples for more information.
// if (!function_exists('_imp_hook_mbox_icons')) {
// function _imp_hook_mbox_icons()
// {
// static $newmailboxes;
//
// if (!empty($newmailboxes)) {
// return $newmailboxes;
// }
//
// require_once 'Horde/Kolab.php';
//
// $kc = new Kolab_Cyrus($GLOBALS['conf']['kolab']['server']);
// $mailboxes = $kc->listMailBoxes();
// $newmailboxes = array();
//
// foreach ($mailboxes as $box) {
// $box = preg_replace("/^{[^}]+}/", "", $box);
// if (strpos($box, "INBOX/Calendar") !== false
// || preg_match("!^user/[^/]+/Calendar!", $box)) {
// $newmailboxes[$box] = Horde::img(
// $GLOBALS['registry']->get('icon', 'kronolith'),
// _("Calendar"),
// 'width="16" height="16" style="vertical-align:middle"',
// ''
// );
// // Use this example for IMP 4.2.x+.
// // $newmailboxes[$box] = array(
// // 'icon' => 'kronolith.png',
// // 'icondir' => $GLOBALS['registry']->getImageDir('kronolith')
// // 'alt' => _("Calendar")
// // );
// } elseif (strpos($box, "INBOX/Tasks") !== false
// || preg_match("!^user/[^/]+/Tasks!", $box)) {
// $newmailboxes[$box] = Horde::img(
// $GLOBALS['registry']->get('icon', 'nag'),
// _("Tasks"),
// 'width="16" height="16" style="vertical-align:middle"',
// ''
// );
// // Use this example for IMP 4.2.x+.
// // $newmailboxes[$box] = array(
// // 'icon' => 'nag.png',
// // 'icondir' => $GLOBALS['registry']->getImageDir('nag')
// // 'alt' => _("Tasks")
// // );
// } elseif (strpos($box, "INBOX/Notes") !== false
// || preg_match("!^user/[^/]+/Notes!", $box)) {
// $newmailboxes[$box] = Horde::img(
// $GLOBALS['registry']->get('icon', 'mnemo'),
// _("Notes"),
// 'width="16" height="16" style="vertical-align:middle"',
// ''
// );
// // Use this example for IMP 4.2.x+.
// // $newmailboxes[$box] = array(
// // 'icon' => 'mnemo.png',
// // 'icondir' => $GLOBALS['registry']->getImageDir('mnemo')
// // 'alt' => _("Notes")
// // );
// } elseif (strpos($box, "INBOX/Contacts") !== false
// || preg_match("!^user/[^/]+/Contacts!", $box)) {
// $newmailboxes[$box] = Horde::img(
// $GLOBALS['registry']->get('icon', 'turba'),
// _("Contacts"),
// 'width="16" height="16" style="vertical-align:middle"',
// ''
// );
// // Use this example for IMP 4.2.x+.
// // $newmailboxes[$box] = array(
// // 'icon' => 'turba.png',
// // 'icondir' => $GLOBALS['registry']->getImageDir('turba')
// // 'alt' => _("Contacts")
// // );
// }
// }
//
// return $newmailboxes;
// }
// }
// This is an example hook function for the IMP spam reporting bounce option.
// This function is called when the message is about to be bounced - it
// will return the email address to bounce to. This is handy for spam
// reporting software (e.g. DSPAM) which has different e-mail aliases for
// spam reporting for each user.
// if (!function_exists('_imp_hook_spam_bounce')) {
// function _imp_hook_spam_bounce($action)
// {
// $prefix = ($action == 'spam') ? 'spam-' : 'fp-';
// return $prefix . Auth::getBareAuth() . '@example.com';
// }
// }
// Default Kolab hooks:
if (!empty($GLOBALS['conf']['kolab']['enabled'])) {
require_once 'Horde/Kolab.php';
if (!function_exists('_imp_hook_mbox_redirect')) {
function _imp_hook_mbox_redirect($mailbox)
{
switch (Kolab::getMailboxType($mailbox)) {
case 'event':
return $GLOBALS['registry']->get('webroot', 'kronolith');
case 'task':
return $GLOBALS['registry']->get('webroot', 'nag');
case 'note':
return $GLOBALS['registry']->get('webroot', 'mnemo');
case 'contact':
return $GLOBALS['registry']->get('webroot', 'turba');
default:
return '';
}
}
function _imp_hook_mbox_icons()
{
static $icons;
if (!empty($icons)) {
return $icons;
}
$folders = Kolab::listFolders();
$icons = array();
foreach ($folders as $folder) {
$name = preg_replace('/^{[^}]+}/', '', $folder[0]);
switch ($folder[1]) {
case 'event':
$icons[$name] = array(
'icon' => 'kronolith.png',
'icondir' => $GLOBALS['registry']->getImageDir('kronolith'),
'alt' => _("Calendar")
);
break;
case 'task':
$icons[$name] = array(
'icon' => 'nag.png',
'icondir' => $GLOBALS['registry']->getImageDir('nag'),
'alt' => _("Tasks")
);
break;
case 'note':
$icons[$name] = array(
'icon' => 'mnemo.png',
'icondir' => $GLOBALS['registry']->getImageDir('mnemo'),
'alt' => _("Notes")
);
break;
case 'contact':
$icons[$name] = array(
'icon' => 'turba.png',
'icondir' => $GLOBALS['registry']->getImageDir('turba'),
'alt' => _("Contacts")
);
break;
}
}
return $icons;
}
}
}
// Sample function for returning the quota. Uses the PECL ssh2
// extension.
//
// @param array $params Parameters for the function, set in servers.php
//
// @return array Tuple with two members:
// first: disk space used (in bytes)
// second: maximum disk space (in bytes)
// In case of an error, return PEAR::raiseError()
if (!function_exists('_imp_hook_quota')) {
function _imp_hook_quota($params = null)
{
$host = $_SESSION['imp']['server'];
$user = $_SESSION['imp']['user'];
$pass = Auth::getCredential('password');
$command = $params[0];
$session = ssh2_connect($host);
if (!$session) {
return PEAR::raiseError(_("Connection to server failed."), 'horde.error');
}
if (!ssh2_auth_password($session, $user, $pass)) {
return PEAR::raiseError(_("Authentication failed."), 'horde.error');
}
$stream = ssh2_exec($session, $command, false);
stream_set_blocking($stream, true);
$quota = preg_split('/\s+/', trim(stream_get_contents($stream)), 2);
return array($quota[1] * 1024, $quota[2] * 1024);
}
}
|
