taler-docs

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

get-mailbox.rst (756B)

      1 .. ts:op:: getMailbox
      2   :read-only:
      3 
      4   Get the mailbox configuration stored locally for a mailbox service.
      5   This operation only reads the wallet's local database.
      6 
      7   **Request:**
      8 
      9     The request arguments are a `MailboxBaseUrl` object.
     10 
     11   **Response:**
     12 
     13     On success, the result is a `GetMailboxResponse` object.  The
     14     ``mailboxConfiguration`` field is absent if the wallet has no
     15     mailbox configuration for the given base URL.
     16 
     17 .. ts:def:: MailboxBaseUrl
     18 
     19   interface MailboxBaseUrl {
     20     // Base URL of the mailbox service.
     21     mailboxBaseUrl: string;
     22   }
     23 
     24 .. ts:def:: GetMailboxResponse
     25 
     26   interface GetMailboxResponse {
     27     // Locally stored configuration for the mailbox service, if any.
     28     mailboxConfiguration?: MailboxConfiguration;
     29   }