\MemberConfirmationEmail
An email sent to the user with a link to validate and activate their account.
Synopsis
class MemberConfirmationEmail
extends Email
{
- // constants
- const DEFAULT_SUBJECT = '$SiteName Member Activation';
- const DEFAULT_TEMPLATE = ' <p> Dear $Member.Email, </p> <p> Thank you for registering at $SiteName! In order to use your account you must first confirm your email address by clicking on the link below. Until you do this you will not be able to log in. </p> <h3>Account Confirmation</h3> <p> Please <a href="$ConfirmLink">confirm your email</a>, or copy and paste the following URL into your browser to confirm this is your real email address: </p> <pre>$ConfirmLink</pre> <p> If you were not the person who signed up using this email address, please ignore this email. The user account will not become active. </p> <h3>Log-In Details</h3> <p> Once your account has been activated you will automatically be logged in. You can also log in <a href="$LoginLink">here</a>. If you have lost your password you can generate a new one on the <a href="$LostPasswordLink">lost password</a> page. </p> ';
- const TEMPLATE_NOTE = ' <p> The following special variables will be replaced in the email template and subject line: </p> <ul> <li>$SiteName: The name of the site from the default site configuration.</li> <li>$ConfirmLink: The link to confirm the user account.</li> <li>$LoginLink: The link to log in with.</li> <li>$LostPasswordLink: A link to the forgot password page.</li> <li> $Member.(Field): Various fields to do with the registered member. The available fields are Name, FirstName, Surname, Email, and Created. </li> </ul> ';
- // methods
- public static string get_parsed_string()
- public void __construct()
Hierarchy
Extends
Constants
Name | Value |
---|---|
DEFAULT_SUBJECT | '$SiteName Member Activation' |
DEFAULT_TEMPLATE | ' <p> Dear $Member.Email, </p> <p> Thank you for registering at $SiteName! In order to use your account you must first confirm your email address by clicking on the link below. Until you do this you will not be able to log in. </p> <h3>Account Confirmation</h3> <p> Please <a href="$ConfirmLink">confirm your email</a>, or copy and paste the following URL into your browser to confirm this is your real email address: </p> <pre>$ConfirmLink</pre> <p> If you were not the person who signed up using this email address, please ignore this email. The user account will not become active. </p> <h3>Log-In Details</h3> <p> Once your account has been activated you will automatically be logged in. You can also log in <a href="$LoginLink">here</a>. If you have lost your password you can generate a new one on the <a href="$LostPasswordLink">lost password</a> page. </p> ' |
TEMPLATE_NOTE | ' <p> The following special variables will be replaced in the email template and subject line: </p> <ul> <li>$SiteName: The name of the site from the default site configuration.</li> <li>$ConfirmLink: The link to confirm the user account.</li> <li>$LoginLink: The link to log in with.</li> <li>$LostPasswordLink: A link to the forgot password page.</li> <li> $Member.(Field): Various fields to do with the registered member. The available fields are Name, FirstName, Surname, Email, and Created. </li> </ul> ' |
Methods
public
- __construct()
- get_parsed_string() — Replaces variables inside an email template according to {@link TEMPLATE_NOTE}.