Emails (API) | Inbox Manager API 文件

Email endpoints

GET/api/accounts/{account_id}/emails

List stored email records for an account. More Email Ingestion & Delivery

Responses

200application/json

schemaobject

dataarrayrequired

itemEmailMessagerequired

Stored email metadata and envelope details for inbound sync and outbound delivery records.

idstringrequired

Email message identifier.

account_idstringrequired

Account identifier.

application_idstringrequired

Application identifier.

credential_idstring | nullrequired

Provider credential identifier.

directionrequired

folderstring | nullrequired

provider_message_idstring | nullrequired

thread_idstring | nullrequired

subjectstring | nullrequired

from_jsonarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

to_jsonarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

cc_jsonarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

bcc_jsonarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

headers_jsonobjectrequired

snippetstring | nullrequired

staterequired

received_atstring | nullrequired

sent_atstring | nullrequired

created_bystringrequired

User identifier.

updated_bystringrequired

User identifier.

created_atstringrequired

updated_atstringrequired

deleted_atstring | nullrequired

meta

linksobjectrequired

selfstringrequired

URL of the current page

nextstring

URL of the next page

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/accounts/acc123/emails?limit=20&offset=0" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/accounts/acc123/emails?limit=20&offset=0";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/accounts/acc123/emails?limit=20&offset=0";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/emails?limit=20&offset=0",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/emails?limit=20&offset=0",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/accounts/acc123/emails?limit=20&offset=0", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/accounts/acc123/emails?limit=20&offset=0", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/accounts/acc123/emails?limit=20&offset=0", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/accounts/acc123/emails?limit=20&offset=0", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/accounts/acc123/emails?limit=20&offset=0")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/accounts/acc123/emails?limit=20&offset=0", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/accounts/acc123/emails?limit=20&offset=0");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/emails

Create a stored email record and optional body/attachment metadata. More Email Ingestion & Delivery

Body application/json

credential_idstring | null

Provider credential identifier.

directionrequired

available_atstring · date-time | null

folderstring | null

provider_message_idstring | null

thread_idstring | null

subjectstring | null

from_jsonarray

itemobjectrequired

namestring | null

addressstringrequired

to_jsonarray

itemobjectrequired

namestring | null

addressstringrequired

cc_jsonarray

itemobjectrequired

namestring | null

addressstringrequired

bcc_jsonarray

itemobjectrequired

namestring | null

addressstringrequired

headers_jsonobject

snippetstring | null

text_bodystring | null

html_bodystring | null

attachmentsarray

itemobjectrequired

filenamestringrequired

content_typestringrequired

content_b64stringrequired

disposition

content_idstring | null

state

received_atstring | null

sent_atstring | null

Responses

201application/json

Created

schemaobject

dataEmailMessagerequired

Stored email metadata and envelope details for inbound sync and outbound delivery records.

idstringrequired

Email message identifier.

account_idstringrequired

Account identifier.

application_idstringrequired

Application identifier.

credential_idstring | nullrequired

Provider credential identifier.

directionrequired

folderstring | nullrequired

provider_message_idstring | nullrequired

thread_idstring | nullrequired

subjectstring | nullrequired

from_jsonarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

to_jsonarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

cc_jsonarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

bcc_jsonarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

headers_jsonobjectrequired

snippetstring | nullrequired

staterequired

received_atstring | nullrequired

sent_atstring | nullrequired

created_bystringrequired

User identifier.

updated_bystringrequired

User identifier.

created_atstringrequired

updated_atstringrequired

deleted_atstring | nullrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/emails" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"credential_id":"value","direction":"inbound","available_at":"value","folder":"value","provider_message_id":"value","thread_id":"value","subject":"value","from_json":[{"name":"value","address":"string"}],"to_json":[{"name":"value","address":"string"}],"cc_json":[{"name":"value","address":"string"}],"bcc_json":[{"name":"value","address":"string"}],"headers_json":{},"snippet":"value","text_body":"value","html_body":"value","attachments":[{"filename":"string","content_type":"string","content_b64":"string","disposition":"value","content_id":"value"}],"state":"pending","received_at":"value","sent_at":"value"}'

