3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"shortcut icon" href=
"../../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.0.5">
17 <title>userNotificationEvent - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.77f3fd56.min.css">
24 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.7fa14f5b.min.css">
28 <meta name=
"theme-color" content=
"#009485">
38 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
52 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
56 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
57 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
58 <label class=
"md-overlay" for=
"__drawer"></label>
59 <div data-md-component=
"skip">
62 <a href=
"#user-notification-event-package-installation-plugin" class=
"md-skip">
67 <div data-md-component=
"announce">
69 <aside class=
"md-announce">
70 <div class=
"md-announce__inner md-grid md-typeset">
72 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
81 <header class=
"md-header" data-md-component=
"header">
82 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
83 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation">
85 <img src=
"../../../assets/logo.png" alt=
"logo">
88 <label class=
"md-header__button md-icon" for=
"__drawer">
89 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
91 <div class=
"md-header__title" data-md-component=
"header-title">
92 <div class=
"md-header__ellipsis">
93 <div class=
"md-header__topic">
94 <span class=
"md-ellipsis">
95 WoltLab Suite Documentation
98 <div class=
"md-header__topic" data-md-component=
"header-topic">
99 <span class=
"md-ellipsis">
101 userNotificationEvent
107 <div class=
"md-header__options">
112 <div class=
"md-header__source">
114 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
115 <div class=
"md-source__icon md-icon">
117 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05L244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
119 <div class=
"md-source__repository">
128 <div class=
"md-container" data-md-component=
"container">
133 <main class=
"md-main" data-md-component=
"main">
134 <div class=
"md-main__inner md-grid">
138 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
139 <div class=
"md-sidebar__scrollwrap">
140 <div class=
"md-sidebar__inner">
146 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
147 <label class=
"md-nav__title" for=
"__drawer">
148 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation">
150 <img src=
"../../../assets/logo.png" alt=
"logo">
153 WoltLab Suite Documentation
156 <div class=
"md-nav__source">
158 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
159 <div class=
"md-source__icon md-icon">
161 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05L244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
163 <div class=
"md-source__repository">
169 <ul class=
"md-nav__list" data-md-scrollfix
>
178 <li class=
"md-nav__item">
179 <a href=
"../../../getting-started/" class=
"md-nav__link">
194 <li class=
"md-nav__item md-nav__item--nested">
197 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
199 <label class=
"md-nav__link" for=
"__nav_2">
201 <span class=
"md-nav__icon md-icon"></span>
203 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
204 <label class=
"md-nav__title" for=
"__nav_2">
205 <span class=
"md-nav__icon md-icon"></span>
208 <ul class=
"md-nav__list" data-md-scrollfix
>
214 <li class=
"md-nav__item">
215 <a href=
"../../../php/pages/" class=
"md-nav__link">
226 <li class=
"md-nav__item">
227 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
238 <li class=
"md-nav__item">
239 <a href=
"../../../php/database-access/" class=
"md-nav__link">
250 <li class=
"md-nav__item">
251 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
263 <li class=
"md-nav__item md-nav__item--nested">
266 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
268 <label class=
"md-nav__link" for=
"__nav_2_5">
270 <span class=
"md-nav__icon md-icon"></span>
272 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
273 <label class=
"md-nav__title" for=
"__nav_2_5">
274 <span class=
"md-nav__icon md-icon"></span>
277 <ul class=
"md-nav__list" data-md-scrollfix
>
283 <li class=
"md-nav__item">
284 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
295 <li class=
"md-nav__item">
296 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
307 <li class=
"md-nav__item">
308 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
319 <li class=
"md-nav__item">
320 <a href=
"../../../php/api/events/" class=
"md-nav__link">
332 <li class=
"md-nav__item md-nav__item--nested">
335 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
337 <label class=
"md-nav__link" for=
"__nav_2_5_5">
339 <span class=
"md-nav__icon md-icon"></span>
341 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
342 <label class=
"md-nav__title" for=
"__nav_2_5_5">
343 <span class=
"md-nav__icon md-icon"></span>
346 <ul class=
"md-nav__list" data-md-scrollfix
>
352 <li class=
"md-nav__item">
353 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
364 <li class=
"md-nav__item">
365 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
376 <li class=
"md-nav__item">
377 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
388 <li class=
"md-nav__item">
389 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
400 <li class=
"md-nav__item">
401 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
418 <li class=
"md-nav__item">
419 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
420 Package Installation Plugins
430 <li class=
"md-nav__item">
431 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
442 <li class=
"md-nav__item">
443 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
454 <li class=
"md-nav__item">
455 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
472 <li class=
"md-nav__item">
473 <a href=
"../../../php/code-style/" class=
"md-nav__link">
484 <li class=
"md-nav__item">
485 <a href=
"../../../php/apps/" class=
"md-nav__link">
496 <li class=
"md-nav__item">
497 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
518 <li class=
"md-nav__item md-nav__item--nested">
521 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
523 <label class=
"md-nav__link" for=
"__nav_3">
524 Languages, Templates & CSS
525 <span class=
"md-nav__icon md-icon"></span>
527 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
528 <label class=
"md-nav__title" for=
"__nav_3">
529 <span class=
"md-nav__icon md-icon"></span>
530 Languages, Templates & CSS
532 <ul class=
"md-nav__list" data-md-scrollfix
>
538 <li class=
"md-nav__item">
539 <a href=
"../../../view/languages/" class=
"md-nav__link">
550 <li class=
"md-nav__item">
551 <a href=
"../../../view/templates/" class=
"md-nav__link">
562 <li class=
"md-nav__item">
563 <a href=
"../../../view/css/" class=
"md-nav__link">
584 <li class=
"md-nav__item md-nav__item--nested">
587 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
589 <label class=
"md-nav__link" for=
"__nav_4">
591 <span class=
"md-nav__icon md-icon"></span>
593 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
594 <label class=
"md-nav__title" for=
"__nav_4">
595 <span class=
"md-nav__icon md-icon"></span>
598 <ul class=
"md-nav__list" data-md-scrollfix
>
604 <li class=
"md-nav__item">
605 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
617 <li class=
"md-nav__item md-nav__item--nested">
620 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
622 <label class=
"md-nav__link" for=
"__nav_4_2">
624 <span class=
"md-nav__icon md-icon"></span>
626 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
627 <label class=
"md-nav__title" for=
"__nav_4_2">
628 <span class=
"md-nav__icon md-icon"></span>
631 <ul class=
"md-nav__list" data-md-scrollfix
>
637 <li class=
"md-nav__item">
638 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
649 <li class=
"md-nav__item">
650 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
661 <li class=
"md-nav__item">
662 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
673 <li class=
"md-nav__item">
674 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
685 <li class=
"md-nav__item">
686 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
697 <li class=
"md-nav__item">
698 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
709 <li class=
"md-nav__item">
710 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
721 <li class=
"md-nav__item">
722 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
723 Browser and Screen Sizes
733 <li class=
"md-nav__item">
734 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
751 <li class=
"md-nav__item">
752 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
763 <li class=
"md-nav__item">
764 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
775 <li class=
"md-nav__item">
776 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
799 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
802 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" checked
>
804 <label class=
"md-nav__link" for=
"__nav_5">
806 <span class=
"md-nav__icon md-icon"></span>
808 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
809 <label class=
"md-nav__title" for=
"__nav_5">
810 <span class=
"md-nav__icon md-icon"></span>
813 <ul class=
"md-nav__list" data-md-scrollfix
>
819 <li class=
"md-nav__item">
820 <a href=
"../../package-xml/" class=
"md-nav__link">
834 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
837 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" checked
>
839 <label class=
"md-nav__link" for=
"__nav_5_2">
841 <span class=
"md-nav__icon md-icon"></span>
843 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
844 <label class=
"md-nav__title" for=
"__nav_5_2">
845 <span class=
"md-nav__icon md-icon"></span>
848 <ul class=
"md-nav__list" data-md-scrollfix
>
854 <li class=
"md-nav__item">
855 <a href=
"../" class=
"md-nav__link">
866 <li class=
"md-nav__item">
867 <a href=
"../acl-option/" class=
"md-nav__link">
878 <li class=
"md-nav__item">
879 <a href=
"../acp-menu/" class=
"md-nav__link">
890 <li class=
"md-nav__item">
891 <a href=
"../acp-search-provider/" class=
"md-nav__link">
902 <li class=
"md-nav__item">
903 <a href=
"../acp-template/" class=
"md-nav__link">
914 <li class=
"md-nav__item">
915 <a href=
"../bbcode/" class=
"md-nav__link">
926 <li class=
"md-nav__item">
927 <a href=
"../box/" class=
"md-nav__link">
938 <li class=
"md-nav__item">
939 <a href=
"../clipboard-action/" class=
"md-nav__link">
950 <li class=
"md-nav__item">
951 <a href=
"../core-object/" class=
"md-nav__link">
962 <li class=
"md-nav__item">
963 <a href=
"../cronjob/" class=
"md-nav__link">
974 <li class=
"md-nav__item">
975 <a href=
"../event-listener/" class=
"md-nav__link">
986 <li class=
"md-nav__item">
987 <a href=
"../file/" class=
"md-nav__link">
998 <li class=
"md-nav__item">
999 <a href=
"../language/" class=
"md-nav__link">
1010 <li class=
"md-nav__item">
1011 <a href=
"../media-provider/" class=
"md-nav__link">
1022 <li class=
"md-nav__item">
1023 <a href=
"../menu/" class=
"md-nav__link">
1034 <li class=
"md-nav__item">
1035 <a href=
"../menu-item/" class=
"md-nav__link">
1046 <li class=
"md-nav__item">
1047 <a href=
"../object-type/" class=
"md-nav__link">
1058 <li class=
"md-nav__item">
1059 <a href=
"../object-type-definition/" class=
"md-nav__link">
1060 objectTypeDefinition
1070 <li class=
"md-nav__item">
1071 <a href=
"../option/" class=
"md-nav__link">
1082 <li class=
"md-nav__item">
1083 <a href=
"../page/" class=
"md-nav__link">
1094 <li class=
"md-nav__item">
1095 <a href=
"../pip/" class=
"md-nav__link">
1106 <li class=
"md-nav__item">
1107 <a href=
"../script/" class=
"md-nav__link">
1118 <li class=
"md-nav__item">
1119 <a href=
"../smiley/" class=
"md-nav__link">
1130 <li class=
"md-nav__item">
1131 <a href=
"../sql/" class=
"md-nav__link">
1142 <li class=
"md-nav__item">
1143 <a href=
"../style/" class=
"md-nav__link">
1154 <li class=
"md-nav__item">
1155 <a href=
"../template/" class=
"md-nav__link">
1166 <li class=
"md-nav__item">
1167 <a href=
"../template-listener/" class=
"md-nav__link">
1178 <li class=
"md-nav__item">
1179 <a href=
"../user-group-option/" class=
"md-nav__link">
1190 <li class=
"md-nav__item">
1191 <a href=
"../user-menu/" class=
"md-nav__link">
1204 <li class=
"md-nav__item md-nav__item--active">
1206 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1211 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1212 userNotificationEvent
1213 <span class=
"md-nav__icon md-icon"></span>
1216 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1217 userNotificationEvent
1221 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1227 <label class=
"md-nav__title" for=
"__toc">
1228 <span class=
"md-nav__icon md-icon"></span>
1231 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1233 <li class=
"md-nav__item">
1234 <a href=
"#components" class=
"md-nav__link">
1238 <nav class=
"md-nav" aria-label=
"Components">
1239 <ul class=
"md-nav__list">
1241 <li class=
"md-nav__item">
1242 <a href=
"#objecttype" class=
"md-nav__link">
1248 <li class=
"md-nav__item">
1249 <a href=
"#classname" class=
"md-nav__link">
1255 <li class=
"md-nav__item">
1256 <a href=
"#preset" class=
"md-nav__link">
1262 <li class=
"md-nav__item">
1263 <a href=
"#presetmailnotificationtype" class=
"md-nav__link">
1264 <presetmailnotificationtype
>
1269 <li class=
"md-nav__item">
1270 <a href=
"#options" class=
"md-nav__link">
1276 <li class=
"md-nav__item">
1277 <a href=
"#permissions" class=
"md-nav__link">
1288 <li class=
"md-nav__item">
1289 <a href=
"#example" class=
"md-nav__link">
1307 <li class=
"md-nav__item">
1308 <a href=
"../user-option/" class=
"md-nav__link">
1319 <li class=
"md-nav__item">
1320 <a href=
"../user-profile-menu/" class=
"md-nav__link">
1337 <li class=
"md-nav__item">
1338 <a href=
"../../database-php-api/" class=
"md-nav__link">
1359 <li class=
"md-nav__item md-nav__item--nested">
1362 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1364 <label class=
"md-nav__link" for=
"__nav_6">
1366 <span class=
"md-nav__icon md-icon"></span>
1368 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1369 <label class=
"md-nav__title" for=
"__nav_6">
1370 <span class=
"md-nav__icon md-icon"></span>
1373 <ul class=
"md-nav__list" data-md-scrollfix
>
1380 <li class=
"md-nav__item md-nav__item--nested">
1383 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1385 <label class=
"md-nav__link" for=
"__nav_6_1">
1386 Migrating from WSC
5.3
1387 <span class=
"md-nav__icon md-icon"></span>
1389 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1390 <label class=
"md-nav__title" for=
"__nav_6_1">
1391 <span class=
"md-nav__icon md-icon"></span>
1392 Migrating from WSC
5.3
1394 <ul class=
"md-nav__list" data-md-scrollfix
>
1400 <li class=
"md-nav__item">
1401 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1412 <li class=
"md-nav__item">
1413 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1414 Session Handling and Authentication
1424 <li class=
"md-nav__item">
1425 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1436 <li class=
"md-nav__item">
1437 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1448 <li class=
"md-nav__item">
1449 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1450 Third Party Libraries
1467 <li class=
"md-nav__item md-nav__item--nested">
1470 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1472 <label class=
"md-nav__link" for=
"__nav_6_2">
1473 Migrating from WSC
5.2
1474 <span class=
"md-nav__icon md-icon"></span>
1476 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1477 <label class=
"md-nav__title" for=
"__nav_6_2">
1478 <span class=
"md-nav__icon md-icon"></span>
1479 Migrating from WSC
5.2
1481 <ul class=
"md-nav__list" data-md-scrollfix
>
1487 <li class=
"md-nav__item">
1488 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1499 <li class=
"md-nav__item">
1500 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1501 Templates and Languages
1511 <li class=
"md-nav__item">
1512 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1513 Third Party Libraries
1530 <li class=
"md-nav__item md-nav__item--nested">
1533 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1535 <label class=
"md-nav__link" for=
"__nav_6_3">
1536 Migrating from WSC
3.1
1537 <span class=
"md-nav__icon md-icon"></span>
1539 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1540 <label class=
"md-nav__title" for=
"__nav_6_3">
1541 <span class=
"md-nav__icon md-icon"></span>
1542 Migrating from WSC
3.1
1544 <ul class=
"md-nav__list" data-md-scrollfix
>
1550 <li class=
"md-nav__item">
1551 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1569 <li class=
"md-nav__item md-nav__item--nested">
1572 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1574 <label class=
"md-nav__link" for=
"__nav_6_4">
1575 Migrating from WSC
3.0
1576 <span class=
"md-nav__icon md-icon"></span>
1578 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1579 <label class=
"md-nav__title" for=
"__nav_6_4">
1580 <span class=
"md-nav__icon md-icon"></span>
1581 Migrating from WSC
3.0
1583 <ul class=
"md-nav__list" data-md-scrollfix
>
1589 <li class=
"md-nav__item">
1590 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1601 <li class=
"md-nav__item">
1602 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1613 <li class=
"md-nav__item">
1614 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1625 <li class=
"md-nav__item">
1626 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1637 <li class=
"md-nav__item">
1638 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1656 <li class=
"md-nav__item md-nav__item--nested">
1659 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1661 <label class=
"md-nav__link" for=
"__nav_6_5">
1662 Migrating from WCF
2.1
1663 <span class=
"md-nav__icon md-icon"></span>
1665 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1666 <label class=
"md-nav__title" for=
"__nav_6_5">
1667 <span class=
"md-nav__icon md-icon"></span>
1668 Migrating from WCF
2.1
1670 <ul class=
"md-nav__list" data-md-scrollfix
>
1676 <li class=
"md-nav__item">
1677 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1688 <li class=
"md-nav__item">
1689 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1700 <li class=
"md-nav__item">
1701 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1712 <li class=
"md-nav__item">
1713 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1740 <li class=
"md-nav__item md-nav__item--nested">
1743 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1745 <label class=
"md-nav__link" for=
"__nav_7">
1747 <span class=
"md-nav__icon md-icon"></span>
1749 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1750 <label class=
"md-nav__title" for=
"__nav_7">
1751 <span class=
"md-nav__icon md-icon"></span>
1754 <ul class=
"md-nav__list" data-md-scrollfix
>
1761 <li class=
"md-nav__item md-nav__item--nested">
1764 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1766 <label class=
"md-nav__link" for=
"__nav_7_1">
1768 <span class=
"md-nav__icon md-icon"></span>
1770 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1771 <label class=
"md-nav__title" for=
"__nav_7_1">
1772 <span class=
"md-nav__icon md-icon"></span>
1775 <ul class=
"md-nav__list" data-md-scrollfix
>
1781 <li class=
"md-nav__item">
1782 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1793 <li class=
"md-nav__item">
1794 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1805 <li class=
"md-nav__item">
1806 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1817 <li class=
"md-nav__item">
1818 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1845 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1846 <div class=
"md-sidebar__scrollwrap">
1847 <div class=
"md-sidebar__inner">
1849 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1855 <label class=
"md-nav__title" for=
"__toc">
1856 <span class=
"md-nav__icon md-icon"></span>
1859 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1861 <li class=
"md-nav__item">
1862 <a href=
"#components" class=
"md-nav__link">
1866 <nav class=
"md-nav" aria-label=
"Components">
1867 <ul class=
"md-nav__list">
1869 <li class=
"md-nav__item">
1870 <a href=
"#objecttype" class=
"md-nav__link">
1876 <li class=
"md-nav__item">
1877 <a href=
"#classname" class=
"md-nav__link">
1883 <li class=
"md-nav__item">
1884 <a href=
"#preset" class=
"md-nav__link">
1890 <li class=
"md-nav__item">
1891 <a href=
"#presetmailnotificationtype" class=
"md-nav__link">
1892 <presetmailnotificationtype
>
1897 <li class=
"md-nav__item">
1898 <a href=
"#options" class=
"md-nav__link">
1904 <li class=
"md-nav__item">
1905 <a href=
"#permissions" class=
"md-nav__link">
1916 <li class=
"md-nav__item">
1917 <a href=
"#example" class=
"md-nav__link">
1931 <div class=
"md-content" data-md-component=
"content">
1932 <article class=
"md-content__inner md-typeset">
1935 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/pip/user-notification-event.md" title=
"Edit this page" class=
"md-content__button md-icon">
1936 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
1940 <h1 id=
"user-notification-event-package-installation-plugin">User Notification Event Package Installation Plugin
<a class=
"headerlink" href=
"#user-notification-event-package-installation-plugin" title=
"Permanent link">#
</a></h1>
1941 <p>Registers new user notification events.
</p>
1942 <h2 id=
"components">Components
<a class=
"headerlink" href=
"#components" title=
"Permanent link">#
</a></h2>
1943 <p>Each package installation plugin is described as an
<code><event
></code> element with the mandatory child
<code><name
></code>.
</p>
1944 <h3 id=
"objecttype"><code><objectType
></code><a class=
"headerlink" href=
"#objecttype" title=
"Permanent link">#
</a></h3>
1945 <div class=
"admonition warning">
1946 <p class=
"admonition-title">The
<code>(name, objectType)
</code> pair must be unique.
</p>
1948 <p>The given object type must implement the
<code>com.woltlab.wcf.notification.objectType
</code> definition.
</p>
1949 <h3 id=
"classname"><code><classname
></code><a class=
"headerlink" href=
"#classname" title=
"Permanent link">#
</a></h3>
1950 <p>The name of the class providing the event's behaviour,
1951 the class has to implement the
<code>wcf\system\user\notification\event\IUserNotificationEvent
</code> interface.
</p>
1952 <h3 id=
"preset"><code><preset
></code><a class=
"headerlink" href=
"#preset" title=
"Permanent link">#
</a></h3>
1953 <p>Defines whether this event is enabled by default.
</p>
1954 <h3 id=
"presetmailnotificationtype"><code><presetmailnotificationtype
></code><a class=
"headerlink" href=
"#presetmailnotificationtype" title=
"Permanent link">#
</a></h3>
1955 <div class=
"admonition info">
1956 <p class=
"admonition-title">Avoid using this option, as sending unsolicited mail can be seen as spamming.
</p>
1958 <p>One of
<code>instant
</code> or
<code>daily
</code>.
1959 Defines whether this type of email notifications is enabled by default.
</p>
1960 <h3 id=
"options"><code><options
></code><a class=
"headerlink" href=
"#options" title=
"Permanent link">#
</a></h3>
1961 <p><span class=
"label label-info">Optional
</span></p>
1962 <p>The options element can contain a comma-separated list of options of which at least one needs to be enabled for the notification type to be available.
</p>
1963 <h3 id=
"permissions"><code><permissions
></code><a class=
"headerlink" href=
"#permissions" title=
"Permanent link">#
</a></h3>
1964 <p><span class=
"label label-info">Optional
</span></p>
1965 <p>The permissions element can contain a comma-separated list of permissions of which the active user needs to have at least one for the notification type to be available.
</p>
1966 <h2 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h2>
1967 <div class=
"highlight"><pre><span></span><code><span class=
"cp"><?xml version=
"1.0" encoding=
"UTF-
8"?
></span>
1968 <span class=
"nt"><data
</span> <span class=
"na">xmlns=
</span><span class=
"s">"http://www.woltlab.com
"</span> <span class=
"na">xmlns:xsi=
</span><span class=
"s">"http://www.w3.org/
2001/XMLSchema-instance
"</span> <span class=
"na">xsi:schemaLocation=
</span><span class=
"s">"http://www.woltlab.com http://www.woltlab.com/XSD/
2019/userNotificationEvent.xsd
"</span><span class=
"nt">></span>
1969 <span class=
"nt"><import
></span>
1970 <span class=
"nt"><event
></span>
1971 <span class=
"nt"><name
></span>like
<span class=
"nt"></name
></span>
1972 <span class=
"nt"><objecttype
></span>com.woltlab.example.comment.like.notification
<span class=
"nt"></objecttype
></span>
1973 <span class=
"nt"><classname
></span>wcf\system\user\notification\event\ExampleCommentLikeUserNotificationEvent
<span class=
"nt"></classname
></span>
1974 <span class=
"nt"><preset
></span>1<span class=
"nt"></preset
></span>
1975 <span class=
"nt"><options
></span>module_like
<span class=
"nt"></options
></span>
1976 <span class=
"nt"></event
></span>
1977 <span class=
"nt"></import
></span>
1978 <span class=
"nt"></data
></span>
1985 <div class=
"md-source-date">
1988 Last update:
2021-
01-
08
2006 <footer class=
"md-footer">
2008 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2010 <a href=
"../user-menu/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2011 <div class=
"md-footer__button md-icon">
2012 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
2014 <div class=
"md-footer__title">
2015 <div class=
"md-ellipsis">
2016 <span class=
"md-footer__direction">
2025 <a href=
"../user-option/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2026 <div class=
"md-footer__title">
2027 <div class=
"md-ellipsis">
2028 <span class=
"md-footer__direction">
2034 <div class=
"md-footer__button md-icon">
2035 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
2041 <div class=
"md-footer-meta md-typeset">
2042 <div class=
"md-footer-meta__inner md-grid">
2043 <div class=
"md-footer-copyright">
2045 <div class=
"md-footer-copyright__highlight">
2046 Copyright ©
2020 WoltLab GmbH
2050 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2055 <div class=
"md-footer-copyright">
2056 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2057 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2064 <div class=
"md-dialog" data-md-component=
"dialog">
2065 <div class=
"md-dialog__inner md-typeset"></div>
2067 <script id=
"__config" type=
"application/json">{
"base":
"../../..",
"features": [],
"translations": {
"clipboard.copy":
"Copy to clipboard",
"clipboard.copied":
"Copied to clipboard",
"search.config.lang":
"en",
"search.config.pipeline":
"trimmer, stopWordFilter",
"search.config.separator":
"[\\s\\-]+",
"search.placeholder":
"Search",
"search.result.placeholder":
"Type to start searching",
"search.result.none":
"No matching documents",
"search.result.one":
"1 matching document",
"search.result.other":
"# matching documents",
"search.result.more.one":
"1 more on this page",
"search.result.more.other":
"# more on this page",
"search.result.term.missing":
"Missing"},
"search":
"../../../assets/javascripts/workers/search.fb4a9340.min.js",
"version": {
"provider":
"mike"}}
</script>
2070 <script src=
"../../../assets/javascripts/bundle.5cf3e710.min.js"></script>