SocketTools .NET Edition

MailMessage.PurgeStore Method 

Purge all deleted messages from the current message store.

[Visual Basic]
Public Function PurgeStore() As Boolean
[C#]
public bool PurgeStore();

Return Value

This method returns a boolean value. If the method succeeds, the return value is true. If the method fails, the return value is false. To get extended error information, check the value of the LastError property.

Remarks

The PurgeStore method purges all deleted messages from the message store. If the storage file has been opened in read-only mode or there are no messages marked for deletion, this method will take no action.

When the CloseStore method is called, the storage file will automatically be purged. To prevent deleted messages from being removed from the message store, use the Reset method.

See Also

MailMessage Class | SocketTools Namespace