taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

delete-mailbox-message.rst (841B)

      1 .. ts:op:: deleteMailboxMessage
      2 
      3   Delete a mailbox message from the wallet's local database.
      4 
      5   **Request:**
      6 
      7     The request arguments are a `DeleteMailboxMessageRequest` object.
      8 
      9   **Response:**
     10 
     11     On success, the result is an empty object.
     12 
     13   **Side effects:**
     14 
     15     Deletes the message from the wallet's local database and emits a
     16     ``mailbox-message-deleted`` notification.
     17 
     18   **Details:**
     19 
     20     The message is identified by the ``originMailboxBaseUrl`` and
     21     ``talerUri`` fields of the given message; the ``downloadedAt``
     22     field is ignored.  Deleting a message that does not exist is not
     23     an error; the ``mailbox-message-deleted`` notification is emitted
     24     regardless.
     25 
     26 .. ts:def:: DeleteMailboxMessageRequest
     27 
     28   interface DeleteMailboxMessageRequest {
     29     // The message to delete.
     30     message: MailboxMessageRecord;
     31   }