@telios/telios-client-backend

Release 6.0.4

A reusable backend to for telios email clients to use between desktop and mobile.

Homepage Repository npm TypeScript Download

License
CC-BY-NC-4.0
Install
npm install @telios/telios-client-backend@6.0.4

Documentation

telios-backend

Build Status

A reusable backend to for telios email clients to use between desktop and mobile.

Installation

npm i --save @telios/telios-client-backend

Usage

Electron example:

const path = require('path')
const fs = require('fs')
const { fork } = require('child_process')
const { remote } = require('electron')
const userDataPath = remote.app.getPath('userData')
const filePath = path.join(__dirname, '/node_modules/telios-client-backend/index.js')

let cwd = path.join(__dirname, '..');

if (!fs.existsSync(path.join(cwd, 'app.asar'))) {
  cwd = null;
}

const child = fork(filePath, [userDataPath, 'development', 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:107.0) Gecko/20100101 Firefox/107.0'], {
  stdio: ['pipe', 'pipe', 'pipe', 'ipc'],
  cwd
})

// listen for channel events
child.on('message', m => {
  const { event } = m
  
  this.emit(event, m)
})

child.stderr.on('error', data => {
  this.emit('error', data.toString())
})

// Send channel events
child.send({ 
  event: 'account:create', 
  payload: {
    email: 'alice@telios.io',
    password: 'letmein123',
    vcode: 'btester1',
    recoveryEmail: 'alice@mail.com'
  }
})

Mobile example:

const bridge = require('rn-bridge')
const { ClientBackend } = require('@telios/telios-client-backend');

const channel = bridge.channel

const userDataPath = bridge.app.datadir()
const env = 'development'

// Instantiate backend
ClientBackend(channel, userDataPath, env, userAgent)

channel.send({ 
  event: 'account:create', 
  payload: {
    email: 'alice@telios.io',
    password: 'letmein123',
    vcode: 'btester1',
    recoveryEmail: 'alice@mail.com'
  }
})

channel.on('account:create:callback', cb => {
  const { error, data } = cb
})

Drive API

channel.on('drive:network:updated', data => {})

channel.on('drive:peer:updated', data => {})

Returns the following peer info:

  {
    peerKey: '00000000000000000000000000000000',
    status: 'ONLINE' | 'OFFLINE' | 'BUSY',  'AWAY',
    server: true | false
  }

Account API

channel.send({ event: 'account:create', payload }) 

const payload = {
  email: 'alice@telios.io',
  password: 'letmein123',
  vcode: 'testcode123',
  recoveryEmail: 'alice@mail.com'
}

channel.send({ event: 'account:login', payload }) 

const payload = {
  email: 'alice@telios.io',
  password: 'letmein123'
}

channel.on('account:login:status', data => {})

Retrieve status updates on the account login event

Example:

  channel.on('account:login:status', cb => {
    const { data } = cb
    console.log(data) // 'Migrating account data'
  })

channel.send({ event: 'account:updatePassword', payload })

Update the account's password while already logged into the account

Example:

const payload = {
  email: 'bob@telios.io',
  newPass: '321inmelet'
}

channel.send({ event: 'account:resetPassword', payload })

Reset an account's password in the event the account the password is lost

Exmaple:

const payload = {
  passphrase: 'hub edit torch trust silent absorb news process pioneer category arrive prevent scrub senior cruise love wire elder field parent device physical warm clutch',
  email: 'bob@telios.io',
  newPass: 'letmein999',
}

channel.send({ event: 'account:createNewPassphrase' })

Generates a new passphrase if the original passphrase was lost and you still have access to the master password

Exmaple:

channel.send({ event: 'account:createNewPassphrase' })

channel.on('account:createNewPassphrase:callback', cb => {
  const { error, data } = cb
  console.log(data.mnemonic)
})

channel.send({ event: 'account:update', payload })

channel.send({ event: 'account:retrieveStats' })

channel.send({ event: 'account:logout', [payload] }) 

const payload = { kill: false } // optionally log out of an account without killing the main node thread

channel.send({ event: 'account:refreshToken' })

Recovery API

channel.send({ event: 'account:recover', payload })

Sends a recovery code to the account's recovery email.

const payload = {
  email: 'bob@telios.io',
  recoveryEmail: 'bob@mail.com',
}

Device Sync API

channel.send({ event: 'account:createSyncCode' })

