taler-docs

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

add-mailbox-message.rst (649B)

      1 .. ts:op:: addMailboxMessage
      2 
      3   Store a mailbox message in the wallet's local database.  If a
      4   message with the same ``originMailboxBaseUrl`` and ``talerUri``
      5   already exists, its ``downloadedAt`` timestamp is updated.
      6 
      7   **Request:**
      8 
      9     The request arguments are an `AddMailboxMessageRequest` object.
     10 
     11   **Response:**
     12 
     13     On success, the result is an empty object.
     14 
     15   **Side effects:**
     16 
     17     Stores the message in the wallet's local database and emits a
     18     ``mailbox-message-added`` notification.
     19 
     20 .. ts:def:: AddMailboxMessageRequest
     21 
     22   interface AddMailboxMessageRequest {
     23     // The message to store.
     24     message: MailboxMessageRecord;
     25   }