Quickstart

​

Web Application

​

1. Create an Inbox

An inbox is an email address that you can receive emails on. You can create an inbox by going to the inboxes page.

​

2. Send an Email to Your Inbox

Unless you have specific allow and block rules that prevent it, you will receive an email from support@inbox.botmailroom.com after you create an inbox for the first time. If you’d like to send a test email to your inbox, you can do so by sending a test email to the address of the inbox:

1. Using a mail client of your choice.
2. Sending a request with BotMailRoom

Once you receive an email, you should see it in the emails page.

And that's it! You can now do things like:

• Build an Email Agent
  • Python
  • TypeScript
• Send Emails
• Setup Custom Authentication Rules
• Receive Emails via Webhook
• Use a Custom Domain

​

REST API

​

1. Create an Api Key (if you don’t already have one)

Create an api key by going to the api keys page. You can also click the Create Your First Api Key button in the sidebar or navigate to the api keys page by clicking Settings, under the user dropdown at the bottom of the sidebar.

​

2. Create an Inbox

Send a request to the upsert inbox endpoint to create an inbox. The below is an example of how to do this in bash, but the linked documentation also contains examples in other languages.

curl -X POST "https://api.botmailroom.com/api/v1/inbox/upsert" \
     -H "Authorization: Bearer ${api_key}" \
     -H "Content-Type: application/json" \
     -d '{
        "id": None,
        "name": "My First Inbox",
        "email_address": "CHANGE_THIS@inbox.botmailroom.com",
    }'

​

3. Send an Email to Your Inbox

Unless you have specific allow and block rules that prevent it, you will receive an email from support@inbox.botmailroom.com after you create an inbox for the first time. If you’d like to send a test email to your inbox, you can do so by sending a test email to the address of the inbox:

1. Using a mail client of your choice.
2. Sending a request with BotMailRoom

After sending the email, send a request to the get emails endpoint to get the metadata of the email you just sent. The below is an example of how to do this in bash, but the linked documentation also contains examples in other languages.

curl -X GET "https://api.botmailroom.com/api/v1/email" \
     -H "Authorization: Bearer ${api_key}"

And that's it! You can now do things like:

• Build an Email Agent
  • Python
  • TypeScript
• Send Emails
• Setup Custom Authentication Rules
• Receive Emails via Webhook
• Use a Custom Domain

​

Python Client

The BotMailRoom python client provides both a synchronous and asynchronous interface for interacting with the BotMailRoom API.

​

1. Create an Api Key (if you don’t already have one)

Create an api key by going to the api keys page. You can also click the Create Your First Api Key button in the sidebar or navigate to the api keys page by clicking Settings, under the user dropdown at the bottom of the sidebar.

​

2. Install the Client

pip install botmailroom

​

3. Initialize the Client

from botmailroom import BotMailRoom

client = BotMailRoom(api_key="your_api_key") # or set the BOTMAILROOM_API_KEY environment variable

​

4. Create an Inbox

inbox = client.create_inbox(name="My Inbox", email_address="CHANGE_THIS@inbox.botmailroom.com")

​

5. Check Emails

Unless you have specific allow and block rules that prevent it, you will receive an email from support@inbox.botmailroom.com after you create an inbox for the first time. If you’d like to send a test email to your inbox, you can do so by sending a test email to the address of the inbox:

1. Using a mail client of your choice.
2. Sending a request with BotMailRoom

You can then check for new emails using the get_emails method.

emails = client.get_emails(inbox_ids=[inbox.id])
print(emails)

​

TypeScript Client

The BotMailRoom TypeScript client provides an interface for interacting with the BotMailRoom API.

​

1. Create an Api Key (if you don’t already have one)

Create an api key by going to the api keys page. You can also click the Create Your First Api Key button in the sidebar or navigate to the api keys page by clicking Settings, under the user dropdown at the bottom of the sidebar.

​

2. Install the Client

npm install botmailroom
# or
yarn add botmailroom

​

3. Initialize the Client

import { BotMailRoom } from "botmailroom";

const client = new BotMailRoom("your_api_key"); // or set the BOTMAILROOM_API_KEY environment variable

​

4. Create an Inbox

const inbox = await client.createInbox({
  name: "My Inbox",
  emailAddress: "CHANGE_THIS@inbox.botmailroom.com",
});

​

5. Check Emails

Unless you have specific allow and block rules that prevent it, you will receive an email from support@inbox.botmailroom.com after you create an inbox for the first time. If you’d like to send a test email to your inbox, you can do so by sending a test email to the address of the inbox:

1. Using a mail client of your choice.
2. Sending a request with BotMailRoom

You can then check for new emails using the getEmails method.

const emails = await client.getEmails({
  inboxIds: [inbox.id],
});
console.log(emails);