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

''void **mailRevoke**([string //PersonID//], [int //Serienmail//])''

Ein Aufruf der Funktion ''mailRevoke()'' löscht Fortsetzungsmails im laufenden Interview, die mittels ''[[:de:create:functions:mailresume|mailResume()]]'' vorbereitet wurden, sowie Serienmails an den mit //PersonID// angegeben Adresseintrag, die mittels ''[[:de:create:functions:mailschedule|mailSchedule()]]'' vorbereitet wurden.

  * //PersonID//\\ Die Personenkennung des Adressaten, der die E-Mail erhalten soll. Falls das Interview durch eine Serienmail-Einladung begonnen wurde, können Sie ''false'' eintragen, die passende Kennung wird dann automatisch ermittelt.
  * //Serienmail// (optional)\\ Falls die Kennung einer Serienmail angegeben wird, werden nur solche Fortsetzungsmails storniert, für welche laut ''mailResume()'' die angegebene Serienmail verwendet werden sollte. Falls Sie Serienmails stornieren möchten, die mittels mailSchedule() vorbereitet wurden, __muss__ die Kennung der Serienmail angegeben werden.

===== Beispiel =====

Das Beispiel geht von einer zweiwelligen Befragung aus, der Teilnehmer wurde via Serienmail zum ersten Teil eingeladen. Am Ende des ersten Teils wurde dann mittels ''[[:de:create:functions:mailresume|mailResume()]]'' eine Einladung zum Fragebogen vorbereitet, die 14 Tage nach dem Ausfüllen von Teil 1 verschickt wird (Serienmail Nr. 2). Zusätzlich wurden noch 3 weitere E-Mails vorbereitet (nach 16, 18 und 20 Tagen), um den Teilnehmer an das Ausfüllen des zweiten Teils zu erinnern (Serienmail Nr. 3).

Sobald der Teilnehmer den zweiten Teil des Fragebogens beginnt, sind die Erinnerungen natürlich nicht mehr notwendig. Deshalb werden ausstehende Erinnerungen zu Beginn des zweiten Teils mittels ''mailRevoke()'' gelöscht.

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

Sollten Sie in der Erhebung noch an anderen Stellen mit ''mailResume()'' arbeiten, so müssen Sie die zu löschenden Serienmails spezifizieren, damit andere Aussendungen nicht ebenfalls von ''mailRevoke()'' gelöscht werden.

<code php>
mailRevoke(false, 2);  // Diese Zeile wird in der Praxis nicht nötig sein
mailRevoke(false, 3);  // Hiermit werden ausstehende Erinnerungen gelöscht
</code>