const payload = {"credential_id":"value","direction":"inbound","available_at":"value","folder":"value","provider_message_id":"value","thread_id":"value","subject":"value","from_json":[{"name":"value","address":"string"}],"to_json":[{"name":"value","address":"string"}],"cc_json":[{"name":"value","address":"string"}],"bcc_json":[{"name":"value","address":"string"}],"headers_json":{},"snippet":"value","text_body":"value","html_body":"value","attachments":[{"filename":"string","content_type":"string","content_b64":"string","disposition":"value","content_id":"value"}],"state":"pending","received_at":"value","sent_at":"value"};
const url = "${BASE_URL}/api/accounts/acc123/emails";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"credential_id":"value","direction":"inbound","available_at":"value","folder":"value","provider_message_id":"value","thread_id":"value","subject":"value","from_json":[{"name":"value","address":"string"}],"to_json":[{"name":"value","address":"string"}],"cc_json":[{"name":"value","address":"string"}],"bcc_json":[{"name":"value","address":"string"}],"headers_json":{},"snippet":"value","text_body":"value","html_body":"value","attachments":[{"filename":"string","content_type":"string","content_b64":"string","disposition":"value","content_id":"value"}],"state":"pending","received_at":"value","sent_at":"value"};
const url = "${BASE_URL}/api/accounts/acc123/emails";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"credential_id":"value","direction":"inbound","available_at":"value","folder":"value","provider_message_id":"value","thread_id":"value","subject":"value","from_json":[{"name":"value","address":"string"}],"to_json":[{"name":"value","address":"string"}],"cc_json":[{"name":"value","address":"string"}],"bcc_json":[{"name":"value","address":"string"}],"headers_json":{},"snippet":"value","text_body":"value","html_body":"value","attachments":[{"filename":"string","content_type":"string","content_b64":"string","disposition":"value","content_id":"value"}],"state":"pending","received_at":"value","sent_at":"value"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/emails",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"credential_id":"value","direction":"inbound","available_at":"value","folder":"value","provider_message_id":"value","thread_id":"value","subject":"value","from_json":[{"name":"value","address":"string"}],"to_json":[{"name":"value","address":"string"}],"cc_json":[{"name":"value","address":"string"}],"bcc_json":[{"name":"value","address":"string"}],"headers_json":{},"snippet":"value","text_body":"value","html_body":"value","attachments":[{"filename":"string","content_type":"string","content_b64":"string","disposition":"value","content_id":"value"}],"state":"pending","received_at":"value","sent_at":"value"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/emails",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"credential_id":"value","direction":"inbound","available_at":"value","folder":"value","provider_message_id":"value","thread_id":"value","subject":"value","from_json":[{"name":"value","address":"string"}],"to_json":[{"name":"value","address":"string"}],"cc_json":[{"name":"value","address":"string"}],"bcc_json":[{"name":"value","address":"string"}],"headers_json":{},"snippet":"value","text_body":"value","html_body":"value","attachments":[{"filename":"string","content_type":"string","content_b64":"string","disposition":"value","content_id":"value"}],"state":"pending","received_at":"value","sent_at":"value"};
const { body } = await request("${BASE_URL}/api/accounts/acc123/emails", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"credential_id":"value","direction":"inbound","available_at":"value","folder":"value","provider_message_id":"value","thread_id":"value","subject":"value","from_json":[{"name":"value","address":"string"}],"to_json":[{"name":"value","address":"string"}],"cc_json":[{"name":"value","address":"string"}],"bcc_json":[{"name":"value","address":"string"}],"headers_json":{},"snippet":"value","text_body":"value","html_body":"value","attachments":[{"filename":"string","content_type":"string","content_b64":"string","disposition":"value","content_id":"value"}],"state":"pending","received_at":"value","sent_at":"value"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/emails", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"credential_id":"value","direction":"inbound","available_at":"value","folder":"value","provider_message_id":"value","thread_id":"value","subject":"value","from_json":[{"name":"value","address":"string"}],"to_json":[{"name":"value","address":"string"}],"cc_json":[{"name":"value","address":"string"}],"bcc_json":[{"name":"value","address":"string"}],"headers_json":{},"snippet":"value","text_body":"value","html_body":"value","attachments":[{"filename":"string","content_type":"string","content_b64":"string","disposition":"value","content_id":"value"}],"state":"pending","received_at":"value","sent_at":"value"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/emails", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"credential_id":"value","direction":"inbound","available_at":"value","folder":"value","provider_message_id":"value","thread_id":"value","subject":"value","from_json":[{"name":"value","address":"string"}],"to_json":[{"name":"value","address":"string"}],"cc_json":[{"name":"value","address":"string"}],"bcc_json":[{"name":"value","address":"string"}],"headers_json":{},"snippet":"value","text_body":"value","html_body":"value","attachments":[{"filename":"string","content_type":"string","content_b64":"string","disposition":"value","content_id":"value"}],"state":"pending","received_at":"value","sent_at":"value"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/emails", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"credential_id":"value","direction":"inbound","available_at":"value","folder":"value","provider_message_id":"value","thread_id":"value","subject":"value","from_json":[{"name":"value","address":"string"}],"to_json":[{"name":"value","address":"string"}],"cc_json":[{"name":"value","address":"string"}],"bcc_json":[{"name":"value","address":"string"}],"headers_json":{},"snippet":"value","text_body":"value","html_body":"value","attachments":[{"filename":"string","content_type":"string","content_b64":"string","disposition":"value","content_id":"value"}],"state":"pending","received_at":"value","sent_at":"value"}
uri = URI("${BASE_URL}/api/accounts/acc123/emails")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"credential_id":"value","direction":"inbound","available_at":"value","folder":"value","provider_message_id":"value","thread_id":"value","subject":"value","from_json":[{"name":"value","address":"string"}],"to_json":[{"name":"value","address":"string"}],"cc_json":[{"name":"value","address":"string"}],"bcc_json":[{"name":"value","address":"string"}],"headers_json":{},"snippet":"value","text_body":"value","html_body":"value","attachments":[{"filename":"string","content_type":"string","content_b64":"string","disposition":"value","content_id":"value"}],"state":"pending","received_at":"value","sent_at":"value"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/emails", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/emails");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"credential_id\":\"value\",\"direction\":\"inbound\",\"available_at\":\"value\",\"folder\":\"value\",\"provider_message_id\":\"value\",\"thread_id\":\"value\",\"subject\":\"value\",\"from_json\":[{\"name\":\"value\",\"address\":\"string\"}],\"to_json\":[{\"name\":\"value\",\"address\":\"string\"}],\"cc_json\":[{\"name\":\"value\",\"address\":\"string\"}],\"bcc_json\":[{\"name\":\"value\",\"address\":\"string\"}],\"headers_json\":{},\"snippet\":\"value\",\"text_body\":\"value\",\"html_body\":\"value\",\"attachments\":[{\"filename\":\"string\",\"content_type\":\"string\",\"content_b64\":\"string\",\"disposition\":\"value\",\"content_id\":\"value\"}],\"state\":\"pending\",\"received_at\":\"value\",\"sent_at\":\"value\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/accounts/{account_id}/emails/{email_id}/body

