SAMConnection::remove

Remove a message from a queue.

&reftitle.description; `SAMMessage` `SAMConnection::remove` `string` `target` `array` `properties`

Removes a message from a queue.

&reftitle.parameters;

`target`

- The identity of the queue from which to remove the message.

`properties`

- An optional associative array of properties describing other parameters to control the remove operation.

  Property name | Possible values
  SAM_CORRELID | This is the target correlation id string of the message. This would typically have been returned by a "send" request.
  SAM_MESSAGEID | This is the message id string of the message which is to be removed.

&reftitle.returnvalues;

This method returns &false; if an error occurs.

&reftitle.examples;

### Removing a message from a queue by message id

    <?php
    if (!$conn->remove('queue://receive/test', array(SAM_MESSAGEID => $messageId))) {
      // The remove failed!
      echo "Remove failed ($conn->errno) $conn->error";
    }
    ?>