Low-level function to make authenticated request to MailBots API

Factory method to return a new, fully authenticated MailBots client based on the webhook

mailbot.onCommand('foo', bot => {
    const mbClient = MailBotsClient.fromBot(bot);
  })

Get information about the bot that corresponds with user's Bearer token (ie, most likely your bot).

const res = await mbClient.mailbotGetSelf();

Send an Event to the bot. This does not require and auth token because the endpoint is meant for 3rd party services. Ex: issue created in Github, or an email response or support ticket received. The MailBots bot can listen for events, act on tasks or create or delete tasks based on events.

const res = await mbClient.sendEvent({type: 'event.type', payload: {"foo", "bar"}, event_url: "[unique_event_url]"});

An "Interbot Event" allows bots to send messages to each other. This allows a MailBot to expose actions that can be utilized by other MailBots (for example, creating an Evernote note) In this way, MailBots can become composable. Requires elevated oauth scope.

const res = await mbClient.sendInterbotEvent({subdomain: 'git', payload: {"foo", "bar"}});

Save MailBot data which is sent with every webhook related to that bot. This is how a bot persist's user settings specific to that bot. For params and details, see bot saving data API docs

const res = await mbClient.saveBotData({ foo: "bar" });

Get saved MailBot data For params and details, see mailbots get data API docs

const res = await mbClient.getBotData();

Get a filtered list of People

// Get all people
const res = await mbClient.searchPeople();
console.log(res.people);

// With a callback
mbClient.searchPeople({ limit: 1 }, (err, res) => {
    if (err) done(err);
    console.log(res.people);
  });

Create a new person.

Get a person by it's ID.

// Get person with id 3
const res = await mbClient.getPersonById(3);
console.log(res.person);

Update a person by id.

Update multiple people with a single batch operation.

Create a new person event.

Update a person's tags attribute by id.

Merge one or more people into a base person.

Get a filtered list of MailBots tasks

// Get all open tasks, sorted by due date
const res = await mbClient.getTasks();
console.log(res.tasks);

// With a callback
mbClient.getTasks({ limit: 1 }, (err, res) => {
    if (err) done(err);
    console.log(res.tasks);
  });

Get a MailBots task Passing ?verbose=1 fires a webhook to the extnesion and fetches a rendered HTML email preview of the task

const res = await getTask({id: 123});

Create a new MailBots Task.

const res = await mbClient.createTask(
    {
      webhook: false,
      suppress_email: true,
      verbose: 1,
      task: {
        command: process.env.EXAMPLE_COMMAND
      },
      send_messages: [
        {
          type: "email",
          subject: "A test email message",
          to: "test@example.com",
          body: [
            {
              type: "html",
              html: "<h1>This is a test</h1>"
            }
          ]
        }
      ]
    });

Send email and automatically create a Task This creates a MailBots task and sends an email. It's a wrapper for createTask with opinionated settings for just sending email.

const res = await mbClient.sendEmail({
    command: "command@my-ext.eml.bot", // must be your bot's domain
    to: "test@exampletask.com",
    cc: [],
    bcc: [],
    from: "test@example.com",
    subject: "Test1",
    body: [
      {
        type: "html",
        text: "<h1>This is a test</h1>"
      }
    ]
  });

Send emails relating to an existing Task. Does not mutate task. NOTE: This may be deprecated in favor of sending messages via the update task endpoint.

const res = await mbClient.sendMessages({
  task: {
    id: 123
  },
  send_messages: [{
    to: "test@exampletask.com",
    cc: [],
    bcc: [],
    from: "test@example.com",
    subject: "Test1",
    body: [
      {
        type: "html",
        text: "<h1>This is a test</h1>"
      }
    ]
  }]
 });

Update A MailBots Task Used to save data against the task, update content, followup time and more

const res = await mbClient.updateTask({
   task: {
    id: 1234,
    reference_email: {
      to: "newRecipient@exampletask.com"
    }
  }});

Archive A MailBots Task

Permanently Delete A MailBots Task

Trigger a MailBots Task

Resolve Natural Time Format (ex: {naturaltime}@ext.eml.bot)

Dispatch an email-based action for a task. (Equivalent to sending an action email.)

Create a new task event.

Get information about the currently logged in user

Validate webhook signature. Set verifyAge to false when testing / mocking HTTP requests. (Server side only)