DeleteMessage Method

Deletes the specified message from the queue.

Syntax

queue.deleteMessage(messageId, popReceipt, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method deletes the message identified by the MessageID and PopReceipt parameters.

When a message is retrieved by calling ListMessages the user is responsible for deleting the message from the queue.

If you plan to delete the message, after calling ListMessages store MessagesId and MessagesPopReceipt. These two values are required when deleting a message.

If you do not wish to delete a message, note that the message will be reserved for deletion and cannot be retrieved by other clients until VisibilityTimeout expires. After that time, other clients may retrieve and delete the message. The message may be deleted at any time, even after VisibilityTimeout has expired, given that it still exists in the queue.

When a message is successfully deleted, it is immediately marked for deletion and is no longer accessible to clients. The message is later removed from the queue during garbage collection.

If the message has already been deleted when DeleteMessage is called, the Queue service returns status code 404 (Not Found). If a message with a matching MessagesPopReceipt is not found, the service returns status code 400 (Bad Request).