SDK Reference
Methods
SetEmail

setEmail

The provided email will be encrypted and only used by Orbis Nodes for notification purposes.

It can't be accessed by third parties or used for marketing purposes.


Encrypts a user's email address and attaches it to its profile

This email can be used by Orbis Nodes to send notifications (replies, mentions, etc).

User must have an active session for this query to work.

How to use?

const res = await orbis.setEmail(email);

Parameters

  • email - string a valid email address

Returns

{
  status: 200,
  doc: "kjzl6cwe1...e4wvxhiqj",
  result: "Success creating TileDocument.",
  encryptedEmail: {
    encryptedString: "",
    encryptedSymmetricKey: "",
    accessControlConditions: ""
  }
}