Scriptlog Docs

Scriptlog Documentation

Code reference for the Scriptlog codebase

User Tools

Site Tools

You are here: start » scriptlog » lib » service » notificationservice
Trace: • searchfinder
scriptlog:lib:service:notificationservice

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
scriptlog:lib:service:notificationservice [2026/09/26 09:09] – admin adminscriptlog:lib:service:notificationservice [2026/09/26 09:34] (current) – admin admin
Line 15: Line 15:
 ======= Docblock Metadata ======= ======= Docblock Metadata =======
  
-  ^ Tag ^ Value ^ +^ Tag ^ Value ^ 
-  | ''@category'' | Service Class | +| ''@category'' | Service Class | 
-  | ''@author'' | Scriptlog | +| ''@author'' | Scriptlog | 
-  | ''@license'' | MIT | +| ''@license'' | MIT | 
-  | ''@version'' | 1.0 | +| ''@version'' | 1.0 | 
-  | ''@since'' | Since Release 1.0 |+| ''@since'' | Since Release 1.0 |
  
 ======= Inheritance ======= ======= Inheritance =======
Line 30: Line 30:
 //None.// //None.//
  
-======= Properties (0) =======+======= Properties (4) =======
  
-//None declared.//+^ Visibility ^ Type ^ Name ^ Default ^ Line ^ 
 +| ''private'' | ''(untyped)'' | ''$dsn'' |  | 27 | 
 +| ''private'' | ''(untyped)'' | ''$fromEmail'' |  | 33 | 
 +| ''private'' | ''(untyped)'' | ''$fromName'' |  | 39 | 
 +| ''private'' | ''(untyped)'' | ''$configService'' |  | 45 |
  
 ======= Methods (11) ======= ======= Methods (11) =======
  
-  ^ Visibility ^ Method ^ Summary ^ Line ^ +^ Visibility ^ Method ^ Summary ^ Line ^ 
-  | public | ''__construct()'' | Constructor | 52 | +| public | ''__construct()'' | Constructor | 52 | 
-  | private | ''loadConfiguration()'' | Load mail configuration | 63 | +| private | ''loadConfiguration()'' | Load mail configuration | 63 | 
-  | public | ''send()'' | Send email notification | 137 | +| public | ''send()'' | Send email notification | 137 | 
-  | protected | ''getMailer()'' | Get Mailer instance | 166 | +| protected | ''getMailer()'' | Get Mailer instance | 166 | 
-  | protected | ''createEmail()'' | Create Email instance | 181 | +| protected | ''createEmail()'' | Create Email instance | 181 | 
-  | private | ''applyEmailOptions()'' | Apply additional options to email | 201 | +| private | ''applyEmailOptions()'' | Apply additional options to email | 201 | 
-  | public | ''sendDataRequestConfirmation()'' | Send GDPR data request confirmation email to user | 228 | +| public | ''sendDataRequestConfirmation()'' | Send GDPR data request confirmation email to user | 228 | 
-  | public | ''sendAdminNotification()'' | Send notification to admin about new data request | 278 | +| public | ''sendAdminNotification()'' | Send notification to admin about new data request | 278 | 
-  | public | ''sendRequestCompleted()'' | Send data request completion email | 325 | +| public | ''sendRequestCompleted()'' | Send data request completion email | 325 | 
-  | public | ''sendProfileDeletionConfirmation()'' | Send profile deletion confirmation | 369 | +| public | ''sendProfileDeletionConfirmation()'' | Send profile deletion confirmation | 369 | 
-  | public | ''getSmtpConfig()'' | Get SMTP configuration (for admin settings page) | 409 |+| public | ''getSmtpConfig()'' | Get SMTP configuration (for admin settings page) | 409 |
  
  
Line 62: Line 66:
 Load SMTP configuration from database or config.php Load SMTP configuration from database or config.php
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$configService'' | [[scriptlog:lib:service:configurationservice|''?ConfigurationService'']] | ''null'' | //none// |+|  ''$configService'' |  [[scriptlog:lib:service:configurationservice|''?ConfigurationService'']] |  ''null'' |  //none// |
  
  
Line 91: Line 95:
 Send email notification Send email notification
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$to'' | ''(untyped)'' | //required// | Email address to send to | +|  ''$to'' |  ''(untyped)'' |  //required// |  Email address to send to | 
-  | ''$subject'' | ''(untyped)'' | //required// | Email subject | +|  ''$subject'' |  ''(untyped)'' |  //required// |  Email subject | 
-  | ''$body'' | ''(untyped)'' | //required// | Email body (HTML or plain text) | +|  ''$body'' |  ''(untyped)'' |  //required// |  Email body (HTML or plain text) | 
-  | ''$options'' | ''(untyped)'' | ''[]'' | Additional options |+|  ''$options'' |  ''(untyped)'' |  ''[]'' |  Additional options |
  
 **Returns:** ''(none declared)'' — bool **Returns:** ''(none declared)'' — bool