Use this when initiating a sync with another device that may be unable to scan a QR code. The other device will use the code returned from this event to initate a sync.

Note: When using QR codes, they should return the following data:

{ 
  drive_key, // public key of the remote drive
  email // email address of the main account
}

channel.send({ event: 'account:getSyncInfo', { code } })

Retrieve the info necessary to intiate a sync.

Returns:

{ 
  drive_key, // public key of the remote drive
  email // email address of the main account
}

channel.send({ event: 'account:sync', payload })

Initializes replication of remote drive. This event will resolve after replication is complete. Once replication finishes, the user should be directed to log in to their account (payload.email) using their master password.

const payload = {
  deviceType: 'MOBILE' | 'DESKTOP',
  driveKey,
  email,
  password
}

channel.on('account:sync:callback', (data) => {})

Fires whenever a the status of account sync has received an update. You can use to this to show visually show users the current status of an account sync.

Example:

channel.on('account:sync:callback', (data) => {
  const { data, error } = data

  console.log(data.status) // example: 'Syncing data from peer device'
})

channel.on('account:collection:updated', (data) => {})

Fires whenever a collection is updated from a synced device or remote peer. Returns the collection name and updated values.

Mailbox API

channel.send({ event: 'mailbox:register', payload }) 

const payload = {
  account_key,
  addr: 'alice@telios.io'
}

channel.send({ event: 'mailbox:getNewMailMeta' })

channel.send({ event: 'mailbox:markArrayAsSynced', payload }) 

const payload = {
  msgArray: ['emailId1', 'emailId2']
}

channel.send({ event: 'mailbox:getMailboxes' })

channel.send({ event: 'mailbox:saveMailbox', payload }) 

const payload = {
  address: 'bob@telios.io'
}

Alias API

channel.send({ event: 'alias:registerAliasNamespace', payload }) 

const payload = {
  mailboxId: mailboxId,
  namespace: 'alice2022'
}

channel.send({ event: 'alias:getMailboxNamespaces', payload }) 

const payload = { 
  id: mailboxId 
}

channel.send({ event: 'alias:getMailboxAliases', payload }) 

const payload = {
  namespaceKeys: ['alice2022']
}

channel.send({ event: 'alias:updateAliasAddress', payload }) 

const payload = {
  namespaceName: 'alice2022',
  domain: 'dev,telios.io',
  address: 'netflix',
  description: 'Updated description',
  fwdAddresses: ['alice@mail.com', 'alice@somemail.com'],
  disabled: true,
  updatedAt: UTCTimestamp
}

channel.send({ event: 'alias:updateAliasCount', payload }) 

const payload = { 
  id: 'alice2022#netflix' , 
  amount: 1 // Use a negative integer to decrement count
}

channel.send({ event: 'alias:removeAliasAddress', payload }) 

const payload = {
  namespaceName: 'alice2022',
  domain: 'dev,telios.io',
  address: 'netflix'
}

Folder API

channel.send({ event: 'folder:createFolder', payload }) 

const payload = {
  mailboxId: mailboxId,
  folderId: 6,
  name: 'Test',
  type: 'default',
  icon: 'trash-o',
  seq: 6,
  createdAt: UTCTimestamp,
  updatedAt: UTCTimestamp
}

channel.send({ event: 'folder:updateFolder', payload }) 

const payload = {
  folderId: 6,
  name: 'Foo Folder'
}

channel.send({ event: 'folder:updateFolderCount', payload }) 

const payload = {
  id: 6,
  amount: 1 // use a negative integer to decrement count
}

channel.send({ event: 'folder:getMailboxFolders', payload }) 

const payload = { 
  id: mailboxId 
}

channel.send({ event: 'folder:deleteFolder', payload }) 

const payload = { 
  id: mailboxId 
}

Email API

channel.send({ event: 'email:sendEmail', payload }) 

const payload = { 
  email: {
    from: [{"name":"Bob Kinderly","address":"bob@telios.io"}],
    to: [{"name":"Alice Drumpf","address":"alice@telios.io"}],
    subject: 'Subject-d510aa65-40c0-4b36-98ba-84735aa961d0',
    date: '2022-01-20T18:21:33.062Z',
    cc: [{"name":"Json Waterfall","address":"jwaterfall@telios.io"}],
    bcc: [{"name":"Albus Dumbeldore","address":"albus.dumbeldore@howgwarts.edu"}],
    bodyAsText: 'This is a test message-d510aa65-40c0-4b36-98ba-84735aa961d0',
    bodyAsHtml: '<div>This is a test message-d510aa65-40c0-4b36-98ba-84735aa961d0</div>',
    attachments: [{
      filename: 'image.png',
      content: 'b64EncodedString',
      mimetype: 'image/png',
      size: 1024// bytes
    }]
  } 
}

