curl --request POST \
--url https://api.parser-app.com/v1/mailboxes \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"address": "<string>",
"imap": {
"host": "<string>",
"username": "<string>",
"password": "<string>",
"port": 993,
"ssl": true,
"folder": "INBOX"
},
"organization": "<string>",
"label": "INBOX",
"settings": {
"auto_parse": true,
"internal_domains": [
"<string>"
],
"allowed_sender_domains": [
"<string>"
],
"store_raw_email": true,
"default_tags": [
"client:acme"
]
}
}
'import requests
url = "https://api.parser-app.com/v1/mailboxes"
payload = {
"address": "<string>",
"imap": {
"host": "<string>",
"username": "<string>",
"password": "<string>",
"port": 993,
"ssl": True,
"folder": "INBOX"
},
"organization": "<string>",
"label": "INBOX",
"settings": {
"auto_parse": True,
"internal_domains": ["<string>"],
"allowed_sender_domains": ["<string>"],
"store_raw_email": True,
"default_tags": ["client:acme"]
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
address: '<string>',
imap: {
host: '<string>',
username: '<string>',
password: '<string>',
port: 993,
ssl: true,
folder: 'INBOX'
},
organization: '<string>',
label: 'INBOX',
settings: {
auto_parse: true,
internal_domains: ['<string>'],
allowed_sender_domains: ['<string>'],
store_raw_email: true,
default_tags: ['client:acme']
}
})
};
fetch('https://api.parser-app.com/v1/mailboxes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.parser-app.com/v1/mailboxes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'address' => '<string>',
'imap' => [
'host' => '<string>',
'username' => '<string>',
'password' => '<string>',
'port' => 993,
'ssl' => true,
'folder' => 'INBOX'
],
'organization' => '<string>',
'label' => 'INBOX',
'settings' => [
'auto_parse' => true,
'internal_domains' => [
'<string>'
],
'allowed_sender_domains' => [
'<string>'
],
'store_raw_email' => true,
'default_tags' => [
'client:acme'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.parser-app.com/v1/mailboxes"
payload := strings.NewReader("{\n \"address\": \"<string>\",\n \"imap\": {\n \"host\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"port\": 993,\n \"ssl\": true,\n \"folder\": \"INBOX\"\n },\n \"organization\": \"<string>\",\n \"label\": \"INBOX\",\n \"settings\": {\n \"auto_parse\": true,\n \"internal_domains\": [\n \"<string>\"\n ],\n \"allowed_sender_domains\": [\n \"<string>\"\n ],\n \"store_raw_email\": true,\n \"default_tags\": [\n \"client:acme\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.parser-app.com/v1/mailboxes")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"address\": \"<string>\",\n \"imap\": {\n \"host\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"port\": 993,\n \"ssl\": true,\n \"folder\": \"INBOX\"\n },\n \"organization\": \"<string>\",\n \"label\": \"INBOX\",\n \"settings\": {\n \"auto_parse\": true,\n \"internal_domains\": [\n \"<string>\"\n ],\n \"allowed_sender_domains\": [\n \"<string>\"\n ],\n \"store_raw_email\": true,\n \"default_tags\": [\n \"client:acme\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.parser-app.com/v1/mailboxes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"address\": \"<string>\",\n \"imap\": {\n \"host\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"port\": 993,\n \"ssl\": true,\n \"folder\": \"INBOX\"\n },\n \"organization\": \"<string>\",\n \"label\": \"INBOX\",\n \"settings\": {\n \"auto_parse\": true,\n \"internal_domains\": [\n \"<string>\"\n ],\n \"allowed_sender_domains\": [\n \"<string>\"\n ],\n \"store_raw_email\": true,\n \"default_tags\": [\n \"client:acme\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"mailbox": {
"id": "<string>",
"kind": "<string>",
"auth": "<string>",
"address": "<string>",
"label": "<string>",
"status": "pending",
"settings": {
"auto_parse": true,
"internal_domains": [
"<string>"
],
"allowed_sender_domains": [
"<string>"
],
"store_raw_email": true,
"default_tags": [
"client:acme"
]
},
"watch_expires_at": "2023-11-07T05:31:56Z",
"last_sync_at": "2023-11-07T05:31:56Z",
"last_error": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"inbound_secret": "<string>",
"authorize_url": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Connect a mailbox
{kind: "forwarding"}: a new address <token>@INBOUND_MAIL_DOMAIN to forward deals to (a Gmail filter, an Outlook rule), and an inbound secret for providers that post mail themselves. {kind: "gmail", auth: "delegation", address}: a mailbox in a Workspace domain that authorized the platform’s service account (scope gmail.readonly); access is checked and the watch started now. {kind: "gmail", auth: "oauth", address}: returns authorize_url; the mailbox is connected when Google returns. Needs the email_intake module.
curl --request POST \
--url https://api.parser-app.com/v1/mailboxes \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"address": "<string>",
"imap": {
"host": "<string>",
"username": "<string>",
"password": "<string>",
"port": 993,
"ssl": true,
"folder": "INBOX"
},
"organization": "<string>",
"label": "INBOX",
"settings": {
"auto_parse": true,
"internal_domains": [
"<string>"
],
"allowed_sender_domains": [
"<string>"
],
"store_raw_email": true,
"default_tags": [
"client:acme"
]
}
}
'import requests
url = "https://api.parser-app.com/v1/mailboxes"
payload = {
"address": "<string>",
"imap": {
"host": "<string>",
"username": "<string>",
"password": "<string>",
"port": 993,
"ssl": True,
"folder": "INBOX"
},
"organization": "<string>",
"label": "INBOX",
"settings": {
"auto_parse": True,
"internal_domains": ["<string>"],
"allowed_sender_domains": ["<string>"],
"store_raw_email": True,
"default_tags": ["client:acme"]
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
address: '<string>',
imap: {
host: '<string>',
username: '<string>',
password: '<string>',
port: 993,
ssl: true,
folder: 'INBOX'
},
organization: '<string>',
label: 'INBOX',
settings: {
auto_parse: true,
internal_domains: ['<string>'],
allowed_sender_domains: ['<string>'],
store_raw_email: true,
default_tags: ['client:acme']
}
})
};
fetch('https://api.parser-app.com/v1/mailboxes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.parser-app.com/v1/mailboxes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'address' => '<string>',
'imap' => [
'host' => '<string>',
'username' => '<string>',
'password' => '<string>',
'port' => 993,
'ssl' => true,
'folder' => 'INBOX'
],
'organization' => '<string>',
'label' => 'INBOX',
'settings' => [
'auto_parse' => true,
'internal_domains' => [
'<string>'
],
'allowed_sender_domains' => [
'<string>'
],
'store_raw_email' => true,
'default_tags' => [
'client:acme'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.parser-app.com/v1/mailboxes"
payload := strings.NewReader("{\n \"address\": \"<string>\",\n \"imap\": {\n \"host\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"port\": 993,\n \"ssl\": true,\n \"folder\": \"INBOX\"\n },\n \"organization\": \"<string>\",\n \"label\": \"INBOX\",\n \"settings\": {\n \"auto_parse\": true,\n \"internal_domains\": [\n \"<string>\"\n ],\n \"allowed_sender_domains\": [\n \"<string>\"\n ],\n \"store_raw_email\": true,\n \"default_tags\": [\n \"client:acme\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.parser-app.com/v1/mailboxes")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"address\": \"<string>\",\n \"imap\": {\n \"host\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"port\": 993,\n \"ssl\": true,\n \"folder\": \"INBOX\"\n },\n \"organization\": \"<string>\",\n \"label\": \"INBOX\",\n \"settings\": {\n \"auto_parse\": true,\n \"internal_domains\": [\n \"<string>\"\n ],\n \"allowed_sender_domains\": [\n \"<string>\"\n ],\n \"store_raw_email\": true,\n \"default_tags\": [\n \"client:acme\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.parser-app.com/v1/mailboxes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"address\": \"<string>\",\n \"imap\": {\n \"host\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"port\": 993,\n \"ssl\": true,\n \"folder\": \"INBOX\"\n },\n \"organization\": \"<string>\",\n \"label\": \"INBOX\",\n \"settings\": {\n \"auto_parse\": true,\n \"internal_domains\": [\n \"<string>\"\n ],\n \"allowed_sender_domains\": [\n \"<string>\"\n ],\n \"store_raw_email\": true,\n \"default_tags\": [\n \"client:acme\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"mailbox": {
"id": "<string>",
"kind": "<string>",
"auth": "<string>",
"address": "<string>",
"label": "<string>",
"status": "pending",
"settings": {
"auto_parse": true,
"internal_domains": [
"<string>"
],
"allowed_sender_domains": [
"<string>"
],
"store_raw_email": true,
"default_tags": [
"client:acme"
]
},
"watch_expires_at": "2023-11-07T05:31:56Z",
"last_sync_at": "2023-11-07T05:31:56Z",
"last_error": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"inbound_secret": "<string>",
"authorize_url": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
API key
Body
forwarding, gmail, imap, m365 gmail only: delegation (the funder's Workspace authorized our service account) or oauth (a mailbox of the platform's own Workspace)
delegation, oauth gmail, imap, m365: the mailbox's address
320imap only: the server and login
Show child attributes
Show child attributes
m365 only: the funder's Microsoft tenant id or domain
200gmail only: only messages with this label (INBOX, or one a filter applies)
1 - 200Show child attributes
Show child attributes