Line 127: Line 131:
 Create Email instance Create Email instance
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$to'' | ''(untyped)'' | //required// | //none// | +|  ''$to'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$subject'' | ''(untyped)'' | //required// | //none// | +|  ''$subject'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$body'' | ''(untyped)'' | //required// | //none// | +|  ''$body'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$isHtml'' | ''(untyped)'' | ''true'' | //none// |+|  ''$isHtml'' |  ''(untyped)'' |  ''true'' |  //none// |
  
 **Returns:** ''(none declared)'' — \Symfony\Component\Mime\Email **Returns:** ''(none declared)'' — \Symfony\Component\Mime\Email
Line 146: Line 150:
 Apply additional options to email Apply additional options to email
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$email'' | ''(untyped)'' | //required// | //none// | +|  ''$email'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$Cc'' | ''(untyped)'' | //required// | //none// | +|  ''$Cc'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$Bcc'' | ''(untyped)'' | //required// | //none// | +|  ''$Bcc'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$replyTo'' | ''(untyped)'' | //required// | //none// |+|  ''$replyTo'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 165: Line 169:
 Send GDPR data request confirmation email to user Send GDPR data request confirmation email to user
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$email'' | ''(untyped)'' | //required// | User's email address | +|  ''$email'' |  ''(untyped)'' |  //required// |  User's email address | 
-  | ''$requestType'' | ''(untyped)'' | //required// | Type of request (export/deletion) | +|  ''$requestType'' |  ''(untyped)'' |  //required// |  Type of request (export/deletion) | 
-  | ''$requestId'' | ''(untyped)'' | //required// | Request ID |+|  ''$requestId'' |  ''(untyped)'' |  //required// |  Request ID |
  
 **Returns:** ''(none declared)'' — bool **Returns:** ''(none declared)'' — bool
Line 183: Line 187:
 Send notification to admin about new data request Send notification to admin about new data request
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$adminEmail'' | ''(untyped)'' | //required// | Admin email address | +|  ''$adminEmail'' |  ''(untyped)'' |  //required// |  Admin email address | 
-  | ''$userEmail'' | ''(untyped)'' | //required// | User's email address | +|  ''$userEmail'' |  ''(untyped)'' |  //required// |  User's email address | 
-  | ''$requestType'' | ''(untyped)'' | //required// | Type of request | +|  ''$requestType'' |  ''(untyped)'' |  //required// |  Type of request | 
-  | ''$requestId'' | ''(untyped)'' | //required// | Request ID |+|  ''$requestId'' |  ''(untyped)'' |  //required// |  Request ID |
  
 **Returns:** ''(none declared)'' — bool **Returns:** ''(none declared)'' — bool
Line 202: Line 206:
 Send data request completion email Send data request completion email
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$email'' | ''(untyped)'' | //required// | User's email address | +|  ''$email'' |  ''(untyped)'' |  //required// |  User's email address | 
-  | ''$requestType'' | ''(untyped)'' | //required// | Type of request |+|  ''$requestType'' |  ''(untyped)'' |  //required// |  Type of request |
  
 **Returns:** ''(none declared)'' — bool **Returns:** ''(none declared)'' — bool
Line 219: Line 223:
 Send profile deletion confirmation Send profile deletion confirmation
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$email'' | ''(untyped)'' | //required// | User's email address |+|  ''$email'' |  ''(untyped)'' |  //required// |  User's email address |
  
 **Returns:** ''(none declared)'' — bool **Returns:** ''(none declared)'' — bool
scriptlog/lib/service/notificationservice.1790413760.txt.gz · Last modified: by admin