github.com/status-im/status-go@v1.1.0/services/mailservers/README.md (about)

     1  Mailservers Service
     2  ================
     3  
     4  Mailservers service provides read/write API for `Mailserver` object 
     5  which stores details about user's mailservers.
     6  
     7  To enable this service, include `mailservers` in APIModules:
     8  
     9  
    10  ```json
    11  {
    12    "MailserversConfig": {
    13      "Enabled": true
    14    },
    15    "APIModules": "mailservers"
    16  }
    17  ```
    18  
    19  API
    20  ---
    21  
    22  Enabling service will expose three additional methods:
    23  
    24  #### mailservers_addMailserver
    25  
    26  Stores `Mailserver` in the database.
    27  
    28  ```json
    29  {
    30      "id": "1",
    31      "name": "my mailserver",
    32      "address": "enode://...",
    33      "password": "some-pass",
    34      "fleet": "prod"
    35  }
    36  ```
    37  
    38  #### mailservers_getMailservers
    39  
    40  Reads all saved mailservers.
    41  
    42  #### mailservers_deleteMailserver
    43  
    44  Deletes a mailserver specified by an ID.
    45  
    46  ## Mailserver requests gap service
    47  
    48  Mailserver request gaps service provides read/write API for `MailserverRequestGap` object 
    49  which stores details about the gaps between mailserver requests.
    50  
    51  API
    52  ---
    53  
    54  The service exposes four methods
    55  
    56  #### mailserverrequestgaps_addMailserverRequestGaps
    57  
    58  Stores `MailserverRequestGap` in the database.
    59  All fields are specified below:
    60  
    61  ```json
    62  {
    63    "id": "1",
    64    "chatId": "chat-id",
    65    "from": 1,
    66    "to": 2
    67  }
    68  ```
    69  
    70  #### mailservers_getMailserverRequestGaps
    71  
    72  Reads all saved mailserver request gaps by chatID.
    73  
    74  #### mailservers_deleteMailserverRequestGaps
    75  
    76  Deletes all MailserverRequestGaps specified by IDs.
    77  
    78  #### mailservers_deleteMailserverRequestGapsByChatID
    79  
    80  Deletes all MailserverRequestGaps specified by chatID.
    81  
    82  #### mailservers_addMailserverTopic
    83  
    84  Stores `MailserverTopic` in the database.
    85  ```json
    86  {
    87      "topic": "topic-as-string",
    88      "chat-ids": ["a", "list", "of", "chatIDs"],
    89      "last-request": 1
    90  }
    91  ```
    92  
    93  #### mailservers_getMailserverTopics
    94  
    95  Reads all saved mailserver topics.
    96  
    97  #### mailservers_deleteMailserverTopic
    98  
    99  Deletes a mailserver topic using `topic` as an identifier.
   100  
   101  #### mailservers_addChatRequestRange
   102  
   103  Stores `ChatRequestRange` in the database.
   104  ```json
   105  {
   106      "chat-id": "chat-id-001",
   107      "lowest-request-from": 1567693421154,
   108      "highest-request-to": 1567693576779 
   109  }
   110  ```
   111  
   112  #### mailservers_getChatRequestRanges
   113  
   114  Reads all saved chat request ranges.
   115  
   116  #### mailservers_deleteChatRequestRange
   117  
   118  Deletes a chat request range by `chat-id`.