channel.send({ event: 'email:saveMessageToDB', payload }) 

const payload = {
  type: 'Incoming' | 'Draft',
  messages: [{
    from: [{"name":"Bob Kinderly","address":"bob@telios.io"}],
    to: [{"name":"Alice Drumpf","address":"alice@telios.io"}],
    subject: 'Subject-d510aa65-40c0-4b36-98ba-84735aa961d0',
    date: '2022-01-20T18:21:33.062Z',
    cc: [{"name":"Json Waterfall","address":"jwaterfall@telios.io"}],
    bcc: [{"name":"Albus Dumbeldore","address":"albus.dumbeldore@howgwarts.edu"}],
    bodyAsText: 'This is a test message-d510aa65-40c0-4b36-98ba-84735aa961d0',
    bodyAsHTML: '<div>This is a test message-d510aa65-40c0-4b36-98ba-84735aa961d0</div>',
    attachments: [{
      filename: 'image.png',
      content: 'b64EncodedString',
      mimetype: 'image/png',
      size: 1024// bytes
    }]
  }] 
}

channel.send({ event: 'email:getMessagesByFolderId', payload }) 

const payload = {
  id: 5,
  offset: 10,
  limit: 50,
  unread: true 
}

channel.send({ event: 'email:getReadMessagesByFolderId', payload }) 

const payload = {
  id: 5,
  offset: 10,
  limit: 50
}

channel.send({ event: 'email:getUnreadMessagesByFolderId', payload }) 

const payload = {
  id: 5,
  offset: 10,
  limit: 50
}

Note: Omitting the unread property will return all read and unread messages.

channel.send({ event: 'email:getMessagesByAliasId', payload }) 

const payload = {
  id: 'alice2022#existing' ,
  offset: 10,
  limit: 50,
  unread: true
}

channel.send({ event: 'email:getReadMessagesByAliasId', payload }) 

const payload = {
  id: 'alice2022#existing' ,
  offset: 10,
  limit: 50
}

channel.send({ event: 'email:getUnreadMessagesByAliasId', payload }) 

const payload = {
  id: 'alice2022#existing' ,
  offset: 10,
  limit: 50
}

channel.send({ event: 'email:moveMessages', payload }) 

const emails = emailArr.map(msg => {
  return {
    ...msg,
    folder: { // Add this object to each email with the ID of the folder the email is moving to
      toId: 1
    }
  }
})

  const payload = {
    messages: emails
  }

channel.send({ event: 'email:getMessageById', payload }) 

const payload = {
  id: emailId 
}

channel.send({ event: 'email:markAsUnread', payload }) 

const payload = {
  id: emailId 
}

channel.send({ event: 'email:removeMessages', payload }) 

const payload = {
  messageIds: [emailId]
}

channel.send({ event: 'email:searchMailbox', payload }) 

const payload = {
  searchQuery: 'Alice tax returns'
}

Contacts API

channel.send({ event: 'contact:createContacts', payload }) 

const payload = {
    contactList: [{
      name: 'Albus Dumbeldore',
      givenName: 'Albus',
      familyName: 'Dumbeldore',
      nickname: 'Dumbeldorf',
      birthday: '2022-01-21T20:31:46.726Z', // ISO datetime
      publicKey: '00000000000000000000000000000000',
      pgpPublicKey: '00000000000000000000000000000000',
      email: 'albus.dumbeldore@hogwarts.edu',
      phone: '555-555-5555',
      address: '123 Any St.',
      website: 'https://hogwarts.edu',
      notes: 'Lorem ipsum dolar sit amet...',
      organization: [ { name: 'Hogwarts Inc' } ]
    }]
  }

channel.send({ event: 'contact:getContactById', payload }) 

const payload = {
  id: contact.contactId
}

channel.send({ event: 'contact:updateContact', payload }) 

const payload = {
  ...contact,
  id: contact.contactId,
  givenName: 'Snape'
}

channel.send({ event: 'contact:searchContact', payload }) 

