Function Module_newsletter->_send_confirmation
Definitions
site/pages/modules/newsletter.php
- Send a newsletter join confirmation.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| SHORT_TEXT | No | No | required parameter | N/A | N/A | The e-mail address | |
| $code_confirm | integer | No | No | required parameter | N/A | N/A | The confirmation code |
| $password | ?SHORT_TEXT | No | No | required parameter | N/A | N/A | The newsletter password (null: password may not be viewed, because it's been permanently hashed already) |
| $forename | string | No | No | required parameter | N/A | N/A | Subscribers forename |
| $surname | string | No | No | required parameter | N/A | N/A | Subscribers surname |
Preview
Code (PHP)
/**
* Send a newsletter join confirmation.
*
* @param SHORT_TEXT $email The e-mail address
* @param integer $code_confirm The confirmation code
* @param ?SHORT_TEXT $password The newsletter password (null: password may not be viewed, because it's been permanently hashed already)
* @param string $forename Subscribers forename
* @param string $surname Subscribers surname
*/
public function _send_confirmation(string $email, int $code_confirm, ?string $password, string $forename, string $surname)
* Send a newsletter join confirmation.
*
* @param SHORT_TEXT $email The e-mail address
* @param integer $code_confirm The confirmation code
* @param ?SHORT_TEXT $password The newsletter password (null: password may not be viewed, because it's been permanently hashed already)
* @param string $forename Subscribers forename
* @param string $surname Subscribers surname
*/
public function _send_confirmation(string $email, int $code_confirm, ?string $password, string $forename, string $surname)
