Email templates

From CashCrusaderWiki

(Difference between revisions)
Jump to: navigation, search
(Email templates)
Current revision (14:12, 30 August 2011) (edit) (undo)
(→Variables: for versions 2.25 and older)
 
(7 intermediate revisions not shown.)
Line 1: Line 1:
{{DISPLAYTITLE:Email Templates}}
{{DISPLAYTITLE:Email Templates}}
 +
'''This page only applies to CashCrusader versions 2.25 and older. For versions 2.26 and newer, you can access System Email Templates editor from Site Settings admin menu entry.'''
== Variables ==
== Variables ==
-
Email templates are customized from ''/scripts/conf.inc.php''. The templates for signup confirmation, signup details and email address change supports following variables. Variables are enclosed with < and > characters, like <SITE_NAME>:
+
Email templates are customized at ''/scripts/conf.inc.php''. The templates for signup confirmation, signup details and email address change supports following variables. Variables are enclosed with < and > characters, like <SITE_NAME>:
<!--box uid=b8c403c809bd3c190509beac423de9a1.0.P4bdc462718376-->
<!--box uid=b8c403c809bd3c190509beac423de9a1.0.P4bdc462718376-->
Line 60: Line 61:
|
|
Password of the account [password reset only]
Password of the account [password reset only]
 +
|-
 +
|
 +
POSITION
 +
|
 +
Contest ranking [contests only]
|-
|-
|
|
$_SESSION['username']
$_SESSION['username']
|
|
-
General variable for username of the account
+
General PHP variable for username of the account
|-class='sortbottom'
|-class='sortbottom'
Line 98: Line 104:
$confirm_info_subject
$confirm_info_subject
|
|
-
email confirmation subject during signup
+
email address confirmation subject during signup
|-
|-
|
|
$confirm_info_message
$confirm_info_message
|
|
-
email confirmation content during signup
+
email address confirmation content during signup
|-
|-
|
|
Line 113: Line 119:
$signup_info_message
$signup_info_message
|
|
-
signup details subject for new account
+
signup details content for new account
|-
|-
|
|
$verification_info_subject
$verification_info_subject
|
|
-
email address change subject for exiting accounts
+
email address change subject for existing accounts
|-
|-
|
|
$verification_info_message
$verification_info_message
|
|
-
email address change content for exiting accounts
+
email address change content for existing accounts
 +
|-
 +
|
 +
$notifications_new_referral_subject
 +
|
 +
subject for the new referral notification
 +
|-
 +
|
 +
$notifications_new_referral_message
 +
|
 +
message body for the new referral notification
-
|-class='sortbottom'
+
|-
 +
|
 +
$refcontest_winner_subject
 +
|
 +
referral contest winner notification subject
 +
|-
 +
|
 +
$refcontest_winner_message
 +
|
 +
referral contest winner notification body
 +
|- class='sortbottom'
|[{{SERVER}}{{SCRIPTPATH}}?title=Special:TableEdit&id=b8c403c809bd3c190509beac423de9a1.119.O4bdc4a4d9bf4d&page=119&pagename={{FULLPAGENAMEE}}&type=0&template= edit table] ||
|[{{SERVER}}{{SCRIPTPATH}}?title=Special:TableEdit&id=b8c403c809bd3c190509beac423de9a1.119.O4bdc4a4d9bf4d&page=119&pagename={{FULLPAGENAMEE}}&type=0&template= edit table] ||
|}
|}
<!--box uid=b8c403c809bd3c190509beac423de9a1.119.O4bdc4a4d9bf4d-->
<!--box uid=b8c403c809bd3c190509beac423de9a1.119.O4bdc4a4d9bf4d-->
-
Notice that support for email address verification email template customization was added to CashCrusader 2.20.
+
Notice that support for email address verification email template customization was added to CashCrusader 2.20 and referral notification to 2.22.
-
 
+
== Default templates ==
== Default templates ==
<pre>
<pre>
 +
 +
//---------------------------------
 +
// Account creation templates:
 +
