Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
en:create:functions:mailrevoke [15.12.2014 21:10]
alexander.ritter [Example]
en:create:functions:mailrevoke [29.08.2020 10:49] (current)
sophia.schauer [mailRevoke()]
Line 3: Line 3:
 ''void **mailRevoke**([string //personID//], [int //mailing//])'' ''void **mailRevoke**([string //personID//], [int //mailing//])''
  
-By using the function ''mailRevoke()'', all continuation emails prepared using ''[[:en:create:functions:mailresume|mailResume()]]'' are deleted, as well as selective mailings prepared using ''[[:en:create:functions:mailschedule|mailSchedule()]]''.+By using the function ''mailRevoke()'', all continuation emails in the current interview prepared using ''[[:en:create:functions:mailresume|mailResume()]]'' are deleted, as well as selective mailings prepared using ''[[:en:create:functions:mailschedule|mailSchedule()]]''.
  
   * //personID//\\ The personal ID of the addressee who should receive the email. If the participant began the questionnaire after receiving an invitation via mailing, you can fill in ''false'' and a suitable ID will then be automatically determined.   * //personID//\\ The personal ID of the addressee who should receive the email. If the participant began the questionnaire after receiving an invitation via mailing, you can fill in ''false'' and a suitable ID will then be automatically determined.
Line 10: Line 10:
 ===== Example ===== ===== Example =====
  
-The example concerns a two-wave survey. The participant was invited to work through the first part after receiving a mailing. At the end of the first part an invitation to the questionnaire was prepared using ''[[:en:create:functions:mailresume|mailResume()]]'', which is sent 14 days after part 1 was filled out. In addition to this, 3 more emails were arranged to be sent out (after 16, 18 and 20 days) in order to remind the participant to fill out the second part (mailing no. 3). +The example concerns a two-wave survey. The participant was invited to fill out the first part after receiving a mailing. At the end of the first partan invitation to the questionnaire was prepared using ''[[:en:create:functions:mailresume|mailResume()]]'', sent 14 days after part 1 was filled out. In addition to this, 3 more emails were arranged to be sent out (after 16, 18 and 20 days) in order to remind the participant to fill out the second part (mailing no. 3). 
  
 As soon as the participant starts the second part of the questionnaire, the reminders are obviously not needed anymore. Therefore, pending reminders at the beginning of the second part are deleted using ''mailRevoke()''. As soon as the participant starts the second part of the questionnaire, the reminders are obviously not needed anymore. Therefore, pending reminders at the beginning of the second part are deleted using ''mailRevoke()''.
Line 19: Line 19:
 </code> </code>
  
-If you are working with ''mailResume()'' elsewhere in the survey, you have to specify the mailings to be deletedso that other mailings are not deleted by ''mailRevoke()'' as well. +If you are working with ''mailResume()'' elsewhere in the survey, you have to specify the mailings that should be deleted so that other mailings are not deleted by ''mailRevoke()'' as well. 
  
 <code php> <code php>
en/create/functions/mailrevoke.1418674250.txt.gz · Last modified: 15.12.2014 21:10 by alexander.ritter
 
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
Driven by DokuWiki