Function __global->cns_prepare_welcome_email

Definitions

sources/cns_welcome_emails.php

  • Generate what we need to send/preview a welcome e-mail.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$mail array No No required parameter N/A N/A Welcome-email row
$member ?array No No Null N/A N/A Member/subscriber row (null: generating a preview: current member/subscriber based around such)

Returns

  • A tuple: subject, message, message is-HTML, recipient name
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Generate what we need to send/preview a welcome e-mail.
 *
 * @param  array $mail Welcome-email row
 * @param  ?array $member Member/subscriber row (null: generating a preview: current member/subscriber based around such)
 * @return array A tuple: subject, message, message is-HTML, recipient name
 */
function cns_prepare_welcome_email(array $mail, ?array $member = null) : array