Return a message to its originator.

format

int POPSTORE_message_return (user_context, message_index, reason, reason_len) POPSTORE_user_context *user_context; int message_index; char *reason; int reason_len;

Arguments

user_context

User context returned by a previous call to POPSTORE_user_begin_d . Used for input only.

message_index

Index of the message to return. Used for input only.

reason

Pointer to a string containing a brief explanation explaining why the message is being returned. Used for input only.

reason_len

Length in bytes of the string pointed at by reason . Used for input only.

Description

Call POPSTORE_message_return to return a user's message to its originator. The reason the message is being returned can be indicated with the reason argument. If a null value is specified for reason or a zero length for reason_len , then the reason "Unable to deliver: recipient has not downloaded this message after X days" will be given. The index of the message to return is specified with message_index where the first message has index value 1, the second index value 2, and so on.

Return Values

POPSTORE_SUCCESS	Normal, successful completion.
POPSTORE_BADMSG	Underlying message file is corrupted or otherwise unreadable.
POPSTORE_BADMSGID	Message index is less than 1 or greater than user_context->message_count.
POPSTORE_DELETED	Message has been marked for deletion.
POPSTORE_FILOPNERR	Unable to open the underlying message file.
POPSTORE_INSUFPRIV	The process lacks SYSLCK privilege (OpenVMS only).
POPSTORE_LCKOPNERR	Unable to obtain lock information for the profile file.
POPSTORE_LOCKERROR	Unable to obtain a lock for the profile file.
POPSTORE_NULLCONTEXT	user_context context is null.
POPSTORE_NULLMSGLIST	user_context->messages is null.
POPSTORE_NULLPROFILE	user_context->profile context is null.
POPSTORE_TOOLONG	File specification for the underlying message file is too long.