Fetch normalized text/html body plus embedded and attachment payloads. More Email Ingestion & Delivery

Responses

200application/json

schemaobject

dataobjectrequired

subjectstring | nullrequired

from_jsonarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

to_jsonarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

cc_jsonarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

bcc_jsonarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

textstring | nullrequired

htmlstring | nullrequired

headers_jsonobjectrequired

embedded_partsarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

attachmentsarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/accounts/acc123/emails/iem123/body" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/accounts/acc123/emails/iem123/body";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/accounts/acc123/emails/iem123/body";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/emails/iem123/body",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/emails/iem123/body",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/accounts/acc123/emails/iem123/body", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/accounts/acc123/emails/iem123/body", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/accounts/acc123/emails/iem123/body", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/accounts/acc123/emails/iem123/body", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/accounts/acc123/emails/iem123/body")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/accounts/acc123/emails/iem123/body", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/accounts/acc123/emails/iem123/body");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/accounts/{account_id}/emails/{email_id}/parts

List attachment and embedded-part metadata for an email. More Email Ingestion & Delivery

Responses

200application/json

schemaobject

dataarrayrequired

itemEmailMessagePartrequired

Metadata for a persisted embedded part or attachment belonging to a stored email message.

idstringrequired

Email message part identifier.

email_idstringrequired

Email message identifier.

account_idstringrequired

Account identifier.

application_idstringrequired

Application identifier.

kindrequired

ordinalintegerrequired

filenamestring | nullrequired

content_typestringrequired

dispositionstring | nullrequired

content_idstring | nullrequired

sizeintegerrequired

content_sha256string | nullrequired

created_atstringrequired

updated_atstringrequired

meta

linksobjectrequired

selfstringrequired

URL of the current page

nextstring

URL of the next page

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/accounts/acc123/emails/iem123/parts" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/accounts/acc123/emails/iem123/parts";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/accounts/acc123/emails/iem123/parts";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/emails/iem123/parts",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/emails/iem123/parts",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/accounts/acc123/emails/iem123/parts", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/accounts/acc123/emails/iem123/parts", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/accounts/acc123/emails/iem123/parts", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/accounts/acc123/emails/iem123/parts", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/accounts/acc123/emails/iem123/parts")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/accounts/acc123/emails/iem123/parts", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/accounts/acc123/emails/iem123/parts");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/accounts/{account_id}/emails/{email_id}/parts/{part_id}/content

Fetch decoded content for a specific stored email part. More Email Ingestion & Delivery

Responses

200application/json

schemaobject

dataEmailMessagePartContentrequired

Full content payload for a stored email part.

idstringrequired

Email message part identifier.

email_idstringrequired

Email message identifier.

kindrequired

ordinalintegerrequired

filenamestring | nullrequired

content_typestringrequired

dispositionstring | nullrequired

content_idstring | nullrequired

sizeintegerrequired

content_sha256string | nullrequired

content_b64stringrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/accounts/acc123/emails/iem123/parts/iap123/content" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/accounts/acc123/emails/iem123/parts/iap123/content";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/accounts/acc123/emails/iem123/parts/iap123/content";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/emails/iem123/parts/iap123/content",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/emails/iem123/parts/iap123/content",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/accounts/acc123/emails/iem123/parts/iap123/content", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/accounts/acc123/emails/iem123/parts/iap123/content", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/accounts/acc123/emails/iem123/parts/iap123/content", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/accounts/acc123/emails/iem123/parts/iap123/content", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/accounts/acc123/emails/iem123/parts/iap123/content")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/accounts/acc123/emails/iem123/parts/iap123/content", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/accounts/acc123/emails/iem123/parts/iap123/content");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/emails/{email_id}/parts/search

Search attachment and embedded-part metadata for an email by query expression with optional kind filter. More Email Ingestion & Delivery

Body application/json

querystringrequired

kind

limitinteger

offsetinteger

Responses

200application/json

schemaobject

dataarrayrequired

itemEmailMessagePartrequired

Metadata for a persisted embedded part or attachment belonging to a stored email message.

idstringrequired

Email message part identifier.

email_idstringrequired

Email message identifier.

account_idstringrequired

Account identifier.

application_idstringrequired

Application identifier.

kindrequired

ordinalintegerrequired