//---------------------------------
$login_info_message="
$login_info_message="
Line 141: Line 170:
<PAGES_URL>
<PAGES_URL>
";
";
-
 
$confirm_info_subject="<SITE_NAME> signup URL";
$confirm_info_subject="<SITE_NAME> signup URL";
-
 
$confirm_info_message="
$confirm_info_message="
Line 158: Line 185:
$signup_info_subject="<SITE_NAME> Member Info";
$signup_info_subject="<SITE_NAME> Member Info";
-
 
$signup_info_message="
$signup_info_message="
Line 174: Line 200:
";
";
 +
//---------------------------------
 +
// Email address change templates:
 +
//---------------------------------
$verification_info_subject="Email address change for <SITE_NAME>";
$verification_info_subject="Email address change for <SITE_NAME>";
-
 
+
$verification_info_message="This information was submitted at <TIME> from IP/PROXY: <IPPROXY>. If you didn't submit your email at that time and that IP address isn't yours, then please send the email with headers to <SUPPORT_EMAIL> and disregard this email.
-
$verification_info_message="
+
-
This information was submitted at <TIME> from IP/PROXY: <IPPROXY>. If you didn't submit your email at that time and that IP address isn't yours, then please send the email with headers to <SUPPORT_EMAIL> and disregard this email.
+
This site operates on a double opt-in procedure which requires you to confirm email address before you receive any more emails. This will be the last email you will receive from <SITE_NAME> unless someone submits your email address once more. If this happens please contact <SUPPORT_EMAIL> with your email address and it can be blocked so you don't receive any in the future.
This site operates on a double opt-in procedure which requires you to confirm email address before you receive any more emails. This will be the last email you will receive from <SITE_NAME> unless someone submits your email address once more. If this happens please contact <SUPPORT_EMAIL> with your email address and it can be blocked so you don't receive any in the future.
Line 185: Line 212:
To complete your email address update please follow this url:
To complete your email address update please follow this url:
-
<PAGES_URL>userinfo.php?verification=<CODE>&email=<EMAIL>&username=$_SESSION[username]
+
<PAGES_URL>userinfo.php?verification=<CODE>&email=<EMAIL>&username=<USERNAME>
-
<a href=<PAGES_URL>userinfo.php?verification=<CODE>;&email=<EMAIL>&username=$_SESSION[username]>HTML Link</a>
+
<a href=<PAGES_URL>userinfo.php?verification=<CODE>;&email=<EMAIL>&username=<USERNAME>>HTML Link</a>
";
";
 +
 +
//---------------------------------
 +
// New referral templates:
 +
//---------------------------------
 +
 +
$notifications_new_referral_subject = "<SITE_NAME> :: You have a new referral!";
 +
 +
$notifications_new_referral_message = "Congratulations!
 +
 +
You have a new referral at <SITE_NAME>: <USERNAME>\n\n";
 +
 +
//---------------------------------
 +
// Referral contest templates:
 +
//---------------------------------
 +
 +
$refcontest_winner_subject = "<SITE_NAME> :: You were #<POSITION> in our referral contest!";
 +
 +
$refcontest_winner_message = "Congratulations <USERNAME>!
 +
 +
You were #<POSITION> in our referral contest with <REFERRALS> referrals! You won <REWARD>.
 +
 +
Please contact us if you have any questions regarding the prize.
 +
 +
--
 +
<SITE_NAME> Administration ";
 +
 +
-
</pre>>
+
</pre>
[[Category:Customize]]
[[Category:Customize]]

Current revision

This page only applies to CashCrusader versions 2.25 and older. For versions 2.26 and newer, you can access System Email Templates editor from Site Settings admin menu entry.

Variables

Email templates are customized at /scripts/conf.inc.php. The templates for signup confirmation, signup details and email address change supports following variables. Variables are enclosed with < and > characters, like <SITE_NAME>:

VariableDescription

SITE_NAME

Site's name

TIME

Current time

IPPROXY

IP or proxy IP of the visitor

SUPPORT_EMAIL

Site's support email address

PAGES_URL

Site's pages URL

CODE

Code to verify signup

EMAIL

Email address to signup from or change to

