Both sides previous revisionPrevious revisionNext revision | Previous revision |
en:create:functions:mailschedule [29.08.2020 11:12] – sophia.schauer | en:create:functions:mailschedule [09.03.2022 21:59] (current) – admin |
---|
* '''status'''\\ Send reminder/follow-up emails only if the link in the original serial mail ... | * '''status'''\\ Send reminder/follow-up emails only if the link in the original serial mail ... |
* '''finished''' -- ...opened and the questionnaire was filled out to the end | * '''finished''' -- ...opened and the questionnaire was filled out to the end |
* '''incomplete''' -- ...was not opened or not filled in to the end | * '''incomplete''' -- ...was not opened __or__ not filled in to the end |
* '''no-response''' -- ...was not opened | * '''no-response''' -- ...was not opened |
* '''expire'''\\ Limit the validity of the personal participation link, the same format as for the //time// | * '''expire'''\\ Limit the validity of the personal participation link, the same format as for the //time// |
* '''to.email'''\\ Do not send e-mail to the e-mail address stored in the address entry, but to the e-mail address specified here. This function can be used to notify the project manager if a respondent does not complete a (follow-up) questionnaire within a defined time. | * '''to.email'''\\ Do not send e-mail to the e-mail address stored in the address entry, but to the e-mail address specified here. This function can be used to notify the project manager if a respondent does not complete a (follow-up) questionnaire within a defined time. |
* '''to.mobile'''\\ Do not send SMS to the phone number (possibly) stored in the address entry, but to the phone number specified here. The phone number must be specified with country code. | * '''to.mobile'''\\ Do not send SMS to the phone number (possibly) stored in the address entry, but to the phone number specified here. The phone number must be specified with country code. |
| * '''%custom1%''' to '''%custom5%'''\\ If contents for user-defined fields are specified in the ''mailSchedule()'' -command, in the serial mail these contents are used instead of the address entry. |
| |
**Note:** A mailing is sent (in contrast to ''mailResume()'') only once per recipient, even if the function is called up repeatedly. Sending different mailings is possible -- e.g. an invitation to take part in the second wave of the survey in 14 days and a further invitation to the third wave in 1 month. | **Note:** A mailing is sent (in contrast to ''mailResume()'') only once per recipient, even if the function is called up repeatedly. Sending different mailings is possible -- e.g. an invitation to take part in the second wave of the survey in 14 days and a further invitation to the third wave in 1 month. |
**Tip:** There are numerous websites on the internet that can covert a date into a Unix timestamp. For example: [[http://www.unixtime.de/|unixtime.de]]. The PHP [[http://www.php.net/manual/en/ref.datetime.php|Date/Time Functions]] (in particular ''[[http://php.net/manual/en/function.mktime.php|mktime()]]'' and ''[[http://www.php.net/manual/en/function.strtotime.php|strtotime()]]'') are ideally suited to this purpose. | **Tip:** There are numerous websites on the internet that can covert a date into a Unix timestamp. For example: [[http://www.unixtime.de/|unixtime.de]]. The PHP [[http://www.php.net/manual/en/ref.datetime.php|Date/Time Functions]] (in particular ''[[http://php.net/manual/en/function.mktime.php|mktime()]]'' and ''[[http://www.php.net/manual/en/function.strtotime.php|strtotime()]]'') are ideally suited to this purpose. |
| |
===== Example ===== | ===== Invitation to Follow-Up Survey ===== |
| |
A participant was invited to take part in the questionnaire via a mailing. 14 days after he clicked on the link, and thus accessed the questionnaire, he should receive an invitation to the second questionnaire (mailing no. 2) | A participant was invited to take part in the questionnaire via a mailing. 14 days after he clicked on the link, and thus accessed the questionnaire, he should receive an invitation to the second questionnaire (mailing no. 2) |
<code php> | <code php> |
mailSchedule(false, 2, strtotime('+1 month')); | mailSchedule(false, 2, strtotime('+1 month')); |
mailSchedule(false, 3, strtotime('+1 month +1 week'), array( | mailSchedule(false, 3, strtotime('+1 month +1 week'), [ |
'status' => 'no-response' | 'status' => 'no-response' |
)); | ]); |
</code> | </code> |
| |
| |
| ===== Custom Fields ===== |
| |
| The following command sends the serial mail with the ID 2 on the next Monday at 8 o'clock to the person, who just completes the questionnaire. Instead of the placeholder ''%custom1%'' the serial mail shows the date when ''mailSchedule()'' was called. |
| |
| <code php> |
| mailSchedule(false, 2, strtotime('next Monday 08:00:00'), [ |
| '%custom1%' => date('d.m.Y') |
| ]) |
| </code> |
| |