filenamestring | nullrequired

content_typestringrequired

dispositionstring | nullrequired

content_idstring | nullrequired

sizeintegerrequired

content_sha256string | nullrequired

created_atstringrequired

updated_atstringrequired

meta

linksobjectrequired

selfstringrequired

URL of the current page

nextstring

URL of the next page

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/emails/iem123/parts/search" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"query":"string","kind":"embedded","limit":123,"offset":123}'

const payload = {"query":"string","kind":"embedded","limit":123,"offset":123};
const url = "${BASE_URL}/api/accounts/acc123/emails/iem123/parts/search";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"query":"string","kind":"embedded","limit":123,"offset":123};
const url = "${BASE_URL}/api/accounts/acc123/emails/iem123/parts/search";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"query":"string","kind":"embedded","limit":123,"offset":123};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/emails/iem123/parts/search",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"query":"string","kind":"embedded","limit":123,"offset":123};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/emails/iem123/parts/search",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"query":"string","kind":"embedded","limit":123,"offset":123};
const { body } = await request("${BASE_URL}/api/accounts/acc123/emails/iem123/parts/search", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"query":"string","kind":"embedded","limit":123,"offset":123}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/emails/iem123/parts/search", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"query":"string","kind":"embedded","limit":123,"offset":123}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/emails/iem123/parts/search", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"query":"string","kind":"embedded","limit":123,"offset":123}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/emails/iem123/parts/search", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"query":"string","kind":"embedded","limit":123,"offset":123}
uri = URI("${BASE_URL}/api/accounts/acc123/emails/iem123/parts/search")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"query":"string","kind":"embedded","limit":123,"offset":123};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/emails/iem123/parts/search", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/emails/iem123/parts/search");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"query\":\"string\",\"kind\":\"embedded\",\"limit\":123,\"offset\":123}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/emails/search

Search stored email records by query expression. More Email Ingestion & Delivery

Body application/json

querystringrequired

limitinteger

offsetinteger

Responses

200application/json

schemaobject

dataarrayrequired

itemEmailMessagerequired

Stored email metadata and envelope details for inbound sync and outbound delivery records.

idstringrequired

Email message identifier.

account_idstringrequired

Account identifier.

application_idstringrequired

Application identifier.

credential_idstring | nullrequired

Provider credential identifier.

directionrequired

folderstring | nullrequired

provider_message_idstring | nullrequired

thread_idstring | nullrequired

subjectstring | nullrequired

from_jsonarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

to_jsonarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

cc_jsonarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

bcc_jsonarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

headers_jsonobjectrequired

snippetstring | nullrequired

staterequired

received_atstring | nullrequired

sent_atstring | nullrequired

created_bystringrequired

User identifier.

updated_bystringrequired

User identifier.

created_atstringrequired

updated_atstringrequired

deleted_atstring | nullrequired

meta

linksobjectrequired

selfstringrequired

URL of the current page

nextstring

URL of the next page

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/emails/search" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"query":"string","limit":123,"offset":123}'

const payload = {"query":"string","limit":123,"offset":123};
const url = "${BASE_URL}/api/accounts/acc123/emails/search";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"query":"string","limit":123,"offset":123};
const url = "${BASE_URL}/api/accounts/acc123/emails/search";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"query":"string","limit":123,"offset":123};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/emails/search",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"query":"string","limit":123,"offset":123};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/emails/search",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"query":"string","limit":123,"offset":123};
const { body } = await request("${BASE_URL}/api/accounts/acc123/emails/search", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"query":"string","limit":123,"offset":123}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/emails/search", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"query":"string","limit":123,"offset":123}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/emails/search", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"query":"string","limit":123,"offset":123}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/emails/search", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"query":"string","limit":123,"offset":123}
uri = URI("${BASE_URL}/api/accounts/acc123/emails/search")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"query":"string","limit":123,"offset":123};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/emails/search", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/emails/search");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"query\":\"string\",\"limit\":123,\"offset\":123}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/emails/search-delete

Delete emails selected by query with optional dry-run confirmation. More Email Ingestion & Delivery

Body application/json

querystringrequired

dry_runboolean

confirmboolean

limitinteger

older_thanstring · date-timerequired

Responses

200application/json

schemaobject

dataobjectrequired

deleted_countintegerrequired

deleted_idsarrayrequired

itemstringrequired

dry_runbooleanrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/emails/search-delete" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"query":"string","dry_run":true,"confirm":true,"limit":123,"older_than":"string"}'

