Overview

Inboxes are a way for users to send encrypted data to your app.

The advantage of Inboxes is that they don't require the user to be registered in order to send encrypted data. This opens up various possibilities in environments where you need to gather sensitive information from unregistered users (e.g. on your website).

To learn more about Inboxes, their structure, how they are encrypted, and what are their use cases - read Inbox Docs.

Before working with Inboxes, follow our Getting Started Guide. It will show you how to set up your project to work with PrivMX Bridge.

The sample code on this page is based on the same assumptions

Working with Inboxes

When working with Inboxes, you will use the following:

inboxApi - for methods used to manage Inboxes in given Context

const threadApi = await Endpoint.createThreadApi(connection);
const storeApi = await Endpoint.createStoreApi(connection);
const inboxApi = await Endpoint.createInboxApi(connection, threadApi, storeApi);

Creating an Inbox

Creating a basic unnamed Inbox, which can be used if your app needs only one Inbox and you don't need a distinction between them:

const users = [{ userId: 'MY_USER', pubKey: 'PUB_KEY' }, { userId: 'MY_USER2', pubKey: 'PUB_KEY2' }];
const managers = [{ userId: 'MY_USER', pubKey: 'PUB_KEY' }];
 
 
const inboxId = await inboxApi.createInbox(
    'CONTEXT_ID',
    users,
    managers,
    serializeObject("some public-meta"),
    serializeObject("some private-meta"),
    undefined // optional files config
);

Fetching Inboxes

Fetching the most recent Inboxes in given Context:

const defaultListQuery = {skip:0, limit: 100, sortOrder: "asc"};
 
const inboxList = await inboxApi.listInboxes(
    "CONTEXT_ID",
    defaultListQuery
);
 
const inboxListwithDeserializedMeta = inboxList.readItems.map(inbox => {
    return {
        inbox: inbox,
        privateMeta: deserializeObject(inbox.privateMeta),
        publicMeta: deserializeObject(inbox.publicMeta)
    };
});

Remember that data is transmitted in binary format, so you'll need to parse it back into your desired format. You can use the deserializeObject function provided by the SDK for this purpose.

Modifying Inboxes

To update an Inbox you must always provide its current version, as well as:

list of users,
list of managers,
new private and public meta (even if it didn't change).

const inbox = await inboxApi.getInbox(
    inboxId    
);
 
const newUsers = inbox.users.map(user => ({
        //Your application must provide a way,
        //to get user's public key from their userId.
        userId: user,
        pubKey: 'USER_PUBLIC_KEY'
    })
);
 
const newManagers = newUsers.filter(user =>
    inbox.managers.find(manager => manager == user.userId));
 
const newPrivateMeta = {
    title: 'New inbox name'
};
 
await inboxApi.updateInbox(
    inboxId    
    newUsers,
    newManagers,
    inbox.publicMeta,
    serializeObject(newPrivateMeta),
    inbox.filesConfig,
    inbox.version,
    false, 
    false
);

Working with Inboxes

Creating an Inbox

Fetching Inboxes

Modifying Inboxes

On this page