const payload = {
  searchQuery: 'albus'
}

channel.send({ event: 'contact:getAllContacts' })

channel.send({ event: 'contact:removeContact', payload }) 

const payload = {
  id: contact.contactId
}

Custom Domains API

channel.send({ event: 'domain:isAvailable', payload })

Checks if a domain has already been registered.

const payload = {
  domain: 'telios.app'
}

channel.send({ event: 'domain:register', payload })

Register a new custom domain. This only initially adds the custom domain record in the database, but does not create the domain on the mailserver. The domain won't get created on the mailserver until it has been verified.

const payload = {
  domain: 'telios.app'
}

Example response:

// Use verification to send DNS instructions for creating verifcation TXT record
{
  domain: "telios.app",
  verification: {
    name: "@",
    type: "TXT",
    value: "telios-verification=d48808347d7d8a0b91f2e3af9d77ce33"
  }
}

channel.send({ event: 'domain:verifyOwnership', payload })

Verify that the user owns the domain they're trying to register. Once verified, the domain is created on the mailserver. Mail will not start routing through this domain until all checks are passed on the verifyDNS step.

const payload = {
  domain: 'telios.app'
}

channel.send({ event: 'domain:verifyDNS', payload })

Returns additional DNS records that need to be set and their verification status. Once all records have been verified, the domain is set to active and mail will start being delivered.

const payload = {
  domain: 'telios.app'
}

Example response:

[
  {
    "type": "MX",
    "name": "telios.app",
    "value": "mailer.telios.app",
    "verified": true
  },
  {
    "type": "TXT",
    "name": "telios.app",
    "value": "v=spf1 include:mailer.telios.app ~all",
    "verified": true
  },
  {
    "type": "TXT",
    "name": "dkim._domainkey.telios.app",
    "value": "",
    "verified": true
  },
  {
    "type": "TXT",
    "name": "_dmarc.telios.app",
    "value": "v=DMARC1;p=quarantine",
    "verified": true
  }
]

channel.send({ event: 'domain:getDomainByName', payload }) 

const payload = {
  domain: 'telios.app'
}

channel.send({ event: 'domain:getDomains' })

channel.send({ event: 'domain:registerMailbox', payload }) 

const payload = { 
  type: 'SUB' | 'CLAIMABLE', 
  email: 'bob@telios.app',
  password: 'letmein123',
  displayName: 'John Doe',
  domain: 'telios.app',
  recoveryEmail: 'bob_recovery@mail.com',
  deviceType: 'DESKTOP' | 'MOBILE'
}

channel.send({ event: 'domain:resendMailboxInvite', payload }) 

const payload = { 
  addr: 'bob@telios.app',
  password: 'letmein123',
  inviteEmail: 'bob_recovery@mail.com'
}

channel.send({ event: 'domain:deleteMailbox', payload }) 

const payload = { 
  address: 'bob@telios.app'
}

channel.send({ event: 'domain:delete' }) 

const payload = {
  domain: 'telios.app'
}

Messages Handler API

channel.send({ event: 'messageHandler:initMessageListener' })

channel.send({ event: 'messageHandler:newMessageBatch', payload })

channel.send({ event: 'messageHandler:newMessage', payload })

channel.send({ event: 'messageHandler:retryMessageBatch', payload })

Stats

Dependencies
13
Dependent packages
2
Dependent repositories
0
Total releases
137
Latest release
First release
Stars
4
Forks
2
Watchers
2
Contributors
3
Repository size
10.6 MB
SourceRank
9

Development practices

Source repo 2FA enabled
TEXT!
Package manager 2FA enabled
TEXT!
Is security responsive
TEXT!
Dependencies are managed
TEXT!
Issue-free release available
TEXT!
Succession plan available
TEXT!
Package manager 2FA enabled
TEXT!

The Tidelift Subscription provides access to a continuously curated stream of human-researched and maintainer-verified data on open source packages and their licenses, releases, vulnerabilities, and development practices.

Learn more →

Releases

6.0.4
6.0.3
6.0.2
6.0.1
6.0.0
5.2.4
5.2.3
5.2.2
5.2.1
5.2.0
See all 137 releases

Contributors

hexadecible Youri Noel Nelson Justin Poliachik


See all contributors

Something wrong with this page? Make a suggestion

Export .ABOUT file for this package

Last synced: 2023-02-07 17:11:52 UTC

Login to resync this project