const payload = {"query":"string","dry_run":true,"confirm":true,"limit":123,"older_than":"string"};
const url = "${BASE_URL}/api/accounts/acc123/emails/search-delete";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"query":"string","dry_run":true,"confirm":true,"limit":123,"older_than":"string"};
const url = "${BASE_URL}/api/accounts/acc123/emails/search-delete";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"query":"string","dry_run":true,"confirm":true,"limit":123,"older_than":"string"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/emails/search-delete",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"query":"string","dry_run":true,"confirm":true,"limit":123,"older_than":"string"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/emails/search-delete",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"query":"string","dry_run":true,"confirm":true,"limit":123,"older_than":"string"};
const { body } = await request("${BASE_URL}/api/accounts/acc123/emails/search-delete", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"query":"string","dry_run":true,"confirm":true,"limit":123,"older_than":"string"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/emails/search-delete", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"query":"string","dry_run":true,"confirm":true,"limit":123,"older_than":"string"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/emails/search-delete", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"query":"string","dry_run":true,"confirm":true,"limit":123,"older_than":"string"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/emails/search-delete", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"query":"string","dry_run":true,"confirm":true,"limit":123,"older_than":"string"}
uri = URI("${BASE_URL}/api/accounts/acc123/emails/search-delete")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"query":"string","dry_run":true,"confirm":true,"limit":123,"older_than":"string"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/emails/search-delete", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/emails/search-delete");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"query\":\"string\",\"dry_run\":true,\"confirm\":true,\"limit\":123,\"older_than\":\"string\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/imap/sync-mailboxes

Queue mailbox discovery for a provider credential. More Email Ingestion & Delivery

Body application/json

credential_idstringrequired

Provider credential identifier.

Responses

202application/json

Accepted

schemaobject

dataobjectrequired

statusrequired

task_idstringrequired

Task identifier.

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/imap/sync-mailboxes" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"credential_id":"string"}'

const payload = {"credential_id":"string"};
const url = "${BASE_URL}/api/accounts/acc123/imap/sync-mailboxes";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"credential_id":"string"};
const url = "${BASE_URL}/api/accounts/acc123/imap/sync-mailboxes";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"credential_id":"string"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/imap/sync-mailboxes",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"credential_id":"string"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/imap/sync-mailboxes",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"credential_id":"string"};
const { body } = await request("${BASE_URL}/api/accounts/acc123/imap/sync-mailboxes", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"credential_id":"string"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/imap/sync-mailboxes", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"credential_id":"string"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/imap/sync-mailboxes", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"credential_id":"string"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/imap/sync-mailboxes", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"credential_id":"string"}
uri = URI("${BASE_URL}/api/accounts/acc123/imap/sync-mailboxes")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"credential_id":"string"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/imap/sync-mailboxes", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/imap/sync-mailboxes");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"credential_id\":\"string\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/imap/sync-messages

Queue message synchronization for a provider credential and folder scope. More Email Ingestion & Delivery

Body application/json

credential_idstringrequired

Provider credential identifier.

folderstring | null

available_atstring · date-time | null

repeat_interval_secondsinteger | null

repeat_runsinteger | null

Responses

202application/json

Accepted

schemaobject

dataobjectrequired

statusrequired

task_idstringrequired

Task identifier.

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/imap/sync-messages" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"credential_id":"string","folder":"value","available_at":"value","repeat_interval_seconds":"value","repeat_runs":"value"}'

const payload = {"credential_id":"string","folder":"value","available_at":"value","repeat_interval_seconds":"value","repeat_runs":"value"};
const url = "${BASE_URL}/api/accounts/acc123/imap/sync-messages";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"credential_id":"string","folder":"value","available_at":"value","repeat_interval_seconds":"value","repeat_runs":"value"};
const url = "${BASE_URL}/api/accounts/acc123/imap/sync-messages";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"credential_id":"string","folder":"value","available_at":"value","repeat_interval_seconds":"value","repeat_runs":"value"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/imap/sync-messages",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"credential_id":"string","folder":"value","available_at":"value","repeat_interval_seconds":"value","repeat_runs":"value"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/imap/sync-messages",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"credential_id":"string","folder":"value","available_at":"value","repeat_interval_seconds":"value","repeat_runs":"value"};
const { body } = await request("${BASE_URL}/api/accounts/acc123/imap/sync-messages", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"credential_id":"string","folder":"value","available_at":"value","repeat_interval_seconds":"value","repeat_runs":"value"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/imap/sync-messages", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"credential_id":"string","folder":"value","available_at":"value","repeat_interval_seconds":"value","repeat_runs":"value"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/imap/sync-messages", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"credential_id":"string","folder":"value","available_at":"value","repeat_interval_seconds":"value","repeat_runs":"value"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/imap/sync-messages", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"credential_id":"string","folder":"value","available_at":"value","repeat_interval_seconds":"value","repeat_runs":"value"}
uri = URI("${BASE_URL}/api/accounts/acc123/imap/sync-messages")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"credential_id":"string","folder":"value","available_at":"value","repeat_interval_seconds":"value","repeat_runs":"value"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/imap/sync-messages", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/imap/sync-messages");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"credential_id\":\"string\",\"folder\":\"value\",\"available_at\":\"value\",\"repeat_interval_seconds\":\"value\",\"repeat_runs\":\"value\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/smtp/messages

Queue outbound SMTP message delivery. More Email Ingestion & Delivery

Body application/json

credential_idstringrequired

Provider credential identifier.

directionrequired

available_atstring · date-time | null

folderstring | null

provider_message_idstring | null

thread_idstring | null

subjectstring | null

from_jsonarray

itemobjectrequired

namestring | null

addressstringrequired

to_jsonarray

itemobjectrequired

namestring | null

addressstringrequired

cc_jsonarray

itemobjectrequired

namestring | null

addressstringrequired

bcc_jsonarray

itemobjectrequired

namestring | null

addressstringrequired

headers_jsonobject

