taler-docs

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

get-mailbox-message.rst (1048B)

      1 .. ts:op:: getMailboxMessage
      2   :read-only:
      3 
      4   Get the mailbox messages stored locally in the wallet.
      5 
      6   Note that the TypeScript client library exposes this operation as
      7   ``GetMailboxMessages`` (with a trailing "s"), while the operation name
      8   sent on the wire is ``getMailboxMessage``.
      9 
     10   **Request:**
     11 
     12     This operation takes no arguments (an empty object).
     13 
     14   **Response:**
     15 
     16     On success, the result is a `MailboxMessagesResponse` object.
     17 
     18   **Details:**
     19 
     20     This operation only reads the wallet's local database; use
     21     :ts:op:`refreshMailbox` to download new messages from the mailbox
     22     service.
     23 
     24 .. ts:def:: MailboxMessagesResponse
     25 
     26   interface MailboxMessagesResponse {
     27     // Locally stored mailbox messages.
     28     messages: MailboxMessageRecord[];
     29   }
     30 
     31 .. ts:def:: MailboxMessageRecord
     32 
     33   // Record metadata for mailbox messages.
     34   interface MailboxMessageRecord {
     35     // Origin mailbox.
     36     originMailboxBaseUrl: string;
     37 
     38     // Time of download.
     39     downloadedAt: Timestamp;
     40 
     41     // Taler URI in message.
     42     talerUri: string;
     43   }