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">
37 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
51 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
55 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
56 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
57 <label class=
"md-overlay" for=
"__drawer"></label>
58 <div data-md-component=
"skip">
61 <a href=
"#user-notification-event-package-installation-plugin" class=
"md-skip">
66 <div data-md-component=
"announce">
68 <aside class=
"md-announce">
69 <div class=
"md-announce__inner md-grid md-typeset">
71 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
80 <header class=
"md-header" data-md-component=
"header">
81 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
82 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation">
84 <img src=
"../../../assets/logo.png" alt=
"logo">
87 <label class=
"md-header__button md-icon" for=
"__drawer">
88 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
90 <div class=
"md-header__title" data-md-component=
"header-title">
91 <div class=
"md-header__ellipsis">
92 <div class=
"md-header__topic">
93 <span class=
"md-ellipsis">
94 WoltLab Suite Documentation
97 <div class=
"md-header__topic" data-md-component=
"header-topic">
98 <span class=
"md-ellipsis">
100 userNotificationEvent
106 <div class=
"md-header__options">
110 <label class=
"md-header__button md-icon" for=
"__search">
111 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
114 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
115 <label class=
"md-search__overlay" for=
"__search"></label>
116 <div class=
"md-search__inner" role=
"search">
117 <form class=
"md-search__form" name=
"search">
118 <input type=
"text" class=
"md-search__input" name=
"query" aria-label=
"Search" placeholder=
"Search" autocapitalize=
"off" autocorrect=
"off" autocomplete=
"off" spellcheck=
"false" data-md-component=
"search-query" data-md-state=
"active" required
>
119 <label class=
"md-search__icon md-icon" for=
"__search">
120 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
121 <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>
123 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
124 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
127 <div class=
"md-search__output">
128 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
129 <div class=
"md-search-result" data-md-component=
"search-result">
130 <div class=
"md-search-result__meta">
133 <ol class=
"md-search-result__list"></ol>
144 <div class=
"md-container" data-md-component=
"container">
149 <main class=
"md-main" data-md-component=
"main">
150 <div class=
"md-main__inner md-grid">
154 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
155 <div class=
"md-sidebar__scrollwrap">
156 <div class=
"md-sidebar__inner">
162 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
163 <label class=
"md-nav__title" for=
"__drawer">
164 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation">
166 <img src=
"../../../assets/logo.png" alt=
"logo">
169 WoltLab Suite Documentation
172 <ul class=
"md-nav__list" data-md-scrollfix
>
181 <li class=
"md-nav__item">
182 <a href=
"../../../getting-started/" class=
"md-nav__link">
197 <li class=
"md-nav__item md-nav__item--nested">
200 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
202 <label class=
"md-nav__link" for=
"__nav_2">
204 <span class=
"md-nav__icon md-icon"></span>
206 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
207 <label class=
"md-nav__title" for=
"__nav_2">
208 <span class=
"md-nav__icon md-icon"></span>
211 <ul class=
"md-nav__list" data-md-scrollfix
>
217 <li class=
"md-nav__item">
218 <a href=
"../../../php/pages/" class=
"md-nav__link">
229 <li class=
"md-nav__item">
230 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
241 <li class=
"md-nav__item">
242 <a href=
"../../../php/database-access/" class=
"md-nav__link">
253 <li class=
"md-nav__item">
254 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
266 <li class=
"md-nav__item md-nav__item--nested">
269 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
271 <label class=
"md-nav__link" for=
"__nav_2_5">
273 <span class=
"md-nav__icon md-icon"></span>
275 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
276 <label class=
"md-nav__title" for=
"__nav_2_5">
277 <span class=
"md-nav__icon md-icon"></span>
280 <ul class=
"md-nav__list" data-md-scrollfix
>
286 <li class=
"md-nav__item">
287 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
298 <li class=
"md-nav__item">
299 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
310 <li class=
"md-nav__item">
311 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
322 <li class=
"md-nav__item">
323 <a href=
"../../../php/api/events/" class=
"md-nav__link">
335 <li class=
"md-nav__item md-nav__item--nested">
338 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
340 <label class=
"md-nav__link" for=
"__nav_2_5_5">
342 <span class=
"md-nav__icon md-icon"></span>
344 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
345 <label class=
"md-nav__title" for=
"__nav_2_5_5">
346 <span class=
"md-nav__icon md-icon"></span>
349 <ul class=
"md-nav__list" data-md-scrollfix
>
355 <li class=
"md-nav__item">
356 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
367 <li class=
"md-nav__item">
368 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
379 <li class=
"md-nav__item">
380 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
391 <li class=
"md-nav__item">
392 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
403 <li class=
"md-nav__item">
404 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
421 <li class=
"md-nav__item">
422 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
423 Package Installation Plugins
433 <li class=
"md-nav__item">
434 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
445 <li class=
"md-nav__item">
446 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
457 <li class=
"md-nav__item">
458 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
475 <li class=
"md-nav__item">
476 <a href=
"../../../php/code-style/" class=
"md-nav__link">
487 <li class=
"md-nav__item">
488 <a href=
"../../../php/apps/" class=
"md-nav__link">
499 <li class=
"md-nav__item">
500 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
521 <li class=
"md-nav__item md-nav__item--nested">
524 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
526 <label class=
"md-nav__link" for=
"__nav_3">
527 Languages, Templates & CSS
528 <span class=
"md-nav__icon md-icon"></span>
530 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
531 <label class=
"md-nav__title" for=
"__nav_3">
532 <span class=
"md-nav__icon md-icon"></span>
533 Languages, Templates & CSS
535 <ul class=
"md-nav__list" data-md-scrollfix
>
541 <li class=
"md-nav__item">
542 <a href=
"../../../view/languages/" class=
"md-nav__link">
553 <li class=
"md-nav__item">
554 <a href=
"../../../view/templates/" class=
"md-nav__link">
565 <li class=
"md-nav__item">
566 <a href=
"../../../view/css/" class=
"md-nav__link">
587 <li class=
"md-nav__item md-nav__item--nested">
590 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
592 <label class=
"md-nav__link" for=
"__nav_4">
594 <span class=
"md-nav__icon md-icon"></span>
596 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
597 <label class=
"md-nav__title" for=
"__nav_4">
598 <span class=
"md-nav__icon md-icon"></span>
601 <ul class=
"md-nav__list" data-md-scrollfix
>
607 <li class=
"md-nav__item">
608 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
620 <li class=
"md-nav__item md-nav__item--nested">
623 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
625 <label class=
"md-nav__link" for=
"__nav_4_2">
627 <span class=
"md-nav__icon md-icon"></span>
629 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
630 <label class=
"md-nav__title" for=
"__nav_4_2">
631 <span class=
"md-nav__icon md-icon"></span>
634 <ul class=
"md-nav__list" data-md-scrollfix
>
640 <li class=
"md-nav__item">
641 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
652 <li class=
"md-nav__item">
653 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
664 <li class=
"md-nav__item">
665 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
676 <li class=
"md-nav__item">
677 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
688 <li class=
"md-nav__item">
689 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
700 <li class=
"md-nav__item">
701 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
712 <li class=
"md-nav__item">
713 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
724 <li class=
"md-nav__item">
725 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
726 Browser and Screen Sizes
736 <li class=
"md-nav__item">
737 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
754 <li class=
"md-nav__item">
755 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
766 <li class=
"md-nav__item">
767 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
778 <li class=
"md-nav__item">
779 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
802 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
805 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" checked
>
807 <label class=
"md-nav__link" for=
"__nav_5">
809 <span class=
"md-nav__icon md-icon"></span>
811 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
812 <label class=
"md-nav__title" for=
"__nav_5">
813 <span class=
"md-nav__icon md-icon"></span>
816 <ul class=
"md-nav__list" data-md-scrollfix
>
822 <li class=
"md-nav__item">
823 <a href=
"../../package-xml/" class=
"md-nav__link">
837 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
840 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" checked
>
842 <label class=
"md-nav__link" for=
"__nav_5_2">
844 <span class=
"md-nav__icon md-icon"></span>
846 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
847 <label class=
"md-nav__title" for=
"__nav_5_2">
848 <span class=
"md-nav__icon md-icon"></span>
851 <ul class=
"md-nav__list" data-md-scrollfix
>
857 <li class=
"md-nav__item">
858 <a href=
"../" class=
"md-nav__link">
869 <li class=
"md-nav__item">
870 <a href=
"../acl-option/" class=
"md-nav__link">
881 <li class=
"md-nav__item">
882 <a href=
"../acp-menu/" class=
"md-nav__link">
893 <li class=
"md-nav__item">
894 <a href=
"../acp-search-provider/" class=
"md-nav__link">
905 <li class=
"md-nav__item">
906 <a href=
"../acp-template/" class=
"md-nav__link">
917 <li class=
"md-nav__item">
918 <a href=
"../bbcode/" class=
"md-nav__link">
929 <li class=
"md-nav__item">
930 <a href=
"../box/" class=
"md-nav__link">
941 <li class=
"md-nav__item">
942 <a href=
"../clipboard-action/" class=
"md-nav__link">
953 <li class=
"md-nav__item">
954 <a href=
"../core-object/" class=
"md-nav__link">
965 <li class=
"md-nav__item">
966 <a href=
"../cronjob/" class=
"md-nav__link">
977 <li class=
"md-nav__item">
978 <a href=
"../event-listener/" class=
"md-nav__link">
989 <li class=
"md-nav__item">
990 <a href=
"../file/" class=
"md-nav__link">
1001 <li class=
"md-nav__item">
1002 <a href=
"../language/" class=
"md-nav__link">
1013 <li class=
"md-nav__item">
1014 <a href=
"../media-provider/" class=
"md-nav__link">
1025 <li class=
"md-nav__item">
1026 <a href=
"../menu/" class=
"md-nav__link">
1037 <li class=
"md-nav__item">
1038 <a href=
"../menu-item/" class=
"md-nav__link">
1049 <li class=
"md-nav__item">
1050 <a href=
"../object-type/" class=
"md-nav__link">
1061 <li class=
"md-nav__item">
1062 <a href=
"../object-type-definition/" class=
"md-nav__link">
1063 objectTypeDefinition
1073 <li class=
"md-nav__item">
1074 <a href=
"../option/" class=
"md-nav__link">
1085 <li class=
"md-nav__item">
1086 <a href=
"../page/" class=
"md-nav__link">
1097 <li class=
"md-nav__item">
1098 <a href=
"../pip/" class=
"md-nav__link">
1109 <li class=
"md-nav__item">
1110 <a href=
"../script/" class=
"md-nav__link">
1121 <li class=
"md-nav__item">
1122 <a href=
"../smiley/" class=
"md-nav__link">
1133 <li class=
"md-nav__item">
1134 <a href=
"../sql/" class=
"md-nav__link">
1145 <li class=
"md-nav__item">
1146 <a href=
"../style/" class=
"md-nav__link">
1157 <li class=
"md-nav__item">
1158 <a href=
"../template/" class=
"md-nav__link">
1169 <li class=
"md-nav__item">
1170 <a href=
"../template-listener/" class=
"md-nav__link">
1181 <li class=
"md-nav__item">
1182 <a href=
"../user-group-option/" class=
"md-nav__link">
1193 <li class=
"md-nav__item">
1194 <a href=
"../user-menu/" class=
"md-nav__link">
1207 <li class=
"md-nav__item md-nav__item--active">
1209 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1214 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1215 userNotificationEvent
1216 <span class=
"md-nav__icon md-icon"></span>
1219 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1220 userNotificationEvent
1224 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1230 <label class=
"md-nav__title" for=
"__toc">
1231 <span class=
"md-nav__icon md-icon"></span>
1234 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1236 <li class=
"md-nav__item">
1237 <a href=
"#components" class=
"md-nav__link">
1241 <nav class=
"md-nav" aria-label=
"Components">
1242 <ul class=
"md-nav__list">
1244 <li class=
"md-nav__item">
1245 <a href=
"#objecttype" class=
"md-nav__link">
1251 <li class=
"md-nav__item">
1252 <a href=
"#classname" class=
"md-nav__link">
1258 <li class=
"md-nav__item">
1259 <a href=
"#preset" class=
"md-nav__link">
1265 <li class=
"md-nav__item">
1266 <a href=
"#presetmailnotificationtype" class=
"md-nav__link">
1267 <presetmailnotificationtype
>
1272 <li class=
"md-nav__item">
1273 <a href=
"#options" class=
"md-nav__link">
1279 <li class=
"md-nav__item">
1280 <a href=
"#permissions" class=
"md-nav__link">
1291 <li class=
"md-nav__item">
1292 <a href=
"#example" class=
"md-nav__link">
1310 <li class=
"md-nav__item">
1311 <a href=
"../user-option/" class=
"md-nav__link">
1322 <li class=
"md-nav__item">
1323 <a href=
"../user-profile-menu/" class=
"md-nav__link">
1340 <li class=
"md-nav__item">
1341 <a href=
"../../database-php-api/" class=
"md-nav__link">
1362 <li class=
"md-nav__item md-nav__item--nested">
1365 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1367 <label class=
"md-nav__link" for=
"__nav_6">
1369 <span class=
"md-nav__icon md-icon"></span>
1371 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1372 <label class=
"md-nav__title" for=
"__nav_6">
1373 <span class=
"md-nav__icon md-icon"></span>
1376 <ul class=
"md-nav__list" data-md-scrollfix
>
1383 <li class=
"md-nav__item md-nav__item--nested">
1386 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1388 <label class=
"md-nav__link" for=
"__nav_6_1">
1389 Migrating from WSC
5.3
1390 <span class=
"md-nav__icon md-icon"></span>
1392 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1393 <label class=
"md-nav__title" for=
"__nav_6_1">
1394 <span class=
"md-nav__icon md-icon"></span>
1395 Migrating from WSC
5.3
1397 <ul class=
"md-nav__list" data-md-scrollfix
>
1403 <li class=
"md-nav__item">
1404 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1415 <li class=
"md-nav__item">
1416 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1417 Session Handling and Authentication
1427 <li class=
"md-nav__item">
1428 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1439 <li class=
"md-nav__item">
1440 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1451 <li class=
"md-nav__item">
1452 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1453 Third Party Libraries
1470 <li class=
"md-nav__item md-nav__item--nested">
1473 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1475 <label class=
"md-nav__link" for=
"__nav_6_2">
1476 Migrating from WSC
5.2
1477 <span class=
"md-nav__icon md-icon"></span>
1479 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1480 <label class=
"md-nav__title" for=
"__nav_6_2">
1481 <span class=
"md-nav__icon md-icon"></span>
1482 Migrating from WSC
5.2
1484 <ul class=
"md-nav__list" data-md-scrollfix
>
1490 <li class=
"md-nav__item">
1491 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1502 <li class=
"md-nav__item">
1503 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1504 Templates and Languages
1514 <li class=
"md-nav__item">
1515 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1516 Third Party Libraries
1533 <li class=
"md-nav__item md-nav__item--nested">
1536 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1538 <label class=
"md-nav__link" for=
"__nav_6_3">
1539 Migrating from WSC
3.1
1540 <span class=
"md-nav__icon md-icon"></span>
1542 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1543 <label class=
"md-nav__title" for=
"__nav_6_3">
1544 <span class=
"md-nav__icon md-icon"></span>
1545 Migrating from WSC
3.1
1547 <ul class=
"md-nav__list" data-md-scrollfix
>
1553 <li class=
"md-nav__item">
1554 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1572 <li class=
"md-nav__item md-nav__item--nested">
1575 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1577 <label class=
"md-nav__link" for=
"__nav_6_4">
1578 Migrating from WSC
3.0
1579 <span class=
"md-nav__icon md-icon"></span>
1581 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1582 <label class=
"md-nav__title" for=
"__nav_6_4">
1583 <span class=
"md-nav__icon md-icon"></span>
1584 Migrating from WSC
3.0
1586 <ul class=
"md-nav__list" data-md-scrollfix
>
1592 <li class=
"md-nav__item">
1593 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1604 <li class=
"md-nav__item">
1605 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1616 <li class=
"md-nav__item">
1617 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1628 <li class=
"md-nav__item">
1629 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1640 <li class=
"md-nav__item">
1641 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1659 <li class=
"md-nav__item md-nav__item--nested">
1662 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1664 <label class=
"md-nav__link" for=
"__nav_6_5">
1665 Migrating from WCF
2.1
1666 <span class=
"md-nav__icon md-icon"></span>
1668 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1669 <label class=
"md-nav__title" for=
"__nav_6_5">
1670 <span class=
"md-nav__icon md-icon"></span>
1671 Migrating from WCF
2.1
1673 <ul class=
"md-nav__list" data-md-scrollfix
>
1679 <li class=
"md-nav__item">
1680 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1691 <li class=
"md-nav__item">
1692 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1703 <li class=
"md-nav__item">
1704 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1715 <li class=
"md-nav__item">
1716 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1743 <li class=
"md-nav__item md-nav__item--nested">
1746 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1748 <label class=
"md-nav__link" for=
"__nav_7">
1750 <span class=
"md-nav__icon md-icon"></span>
1752 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1753 <label class=
"md-nav__title" for=
"__nav_7">
1754 <span class=
"md-nav__icon md-icon"></span>
1757 <ul class=
"md-nav__list" data-md-scrollfix
>
1764 <li class=
"md-nav__item md-nav__item--nested">
1767 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1769 <label class=
"md-nav__link" for=
"__nav_7_1">
1771 <span class=
"md-nav__icon md-icon"></span>
1773 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1774 <label class=
"md-nav__title" for=
"__nav_7_1">
1775 <span class=
"md-nav__icon md-icon"></span>
1778 <ul class=
"md-nav__list" data-md-scrollfix
>
1784 <li class=
"md-nav__item">
1785 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1796 <li class=
"md-nav__item">
1797 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1808 <li class=
"md-nav__item">
1809 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1820 <li class=
"md-nav__item">
1821 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1848 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1849 <div class=
"md-sidebar__scrollwrap">
1850 <div class=
"md-sidebar__inner">
1852 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1858 <label class=
"md-nav__title" for=
"__toc">
1859 <span class=
"md-nav__icon md-icon"></span>
1862 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1864 <li class=
"md-nav__item">
1865 <a href=
"#components" class=
"md-nav__link">
1869 <nav class=
"md-nav" aria-label=
"Components">
1870 <ul class=
"md-nav__list">
1872 <li class=
"md-nav__item">
1873 <a href=
"#objecttype" class=
"md-nav__link">
1879 <li class=
"md-nav__item">
1880 <a href=
"#classname" class=
"md-nav__link">
1886 <li class=
"md-nav__item">
1887 <a href=
"#preset" class=
"md-nav__link">
1893 <li class=
"md-nav__item">
1894 <a href=
"#presetmailnotificationtype" class=
"md-nav__link">
1895 <presetmailnotificationtype
>
1900 <li class=
"md-nav__item">
1901 <a href=
"#options" class=
"md-nav__link">
1907 <li class=
"md-nav__item">
1908 <a href=
"#permissions" class=
"md-nav__link">
1919 <li class=
"md-nav__item">
1920 <a href=
"#example" class=
"md-nav__link">
1934 <div class=
"md-content" data-md-component=
"content">
1935 <article class=
"md-content__inner md-typeset">
1939 <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>
1940 <p>Registers new user notification events.
</p>
1941 <h2 id=
"components">Components
<a class=
"headerlink" href=
"#components" title=
"Permanent link">#
</a></h2>
1942 <p>Each package installation plugin is described as an
<code><event
></code> element with the mandatory child
<code><name
></code>.
</p>
1943 <h3 id=
"objecttype"><code><objectType
></code><a class=
"headerlink" href=
"#objecttype" title=
"Permanent link">#
</a></h3>
1944 <div class=
"admonition warning">
1945 <p class=
"admonition-title">The
<code>(name, objectType)
</code> pair must be unique.
</p>
1947 <p>The given object type must implement the
<code>com.woltlab.wcf.notification.objectType
</code> definition.
</p>
1948 <h3 id=
"classname"><code><classname
></code><a class=
"headerlink" href=
"#classname" title=
"Permanent link">#
</a></h3>
1949 <p>The name of the class providing the event's behaviour,
1950 the class has to implement the
<code>wcf\system\user\notification\event\IUserNotificationEvent
</code> interface.
</p>
1951 <h3 id=
"preset"><code><preset
></code><a class=
"headerlink" href=
"#preset" title=
"Permanent link">#
</a></h3>
1952 <p>Defines whether this event is enabled by default.
</p>
1953 <h3 id=
"presetmailnotificationtype"><code><presetmailnotificationtype
></code><a class=
"headerlink" href=
"#presetmailnotificationtype" title=
"Permanent link">#
</a></h3>
1954 <div class=
"admonition info">
1955 <p class=
"admonition-title">Avoid using this option, as sending unsolicited mail can be seen as spamming.
</p>
1957 <p>One of
<code>instant
</code> or
<code>daily
</code>.
1958 Defines whether this type of email notifications is enabled by default.
</p>
1959 <h3 id=
"options"><code><options
></code><a class=
"headerlink" href=
"#options" title=
"Permanent link">#
</a></h3>
1960 <p><span class=
"label label-info">Optional
</span></p>
1961 <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>
1962 <h3 id=
"permissions"><code><permissions
></code><a class=
"headerlink" href=
"#permissions" title=
"Permanent link">#
</a></h3>
1963 <p><span class=
"label label-info">Optional
</span></p>
1964 <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>
1965 <h2 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h2>
1966 <div class=
"highlight"><pre><span></span><code><span class=
"cp"><?xml version=
"1.0" encoding=
"UTF-
8"?
></span>
1967 <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>
1968 <span class=
"nt"><import
></span>
1969 <span class=
"nt"><event
></span>
1970 <span class=
"nt"><name
></span>like
<span class=
"nt"></name
></span>
1971 <span class=
"nt"><objecttype
></span>com.woltlab.example.comment.like.notification
<span class=
"nt"></objecttype
></span>
1972 <span class=
"nt"><classname
></span>wcf\system\user\notification\event\ExampleCommentLikeUserNotificationEvent
<span class=
"nt"></classname
></span>
1973 <span class=
"nt"><preset
></span>1<span class=
"nt"></preset
></span>
1974 <span class=
"nt"><options
></span>module_like
<span class=
"nt"></options
></span>
1975 <span class=
"nt"></event
></span>
1976 <span class=
"nt"></import
></span>
1977 <span class=
"nt"></data
></span>
1992 <footer class=
"md-footer">
1994 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
1996 <a href=
"../user-menu/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
1997 <div class=
"md-footer__button md-icon">
1998 <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>
2000 <div class=
"md-footer__title">
2001 <div class=
"md-ellipsis">
2002 <span class=
"md-footer__direction">
2011 <a href=
"../user-option/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2012 <div class=
"md-footer__title">
2013 <div class=
"md-ellipsis">
2014 <span class=
"md-footer__direction">
2020 <div class=
"md-footer__button md-icon">
2021 <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>
2027 <div class=
"md-footer-meta md-typeset">
2028 <div class=
"md-footer-meta__inner md-grid">
2029 <div class=
"md-footer-copyright">
2031 <div class=
"md-footer-copyright__highlight">
2032 Copyright ©
2020 WoltLab GmbH
2036 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2041 <div class=
"md-footer-copyright">
2042 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2043 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2050 <div class=
"md-dialog" data-md-component=
"dialog">
2051 <div class=
"md-dialog__inner md-typeset"></div>
2053 <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>
2056 <script src=
"../../../assets/javascripts/bundle.5cf3e710.min.js"></script>