USERNAME

Username of the account [password reset only]

PASSWORD

Password of the account [password reset only]

POSITION

Contest ranking [contests only]

$_SESSION['username']

General PHP variable for username of the account

edit table


Templates are saved in following PHP variables:

VariableDescription

$login_info_subject

login details reset email subject

$login_info_message

login details reset email content

$confirm_info_subject

email address confirmation subject during signup

$confirm_info_message

email address confirmation content during signup

$signup_info_subject

signup details subject for new account

$signup_info_message

signup details content for new account

$verification_info_subject

email address change subject for existing accounts

$verification_info_message

email address change content for existing accounts

$notifications_new_referral_subject

subject for the new referral notification

$notifications_new_referral_message

message body for the new referral notification

$refcontest_winner_subject

referral contest winner notification subject

$refcontest_winner_message

referral contest winner notification body

edit table

Notice that support for email address verification email template customization was added to CashCrusader 2.20 and referral notification to 2.22.

Default templates 


//---------------------------------
// Account creation templates:
//---------------------------------

$login_info_message="
Your login username is <USERNAME>
Your new password is <PASSWORD>
<PAGES_URL>
";

$confirm_info_subject="<SITE_NAME> signup URL";

$confirm_info_message="
This information was submitted at <TIME> from IP/PROXY: <IPPROXY>. If you didn't submit your email at that time and that IP address isn't yours, then please send the email with headers to <SUPPORT_EMAIL> and disreguard the signup email. This site operates on a double opt-in procedure which requires you to continue the signup process before you receive any more emails. This will be the last email you will receive from <SITE_NAME> unless someone submits your email address once more. If this happens please contact <SUPPORT_EMAIL> with your email address and it can be blocked so you don't receive any in the future.

To complete your signup with  please follow this url:

<PAGES_URL>signup.php?CO=<CODE>;&EM=<EMAIL>

<a href=<PAGES_URL>signup.php?CO=<CODE>&EM=<EMAIL>>AOL Users</a>
";


$signup_info_subject="<SITE_NAME> Member Info";

$signup_info_message="
Welcome to <SITE_NAME> 
Your login username is <USERNAME>
Your login password is <PASSWORD>

You can login by going to 

<PAGES_URL>

if you need help email

<SUPPORT_EMAIL>
";

//---------------------------------
// Email address change templates:
//---------------------------------

$verification_info_subject="Email address change for <SITE_NAME>";

$verification_info_message="This information was submitted at <TIME> from IP/PROXY: <IPPROXY>. If you didn't submit your email at that time and that IP address isn't yours, then please send the email with headers to <SUPPORT_EMAIL> and disregard this email. 
    
This site operates on a double opt-in procedure which requires you to confirm email address before you receive any more emails. This will be the last email you will receive from <SITE_NAME> unless someone submits your email address once more. If this happens please contact <SUPPORT_EMAIL> with your email address and it can be blocked so you don't receive any in the future.
    
To complete your email address update please follow this url:
    
<PAGES_URL>userinfo.php?verification=<CODE>&email=<EMAIL>&username=<USERNAME>
    
<a href=<PAGES_URL>userinfo.php?verification=<CODE>;&email=<EMAIL>&username=<USERNAME>>HTML Link</a>
";

//---------------------------------
// New referral templates:
//---------------------------------

$notifications_new_referral_subject = "<SITE_NAME> :: You have a new referral!";

$notifications_new_referral_message = "Congratulations!

You have a new referral at <SITE_NAME>: <USERNAME>\n\n";

//---------------------------------
// Referral contest templates:
//---------------------------------

$refcontest_winner_subject = "<SITE_NAME> :: You were #<POSITION> in our referral contest!";

$refcontest_winner_message = "Congratulations <USERNAME>!

You were #<POSITION> in our referral contest with <REFERRALS> referrals! You won <REWARD>.

Please contact us if you have any questions regarding the prize.

--
<SITE_NAME> Administration ";
Retrieved from "http://wiki.cashcrusadersoftware.com/index.php?title=Email_templates"
Personal tools
Administration manual