snippetstring | null

text_bodystring | null

html_bodystring | null

attachmentsarray

itemobjectrequired

filenamestringrequired

content_typestringrequired

content_b64stringrequired

disposition

content_idstring | null

state

received_atstring | null

sent_atstring | null

Responses

202application/json

Accepted

schemaobject

dataobjectrequired

statusrequired

task_idstringrequired

Task identifier.

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/smtp/messages" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"credential_id":"string","direction":"value","available_at":"value","folder":"value","provider_message_id":"value","thread_id":"value","subject":"value","from_json":[{"name":"value","address":"string"}],"to_json":[{"name":"value","address":"string"}],"cc_json":[{"name":"value","address":"string"}],"bcc_json":[{"name":"value","address":"string"}],"headers_json":{},"snippet":"value","text_body":"value","html_body":"value","attachments":[{"filename":"string","content_type":"string","content_b64":"string","disposition":"value","content_id":"value"}],"state":"pending","received_at":"value","sent_at":"value"}'

const payload = {"credential_id":"string","direction":"value","available_at":"value","folder":"value","provider_message_id":"value","thread_id":"value","subject":"value","from_json":[{"name":"value","address":"string"}],"to_json":[{"name":"value","address":"string"}],"cc_json":[{"name":"value","address":"string"}],"bcc_json":[{"name":"value","address":"string"}],"headers_json":{},"snippet":"value","text_body":"value","html_body":"value","attachments":[{"filename":"string","content_type":"string","content_b64":"string","disposition":"value","content_id":"value"}],"state":"pending","received_at":"value","sent_at":"value"};
const url = "${BASE_URL}/api/accounts/acc123/smtp/messages";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"credential_id":"string","direction":"value","available_at":"value","folder":"value","provider_message_id":"value","thread_id":"value","subject":"value","from_json":[{"name":"value","address":"string"}],"to_json":[{"name":"value","address":"string"}],"cc_json":[{"name":"value","address":"string"}],"bcc_json":[{"name":"value","address":"string"}],"headers_json":{},"snippet":"value","text_body":"value","html_body":"value","attachments":[{"filename":"string","content_type":"string","content_b64":"string","disposition":"value","content_id":"value"}],"state":"pending","received_at":"value","sent_at":"value"};
const url = "${BASE_URL}/api/accounts/acc123/smtp/messages";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"credential_id":"string","direction":"value","available_at":"value","folder":"value","provider_message_id":"value","thread_id":"value","subject":"value","from_json":[{"name":"value","address":"string"}],"to_json":[{"name":"value","address":"string"}],"cc_json":[{"name":"value","address":"string"}],"bcc_json":[{"name":"value","address":"string"}],"headers_json":{},"snippet":"value","text_body":"value","html_body":"value","attachments":[{"filename":"string","content_type":"string","content_b64":"string","disposition":"value","content_id":"value"}],"state":"pending","received_at":"value","sent_at":"value"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/smtp/messages",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"credential_id":"string","direction":"value","available_at":"value","folder":"value","provider_message_id":"value","thread_id":"value","subject":"value","from_json":[{"name":"value","address":"string"}],"to_json":[{"name":"value","address":"string"}],"cc_json":[{"name":"value","address":"string"}],"bcc_json":[{"name":"value","address":"string"}],"headers_json":{},"snippet":"value","text_body":"value","html_body":"value","attachments":[{"filename":"string","content_type":"string","content_b64":"string","disposition":"value","content_id":"value"}],"state":"pending","received_at":"value","sent_at":"value"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/smtp/messages",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"credential_id":"string","direction":"value","available_at":"value","folder":"value","provider_message_id":"value","thread_id":"value","subject":"value","from_json":[{"name":"value","address":"string"}],"to_json":[{"name":"value","address":"string"}],"cc_json":[{"name":"value","address":"string"}],"bcc_json":[{"name":"value","address":"string"}],"headers_json":{},"snippet":"value","text_body":"value","html_body":"value","attachments":[{"filename":"string","content_type":"string","content_b64":"string","disposition":"value","content_id":"value"}],"state":"pending","received_at":"value","sent_at":"value"};
const { body } = await request("${BASE_URL}/api/accounts/acc123/smtp/messages", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"credential_id":"string","direction":"value","available_at":"value","folder":"value","provider_message_id":"value","thread_id":"value","subject":"value","from_json":[{"name":"value","address":"string"}],"to_json":[{"name":"value","address":"string"}],"cc_json":[{"name":"value","address":"string"}],"bcc_json":[{"name":"value","address":"string"}],"headers_json":{},"snippet":"value","text_body":"value","html_body":"value","attachments":[{"filename":"string","content_type":"string","content_b64":"string","disposition":"value","content_id":"value"}],"state":"pending","received_at":"value","sent_at":"value"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/smtp/messages", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"credential_id":"string","direction":"value","available_at":"value","folder":"value","provider_message_id":"value","thread_id":"value","subject":"value","from_json":[{"name":"value","address":"string"}],"to_json":[{"name":"value","address":"string"}],"cc_json":[{"name":"value","address":"string"}],"bcc_json":[{"name":"value","address":"string"}],"headers_json":{},"snippet":"value","text_body":"value","html_body":"value","attachments":[{"filename":"string","content_type":"string","content_b64":"string","disposition":"value","content_id":"value"}],"state":"pending","received_at":"value","sent_at":"value"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/smtp/messages", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"credential_id":"string","direction":"value","available_at":"value","folder":"value","provider_message_id":"value","thread_id":"value","subject":"value","from_json":[{"name":"value","address":"string"}],"to_json":[{"name":"value","address":"string"}],"cc_json":[{"name":"value","address":"string"}],"bcc_json":[{"name":"value","address":"string"}],"headers_json":{},"snippet":"value","text_body":"value","html_body":"value","attachments":[{"filename":"string","content_type":"string","content_b64":"string","disposition":"value","content_id":"value"}],"state":"pending","received_at":"value","sent_at":"value"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/smtp/messages", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"credential_id":"string","direction":"value","available_at":"value","folder":"value","provider_message_id":"value","thread_id":"value","subject":"value","from_json":[{"name":"value","address":"string"}],"to_json":[{"name":"value","address":"string"}],"cc_json":[{"name":"value","address":"string"}],"bcc_json":[{"name":"value","address":"string"}],"headers_json":{},"snippet":"value","text_body":"value","html_body":"value","attachments":[{"filename":"string","content_type":"string","content_b64":"string","disposition":"value","content_id":"value"}],"state":"pending","received_at":"value","sent_at":"value"}
uri = URI("${BASE_URL}/api/accounts/acc123/smtp/messages")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"credential_id":"string","direction":"value","available_at":"value","folder":"value","provider_message_id":"value","thread_id":"value","subject":"value","from_json":[{"name":"value","address":"string"}],"to_json":[{"name":"value","address":"string"}],"cc_json":[{"name":"value","address":"string"}],"bcc_json":[{"name":"value","address":"string"}],"headers_json":{},"snippet":"value","text_body":"value","html_body":"value","attachments":[{"filename":"string","content_type":"string","content_b64":"string","disposition":"value","content_id":"value"}],"state":"pending","received_at":"value","sent_at":"value"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/smtp/messages", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/smtp/messages");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"credential_id\":\"string\",\"direction\":\"value\",\"available_at\":\"value\",\"folder\":\"value\",\"provider_message_id\":\"value\",\"thread_id\":\"value\",\"subject\":\"value\",\"from_json\":[{\"name\":\"value\",\"address\":\"string\"}],\"to_json\":[{\"name\":\"value\",\"address\":\"string\"}],\"cc_json\":[{\"name\":\"value\",\"address\":\"string\"}],\"bcc_json\":[{\"name\":\"value\",\"address\":\"string\"}],\"headers_json\":{},\"snippet\":\"value\",\"text_body\":\"value\",\"html_body\":\"value\",\"attachments\":[{\"filename\":\"string\",\"content_type\":\"string\",\"content_b64\":\"string\",\"disposition\":\"value\",\"content_id\":\"value\"}],\"state\":\"pending\",\"received_at\":\"value\",\"sent_at\":\"value\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

