Function __global->cns_make_welcome_email

Definitions

sources/cns_general_action.php

  • Make a Welcome E-mail.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: int

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$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 Null N/A N/A What newsletter to send out to instead of members (null: none)
$usergroup ?AUTO_LINK No No Null N/A N/A The usergroup to tie to (null: none)
$usergroup_type ID_TEXT No No Blank (empty string) primary secondary "" N/A How to send regarding usergroups (blank: indiscriminately)

Returns

  • The ID
  • Type: AUTO_LINK
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Make a Welcome E-mail.
 *
 * @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 ""
 * @return AUTO_LINK The ID
 */
function cns_make_welcome_email(string $name, string $subject, string $text, int $send_after_hours, ?int $newsletter = null, ?int $usergroup = null, string $usergroup_type = '') : int