taler-docs

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

send-taler-uri-mailbox-message.rst (986B)

      1 .. ts:op:: sendTalerUriMailboxMessage
      2 
      3   Send a ``taler://`` URI to the mailbox of a contact.  Wallet-core
      4   fetches the public keys of the recipient's mailbox from the
      5   contact's mailbox service, verifies that they match the contact's
      6   mailbox address, encrypts the URI for the recipient and uploads it
      7   to the recipient's mailbox.
      8 
      9   **Request:**
     10 
     11     The request arguments are a `SendTalerUriMailboxMessageRequest`
     12     object.
     13 
     14   **Response:**
     15 
     16     On success, the result is an empty object.
     17 
     18   **Side effects:**
     19 
     20     Sends the ``taler://`` URI as a message via the contact's mailbox
     21     service over the network.  Does not change local wallet state.
     22 
     23   **Expected errors:**
     24 
     25     The caller can handle the following errors inline:
     26     ``WALLET_MAILBOX_UNAVAILABLE``.
     27 
     28 .. ts:def:: SendTalerUriMailboxMessageRequest
     29 
     30   interface SendTalerUriMailboxMessageRequest {
     31     // The recipient contact.
     32     contact: ContactEntry;
     33 
     34     // The taler:// URI to send.
     35     talerUri: string;
     36   }