ListMessages Method

Retrieves message(s) from the current queue.

Object Oriented Interface

public function doListMessages();

Procedural Interface

inazure_queue_do_listmessages($res);

Remarks

This method retrieves messages from the queue specified by QueueName. Details of each returned message are available through the Message event or the Messages property.

By default, the class will retrieve only one message. Multiple messages may be retrieved by setting MaxResults.

If VisibilityTimeout is specified, the returned messages will not be visible by other clients for that time. If VisibilityTimeout is not specified the default visibility timeout of 30 seconds is used by the Azure service.

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).