DELETE/api/emails/{email_id}

Delete a stored email record. More Email Ingestion & Delivery

Responses

204

No Content

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X DELETE \\
  "${BASE_URL}/api/emails/iem123" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/emails/iem123";
const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/emails/iem123";
const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "delete",
  url: "${BASE_URL}/api/emails/iem123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "delete",
  url: "${BASE_URL}/api/emails/iem123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/emails/iem123", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "DELETE", \
    "${BASE_URL}/api/emails/iem123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "DELETE", \
        "${BASE_URL}/api/emails/iem123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("DELETE", "${BASE_URL}/api/emails/iem123", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/emails/iem123")
request = Net::HTTP::Delete.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("DELETE", "${BASE_URL}/api/emails/iem123", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "${BASE_URL}/api/emails/iem123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/emails/{email_id}

Retrieve one stored email record by ID. More Email Ingestion & Delivery

Responses

200application/json

schemaobject

dataEmailMessagerequired

Stored email metadata and envelope details for inbound sync and outbound delivery records.

idstringrequired

Email message identifier.

account_idstringrequired

Account identifier.

application_idstringrequired

Application identifier.

credential_idstring | nullrequired

Provider credential identifier.

directionrequired

folderstring | nullrequired

provider_message_idstring | nullrequired

thread_idstring | nullrequired

subjectstring | nullrequired

from_jsonarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

to_jsonarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

cc_jsonarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

bcc_jsonarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

headers_jsonobjectrequired

snippetstring | nullrequired

staterequired

received_atstring | nullrequired

sent_atstring | nullrequired

created_bystringrequired

User identifier.

updated_bystringrequired

User identifier.

created_atstringrequired

updated_atstringrequired

deleted_atstring | nullrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/emails/iem123" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/emails/iem123";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/emails/iem123";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/emails/iem123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/emails/iem123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/emails/iem123", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/emails/iem123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/emails/iem123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/emails/iem123", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/emails/iem123")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/emails/iem123", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/emails/iem123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PATCH/api/emails/{email_id}

Update mutable email metadata fields. More Email Ingestion & Delivery

Body application/json

folderstring | null

subjectstring | null

snippetstring | null

state

deleted_atstring | null

Responses

200application/json

schemaobject

dataEmailMessagerequired

Stored email metadata and envelope details for inbound sync and outbound delivery records.

idstringrequired

Email message identifier.

account_idstringrequired

Account identifier.

application_idstringrequired

Application identifier.

credential_idstring | nullrequired

Provider credential identifier.

directionrequired

folderstring | nullrequired

provider_message_idstring | nullrequired

thread_idstring | nullrequired

subjectstring | nullrequired

from_jsonarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

to_jsonarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

cc_jsonarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

bcc_jsonarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

headers_jsonobjectrequired

snippetstring | nullrequired

staterequired

received_atstring | nullrequired

sent_atstring | nullrequired

created_bystringrequired

User identifier.

updated_bystringrequired

User identifier.

created_atstringrequired

updated_atstringrequired

deleted_atstring | nullrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X PATCH \\
  "${BASE_URL}/api/emails/iem123" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"folder":"value","subject":"value","snippet":"value","state":"pending","deleted_at":"value"}'

