« Back to Product

Documentation

IMAP_DeleteMail

Require: IP-Symcon >= 5.0

 boolean IMAP_DeleteMail (int $InstanceID, string $UID) 

Parameters

InstanceID

ID of the IMAP-Instance

UID

UID of the email to be deleted

Returns

If the command succeeds, it returns TRUE, otherwise FALSE.

Description

The function deletes an email with the UID UID from the IMAP-Instance with the ID InstanceID. If the instance or an e-mail with the transferred UID does not exist, a warning is generated.

Example

// Deletes the mail with the e-mail(UID) 1234
IMAP_DeleteMail (12345, "1234"));
Any questions?