Topic Path: Symbol Reference > Classes > TIdIMAP4 Class > TIdIMAP4 Methods > UIDDeleteMsg Method
ContentsIndexHome
PreviousUpNext
TIdIMAP4.UIDDeleteMsg Method

Marks the specified message for subsequent deletion when a mailbox is purged.

function UIDDeleteMsg(
    const AMsgUID: String
): Boolean;
Parameters 
Description 
AMsgUID 
Message unique identifier to mark for deletion. 

Boolean - True on success.

UIDDeleteMsg is a Boolean function used to mark the specified message in AMsgUID for subsequent deletion when the mailbox is purged. UIDDeleteMsg calls StoreFlags to add the message flag value mfDeleted to the flags stored for the associated message on the IMAP4 server. 

A mailbox must be selected using the SelectMailBox method prior to calling DeleteMsgs, or an exception is raised when storing the message flags on the IMAP4 server. 

Use DeleteMsgs or UIDDeleteMsgs to mark a list of messages for deletion using their unique identifiers or relative message numbers. 

Use ExpungeMailBox to remove messages marked for deletion in the specified mailbox. 

Use GetUID to retrieve the UID for a specified relative message number.

Copyright 1993-2006, Chad Z. Hower (aka Kudzu) and the Indy Pit Crew. All rights reserved.
Post feedback to the Indy Docs Newsgroup.