Get a mailbox

GET

api

mailboxes

{id}

TypeScript

import Inbound from "inboundemail";

const inbound = new Inbound();
const result = await inbound.mailboxes.retrieve("<mailboxId>");

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://inbound.new/api/e2/mailboxes/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://inbound.new/api/e2/mailboxes/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://inbound.new/api/e2/mailboxes/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://inbound.new/api/e2/mailboxes/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "loginAddress": "<string>",
  "accessMode": "read",
  "sendingMode": "identity",
  "sendingName": "<string>",
  "sendingAddress": "<string>",
  "allowedSendingDomains": [
    "<string>"
  ],
  "scopes": [
    {
      "type": "domain",
      "domain": "<string>",
      "address": "<string>"
    }
  ],
  "protocols": {
    "imap": true,
    "smtp": true,
    "api": true
  },
  "allowedIps": [
    "<string>"
  ],
  "storageQuotaBytes": 123,
  "dailySendLimit": 0,
  "selfService": {
    "filters": true,
    "spam": true,
    "password": true,
    "activity": true
  },
  "unreadCount": 123,
  "authenticatedAs": "account"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

Authorization

string

header

required

Your Inbound API key. Include it in the Authorization header as: Bearer

Path Parameters

string

required

Response

Response for status 200

string

required

accessMode

enum<string>

required

Available options:

read,

read_write

sendingMode

enum<string>

required

Available options:

identity,

scoped_domains

sendingName

string · null · null

required

sendingAddress

string · null · null

required

allowedSendingDomains

string[]

required

scopes

object[]

required

Show child attributes

protocols

object

required

Show child attributes

allowedIps

string[]

required

storageQuotaBytes

number · null · null

required

dailySendLimit

default:0

required

selfService

object

required

Show child attributes

unreadCount

number

required

authenticatedAs

enum<string>

required

Available options:

account,

mailbox

TypeScript

import Inbound from "inboundemail";

const inbound = new Inbound();
const result = await inbound.mailboxes.retrieve("<mailboxId>");

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://inbound.new/api/e2/mailboxes/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://inbound.new/api/e2/mailboxes/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://inbound.new/api/e2/mailboxes/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://inbound.new/api/e2/mailboxes/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "loginAddress": "<string>",
  "accessMode": "read",
  "sendingMode": "identity",
  "sendingName": "<string>",
  "sendingAddress": "<string>",
  "allowedSendingDomains": [
    "<string>"
  ],
  "scopes": [
    {
      "type": "domain",
      "domain": "<string>",
      "address": "<string>"
    }
  ],
  "protocols": {
    "imap": true,
    "smtp": true,
    "api": true
  },
  "allowedIps": [
    "<string>"
  ],
  "storageQuotaBytes": 123,
  "dailySendLimit": 0,
  "selfService": {
    "filters": true,
    "spam": true,
    "password": true,
    "activity": true
  },
  "unreadCount": 123,
  "authenticatedAs": "account"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Overview

Domains

Endpoints

Email Addresses

Attachments

Authentication

Emails

Inbox

Mailboxes

Spam Filter

Guard

Webhooks

Authorizations

Path Parameters

Response