Mark a user's message copy for deletion.

format

int POPSTORE_message_mark_delete (user_context, message_index) POPSTORE_user_context *user_context; int message_index;

Arguments

user_context

User context created by a prior call to POPSTORE_user_begin_d . Used for input only.

message_index

Index of the message to mark for deletion. Used for input only.

Description

To mark a user's stored message for deletion, use POPSTORE_message_mark_delete . The index of the message to mark for deletion is specified with message_index . The first message has index 1, the second index 2, and so on. Note that the message is not immediately deleted. It is retained until the user context is shut down with POPSTORE_user_end . ⁵ Note further that the underlying message file will only be deleted when all popstore recipients of the message have deleted the message.

Return Values

POPSTORE_SUCCESS	Normal, successful completion.
POPSTORE_BADMSGID	Message index is less than 1 or greater than user_context->message_count.
POPSTORE_NULLCONTEXT	user_context context is null.
POPSTORE_NULLMSGLIST	user_context->messages is null.
POPSTORE_NULLPROFILE	user_context->profile context is null.