xp_deletemail

Description

(Windows only) Deletes a message from the Adaptive Server message inbox.

Syntax

xp_deletemail [msg_id]

Parameters

msg_id: is the message identifier of the mail message to be deleted.

Examples

Example 1

Deletes from the Adaptive Server message inbox the message with the message identifier specified in the cur_msg_id variable:

1> declare @cur_msg_id binary(255)
2> exec xp_deletemail @msg_id = @cur_msg_id

Example 2

Deletes the first message from the Adaptive Server message inbox:

xp_deletemail

Usage

Obtain the msg_id using xp_findnextmsg.
If the msg_id parameter is not used, the message to be deleted defaults to the first message in the message inbox.

Permissions

By default, only a System Administrator can execute xp_deletemail. A System Administrator can grant this permission to other users.