const payload = {"folder":"value","subject":"value","snippet":"value","state":"pending","deleted_at":"value"};
const url = "${BASE_URL}/api/emails/iem123";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"folder":"value","subject":"value","snippet":"value","state":"pending","deleted_at":"value"};
const url = "${BASE_URL}/api/emails/iem123";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"folder":"value","subject":"value","snippet":"value","state":"pending","deleted_at":"value"};
const response = await axios({
  method: "patch",
  url: "${BASE_URL}/api/emails/iem123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"folder":"value","subject":"value","snippet":"value","state":"pending","deleted_at":"value"};
const response: AxiosResponse = await axios({
  method: "patch",
  url: "${BASE_URL}/api/emails/iem123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"folder":"value","subject":"value","snippet":"value","state":"pending","deleted_at":"value"};
const { body } = await request("${BASE_URL}/api/emails/iem123", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"folder":"value","subject":"value","snippet":"value","state":"pending","deleted_at":"value"}
response = requests.request( \
    "PATCH", \
    "${BASE_URL}/api/emails/iem123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"folder":"value","subject":"value","snippet":"value","state":"pending","deleted_at":"value"}
with httpx.Client() as client:
    response = client.request( \
        "PATCH", \
        "${BASE_URL}/api/emails/iem123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"folder":"value","subject":"value","snippet":"value","state":"pending","deleted_at":"value"}`))

req, err := http.NewRequest("PATCH", "${BASE_URL}/api/emails/iem123", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"folder":"value","subject":"value","snippet":"value","state":"pending","deleted_at":"value"}
uri = URI("${BASE_URL}/api/emails/iem123")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"folder":"value","subject":"value","snippet":"value","state":"pending","deleted_at":"value"};
$client = new Client();
$response = $client->request("PATCH", "${BASE_URL}/api/emails/iem123", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "${BASE_URL}/api/emails/iem123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"folder\":\"value\",\"subject\":\"value\",\"snippet\":\"value\",\"state\":\"pending\",\"deleted_at\":\"value\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

EmailMessage

idstringrequired

Email message identifier.

account_idstringrequired

Account identifier.

application_idstringrequired

Application identifier.

credential_idstring | nullrequired

Provider credential identifier.

directionrequired

folderstring | nullrequired

provider_message_idstring | nullrequired

thread_idstring | nullrequired

subjectstring | nullrequired

from_jsonarrayrequired

itemobjectrequired

namestring | null

addressstringrequired

to_jsonarrayrequired

itemobjectrequired

namestring | null

addressstringrequired

cc_jsonarrayrequired

itemobjectrequired

namestring | null

addressstringrequired

bcc_jsonarrayrequired

itemobjectrequired

namestring | null

addressstringrequired

headers_jsonobjectrequired

snippetstring | nullrequired

staterequired

received_atstring | nullrequired

sent_atstring | nullrequired

created_bystringrequired

User identifier.

updated_bystringrequired

User identifier.

created_atstringrequired

updated_atstringrequired

deleted_atstring | nullrequired

EmailMessagePart

idstringrequired

Email message part identifier.

email_idstringrequired

Email message identifier.

account_idstringrequired

Account identifier.

application_idstringrequired

Application identifier.

kindrequired

ordinalintegerrequired

filenamestring | nullrequired

content_typestringrequired

dispositionstring | nullrequired

content_idstring | nullrequired

sizeintegerrequired

content_sha256string | nullrequired

created_atstringrequired

updated_atstringrequired

EmailMessagePartContent

idstringrequired

Email message part identifier.

email_idstringrequired

Email message identifier.

kindrequired

ordinalintegerrequired

filenamestring | nullrequired

content_typestringrequired

dispositionstring | nullrequired

content_idstring | nullrequired

sizeintegerrequired

content_sha256string | nullrequired

content_b64stringrequired

ProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

ValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

Emails

Contents

List emails

Create email

Get email body

List stored email part metadata

Get email part content

Search stored email part metadata

Search emails

Search and delete emails

Enqueue mailbox sync

Enqueue message sync

Enqueue SMTP message send

Delete email

Get email

Patch email

Models

Features

Types

Contents

Models

Related Features and Types

Features

Types