panelDelete()

The function panelDelete() deletes one or more entries from the list of contacts used for sending mailings.

void panelDelete(string action, array searchParameters)

Warning: If you delete address entries with the action 'final', this cannot be undone.

Note: Deleting the address entries also deletes or disables all sending times that may exist for these address entries.

• action
  • 'disable' – Disable address entries
  • 'bin' – Move address entries to the trash bin
  • 'final' – Delete address entries permanently
• searchParameters
  Specify an array with one or more values by which the address entry shall be identified. Only entries that match all parameters will be deleted. The following array keys are possible:
  • 'email' – Address entries with the given email address
  • 'mobile' – Address entries with the given mobile phone number
  • 'uid' – Address entries with the given unique ID
  • 'SERIAL' – Address entries with the given person ID (only for address entries with the privacy mode “individual-related”)
  • 'subgroup' – Address entries in the given subgroup (specify the empty string '' for address entries without a subgroup)
  • 'unspecific' – Selection based on the following flexible criteria:
    • 'current' – Address entry of the current respondent
    • 'any' – All address entries

The following PHP code moves all address entries with the email address example@soscisurvey.de to the trash bin.

panelDelete('bin', ['email' => 'example@soscisurvey.de']);

The following PHP code disables all address entries in the current survey project.

panelDelete('disable', ['unspecific' => 'any']);