Function Notification_dispatcher->dispatch_notification_to_member
Definitions
sources/notifications.php
- Send out a notification to a member.
- Visibility: private
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: bool
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $to_member_id | MEMBER | required parameter | N/A | N/A | Member to send to |
| $setting | integer | required parameter | N/A | N/A | Listening setting |
| $notification_code | ID_TEXT | required parameter | N/A | N/A | The notification code to use |
| $code_category | ?SHORT_TEXT | required parameter | N/A | N/A | The category within the notification code (null: none) |
| $subject | SHORT_TEXT | required parameter | N/A | N/A | Message subject (in Comcode) |
| $message | LONG_TEXT | required parameter | N/A | N/A | Message body (in Comcode) |
| $from_member_id | integer | required parameter | N/A | N/A | The member ID doing the sending. Either a MEMBER or a negative number (e.g. A_FROM_SYSTEM_UNPRIVILEGED) |
| $priority | integer | required parameter | N/A | N/A | The message priority (1=urgent, 3=normal, 5=low) |
| $no_cc | boolean | required parameter | N/A | N/A | Whether to NOT CC to the CC address (may be set to true and returned by reference once a single e-mail has been sent) |
| $attachments | array | required parameter | N/A | N/A | A list of attachments (each attachment being a map, path=>filename) |
| $use_real_from | boolean | required parameter | N/A | N/A | Whether we will make a "reply to" direct -- we only do this if we're allowed to disclose e-mail addresses for this particular notification type (i.e. if it's a direct contact) |
Return
- Whether a notification was sent
- Type: boolean
- Set: N/A
- Range: N/A