E メイルによるニュースレターとリマインダ |
|
BOINC provides tools (PHP scripts) for sending two types of email to participants:
The scripts provide the following features:
The scripts requires that you use PHPMailer, is a PHP function for sending mail that's more full-featured than the one built into PHP. Download it, put it in html/inc, and set the USE_PHPMAILER, PHPMAILER_HOST, and PHPMAILER_MAILER variables in your project.inc file.
The general procedure for using each scripts is:
BOINC will replace the following macros in your email bodies (both HTML and text):
| <name/> | User name |
| <create_time/> | When account was created (D M Y) |
| <total_credit/> | User's total credit |
| <opt_out_url/> | URL for opting out (this URL includes a salted version of the participant's account key, and so is different for every participant). |
The script html/ops/mass_email_script.php is for sending email newsletters. The script categorize participants as follows:
| failed_html | HTML message sent to failed users. Example: <html> <body bgcolor=ffffcc> Dear <name/>: <p> Test Project continues to do pioneering computational research in the field of Submandibular Morphology. In recent months we have discovered over 17 new varieties of Frombats. <p> Our records show that you created a Test Project account on <create_time/> but that your computer hasn't completed any work. Possibly you encountered problems installing or using the software. Many of these problems have now been fixed, and we encourage you to visit <a href=http://a.b.c>our web site</a>, download the latest version of the software, and try again. <p> <font size=-2> To not receive future emails from Test Project, <a href=<opt_out_url/>>click here</a>. </font> </td></tr></table> </body> </html> |
| failed_text | Text message sent to failed users.
Example: Dear <name/>: Test Project continues to do pioneering computational research in the field of Submandibular Morphology. In recent months we have discovered over 17 new varieties of Frombats. Our records show that you created a Test Project account on <create_time/> but that your computer hasn't completed any work. Quite possibly you encountered problems installing or using the software. Many of these problems have now been fixed, and we encourage you to visit <a href=http://a.b.c>our web site</a>, download the latest version of the software, and try again. To not receive future emails from Test Project, visit <opt_out_url/> |
| email_failed_subject | Subject line sent to failed users. Example: 'Test Project News'. |
| lapsed_html | HTML message sent to lapsed users |
| lapsed_text | Text message sent to lapsed users |
| lapsed_subject | Subject line sent to lapsed users |
| current_html | HTML message sent to current users |
| current_text | Text message sent to current users |
| current_subject | Subject line sent to current users |
Test your email before sending it out to the world. As distributed, mass_email_script.php has the following variables defined near the top:
$testing = true;Set it to false to actually send emails (rather than just print to stdout).
$userid = 1;If this is nonzero, email will be sent to the given user ID; Otherwise it will be sent to all users.
To start, set $userid to the ID of your own user record. Run the script by typing
php mass_email_script.phpIt will print (to stdout) the contents of all three email types (failed, lapsed, and current). Verify that the subject, HTML and text are correct.
Then set $testing = false and run the script again. You'll get three emails; check them.
Then set $testing = false and $userid = 0, create an empty file called mass_email/log (see below), and run the script. You'll get voluminous output to stdout, but no emails will be sent. Control-C it quickly if you want. Make sure that each user is being sent the right type of email.
When you're sure that everything is correct, set $testing = false, set mass_email/log to empty, and run the script. It will now send mass emails. Depending on the size of your user table, it may take hours or days to complete. You can control-C it and restart whenever you want; it automatically picks up where it left off (see below).
mass_email_script.php manages checkpoint/restart when dealing with large numbers of participants. Mails are sent in order of increasing user ID. The file mass_email/log has a list of IDs that have been processed. On startup, the script reads this file, finds the last entry, and starts from there.
If you are starting a mass email from the beginning, empty the file mass_email/log; i.e.
truncate mass_email/log
The script html/ops/remind.php is for sending reminder emails. The script categorizes users as follows.
To use the script, create the following files in html/ops/reminder_email:
| failed_html | HTML message sent to failed users |
| failed_text | Text message sent to failed users |
| failed_subject | Subject line sent to failed users |
| lapsed_html | HTML message sent to lapsed users |
| lapsed_text | Text message sent to lapsed users |
| lapsed_subject | Subject line sent to lapsed users |
remind.php can be run as often as you like. We recommend running it every hours, specifying it as a task in config.xml. When it sends email to a user, it stores the time in their database record, and won't send them another email for at least 30 days. For this reason, it has no checkpoint/restart mechanism.
The procedure for testing your reminder email is similar to that for email newsletters (see above).
最終更新時刻 00:54:33, 2006年08月12日(JST)
Copyright © 2008 University of California.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License,
Version 1.2 or any later version published by the Free Software Foundation.
Copyright © 2008 Komori Hitoshi(je2bwm at jarl.com).
Japanese translation from English web pages on BOINC.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License,
Version 1.2 or any later version published by the Free Software Foundation.