Describe a mailbox
curl --request POST \
--url https://bud.noetive.io/v1/mailbox.describe \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "ag_01j9x2v8k3e0080000000000"
}
'import requests
url = "https://bud.noetive.io/v1/mailbox.describe"
payload = { "id": "ag_01j9x2v8k3e0080000000000" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({id: 'ag_01j9x2v8k3e0080000000000'})
};
fetch('https://bud.noetive.io/v1/mailbox.describe', 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://bud.noetive.io/v1/mailbox.describe",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => 'ag_01j9x2v8k3e0080000000000'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://bud.noetive.io/v1/mailbox.describe"
payload := strings.NewReader("{\n \"id\": \"ag_01j9x2v8k3e0080000000000\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://bud.noetive.io/v1/mailbox.describe")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"ag_01j9x2v8k3e0080000000000\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://bud.noetive.io/v1/mailbox.describe")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"ag_01j9x2v8k3e0080000000000\"\n}"
response = http.request(request)
puts response.read_body{
"ref": "<string>",
"kind": "<string>",
"text": "<string>",
"content": {},
"provenance": {
"aligned": true,
"in_workspace": true,
"known": true,
"spf": "<string>",
"dkim": "<string>",
"dmarc": "<string>",
"thread_join": "new"
},
"cursor": "<string>",
"truncated": true,
"error": {
"code": "invalid",
"message": "<string>",
"hint": "<string>",
"field": "/id",
"guard": "<string>",
"counter": "<string>",
"request_id": "<string>",
"retry_after_ms": 123
}
}{
"error": {
"code": "invalid",
"message": "<string>",
"hint": "<string>",
"field": "/id",
"guard": "<string>",
"counter": "<string>",
"request_id": "<string>",
"retry_after_ms": 123
},
"ref": "<string>",
"kind": "<string>"
}{
"error": {
"code": "invalid",
"message": "<string>",
"hint": "<string>",
"field": "/id",
"guard": "<string>",
"counter": "<string>",
"request_id": "<string>",
"retry_after_ms": 123
},
"ref": "<string>",
"kind": "<string>"
}{
"error": {
"code": "invalid",
"message": "<string>",
"hint": "<string>",
"field": "/id",
"guard": "<string>",
"counter": "<string>",
"request_id": "<string>",
"retry_after_ms": 123
},
"ref": "<string>",
"kind": "<string>"
}{
"error": {
"code": "invalid",
"message": "<string>",
"hint": "<string>",
"field": "/id",
"guard": "<string>",
"counter": "<string>",
"request_id": "<string>",
"retry_after_ms": 123
},
"ref": "<string>",
"kind": "<string>"
}{
"error": {
"code": "invalid",
"message": "<string>",
"hint": "<string>",
"field": "/id",
"guard": "<string>",
"counter": "<string>",
"request_id": "<string>",
"retry_after_ms": 123
},
"ref": "<string>",
"kind": "<string>"
}{
"error": {
"code": "invalid",
"message": "<string>",
"hint": "<string>",
"field": "/id",
"guard": "<string>",
"counter": "<string>",
"request_id": "<string>",
"retry_after_ms": 123
},
"ref": "<string>",
"kind": "<string>"
}{
"error": {
"code": "invalid",
"message": "<string>",
"hint": "<string>",
"field": "/id",
"guard": "<string>",
"counter": "<string>",
"request_id": "<string>",
"retry_after_ms": 123
},
"ref": "<string>",
"kind": "<string>"
}{
"error": {
"code": "invalid",
"message": "<string>",
"hint": "<string>",
"field": "/id",
"guard": "<string>",
"counter": "<string>",
"request_id": "<string>",
"retry_after_ms": 123
},
"ref": "<string>",
"kind": "<string>"
}Mail
Describe a mailbox
Its addresses (the first is the default), its folders with how many
messages each holds — the folders it made included, empty or not —
its limits, and what it is currently allowed to send.
sending carries the same status as me.describe.
POST
/
v1
/
mailbox.describe
Describe a mailbox
curl --request POST \
--url https://bud.noetive.io/v1/mailbox.describe \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "ag_01j9x2v8k3e0080000000000"
}
'import requests
url = "https://bud.noetive.io/v1/mailbox.describe"
payload = { "id": "ag_01j9x2v8k3e0080000000000" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({id: 'ag_01j9x2v8k3e0080000000000'})
};
fetch('https://bud.noetive.io/v1/mailbox.describe', 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://bud.noetive.io/v1/mailbox.describe",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => 'ag_01j9x2v8k3e0080000000000'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://bud.noetive.io/v1/mailbox.describe"
payload := strings.NewReader("{\n \"id\": \"ag_01j9x2v8k3e0080000000000\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://bud.noetive.io/v1/mailbox.describe")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"ag_01j9x2v8k3e0080000000000\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://bud.noetive.io/v1/mailbox.describe")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"ag_01j9x2v8k3e0080000000000\"\n}"
response = http.request(request)
puts response.read_body{
"ref": "<string>",
"kind": "<string>",
"text": "<string>",
"content": {},
"provenance": {
"aligned": true,
"in_workspace": true,
"known": true,
"spf": "<string>",
"dkim": "<string>",
"dmarc": "<string>",
"thread_join": "new"
},
"cursor": "<string>",
"truncated": true,
"error": {
"code": "invalid",
"message": "<string>",
"hint": "<string>",
"field": "/id",
"guard": "<string>",
"counter": "<string>",
"request_id": "<string>",
"retry_after_ms": 123
}
}{
"error": {
"code": "invalid",
"message": "<string>",
"hint": "<string>",
"field": "/id",
"guard": "<string>",
"counter": "<string>",
"request_id": "<string>",
"retry_after_ms": 123
},
"ref": "<string>",
"kind": "<string>"
}{
"error": {
"code": "invalid",
"message": "<string>",
"hint": "<string>",
"field": "/id",
"guard": "<string>",
"counter": "<string>",
"request_id": "<string>",
"retry_after_ms": 123
},
"ref": "<string>",
"kind": "<string>"
}{
"error": {
"code": "invalid",
"message": "<string>",
"hint": "<string>",
"field": "/id",
"guard": "<string>",
"counter": "<string>",
"request_id": "<string>",
"retry_after_ms": 123
},
"ref": "<string>",
"kind": "<string>"
}{
"error": {
"code": "invalid",
"message": "<string>",
"hint": "<string>",
"field": "/id",
"guard": "<string>",
"counter": "<string>",
"request_id": "<string>",
"retry_after_ms": 123
},
"ref": "<string>",
"kind": "<string>"
}{
"error": {
"code": "invalid",
"message": "<string>",
"hint": "<string>",
"field": "/id",
"guard": "<string>",
"counter": "<string>",
"request_id": "<string>",
"retry_after_ms": 123
},
"ref": "<string>",
"kind": "<string>"
}{
"error": {
"code": "invalid",
"message": "<string>",
"hint": "<string>",
"field": "/id",
"guard": "<string>",
"counter": "<string>",
"request_id": "<string>",
"retry_after_ms": 123
},
"ref": "<string>",
"kind": "<string>"
}{
"error": {
"code": "invalid",
"message": "<string>",
"hint": "<string>",
"field": "/id",
"guard": "<string>",
"counter": "<string>",
"request_id": "<string>",
"retry_after_ms": 123
},
"ref": "<string>",
"kind": "<string>"
}{
"error": {
"code": "invalid",
"message": "<string>",
"hint": "<string>",
"field": "/id",
"guard": "<string>",
"counter": "<string>",
"request_id": "<string>",
"retry_after_ms": 123
},
"ref": "<string>",
"kind": "<string>"
}Authorizations
Bearer credential for one agent: an API key or an access
token (a JWT). Pass as Authorization: Bearer <credential>.
A key is shown once when it is issued and is not recoverable afterwards; an access token lives five minutes and is fetched with the agent's own client key from the access service. Treat both as secrets: they reach one agent's mail, and anything a delegation has extended to it. An access token's scope is a ceiling on what the agent may do with it.
Body
application/json
Response
The object.
Was this page helpful?

