Function __global->cns_edit_welcome_email
Definitions
sources/cns_general_action2.php
- Edit a Welcome E-mail.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $id | AUTO_LINK | No | No | required parameter | N/A | N/A | The ID |
| $name | SHORT_TEXT | No | No | required parameter | N/A | N/A | A name for the Welcome E-mail |
| $subject | SHORT_TEXT | No | No | required parameter | N/A | N/A | The subject of the Welcome E-mail |
| $text | LONG_TEXT | No | No | required parameter | N/A | N/A | The message body of the Welcome E-mail |
| $send_after_hours | integer | No | No | required parameter | N/A | N/A | The number of hours before sending the e-mail |
| $newsletter | ?AUTO_LINK | No | No | required parameter | N/A | N/A | What newsletter to send out to instead of members (null: none) |
| $usergroup | ?AUTO_LINK | No | No | required parameter | N/A | N/A | The usergroup to tie to (null: none) |
| $usergroup_type | ID_TEXT | No | No | required parameter | primary secondary | N/A | How to send regarding usergroups (blank: indiscriminately) |
Preview
Code (PHP)
/**
* Edit a Welcome E-mail.
*
* @param AUTO_LINK $id The ID
* @param SHORT_TEXT $name A name for the Welcome E-mail
* @param SHORT_TEXT $subject The subject of the Welcome E-mail
* @param LONG_TEXT $text The message body of the Welcome E-mail
* @param integer $send_after_hours The number of hours before sending the e-mail
* @param ?AUTO_LINK $newsletter What newsletter to send out to instead of members (null: none)
* @param ?AUTO_LINK $usergroup The usergroup to tie to (null: none)
* @param ID_TEXT $usergroup_type How to send regarding usergroups (blank: indiscriminately)
* @set primary secondary
*/
function cns_edit_welcome_email(int $id, string $name, string $subject, string $text, int $send_after_hours, ?int $newsletter, ?int $usergroup, string $usergroup_type)
* Edit a Welcome E-mail.
*
* @param AUTO_LINK $id The ID
* @param SHORT_TEXT $name A name for the Welcome E-mail
* @param SHORT_TEXT $subject The subject of the Welcome E-mail
* @param LONG_TEXT $text The message body of the Welcome E-mail
* @param integer $send_after_hours The number of hours before sending the e-mail
* @param ?AUTO_LINK $newsletter What newsletter to send out to instead of members (null: none)
* @param ?AUTO_LINK $usergroup The usergroup to tie to (null: none)
* @param ID_TEXT $usergroup_type How to send regarding usergroups (blank: indiscriminately)
* @set primary secondary
*/
function cns_edit_welcome_email(int $id, string $name, string $subject, string $text, int $send_after_hours, ?int $newsletter, ?int $usergroup, string $usergroup_type)
