====== mailRevoke() ======

''void **mailRevoke**([string //personID//], [int //mailing//])''

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.
  * //mailing// (optional)\\ If a mailing ID is specified, only continuation emails are deleted for which the specified mailing as per ''mailResume()'' should be used. If you would like to delete mailings prepared using ''mailSchedule()'', the mailing ID __must__ be specified.

===== Example =====

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 part, an 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()''.


<code php>
mailRevoke();
</code>

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>
mailRevoke(false, 2);  // this line is effectively not needed
mailRevoke(false, 3);  // pending reminders are now deleted
</code>