Creates a new mailbox configuration, encrypting credentials before storage.

POST /api/mail/mailbox

Creates a new mailbox configuration, encrypting credentials before storage.

cURL

curl --request POST \
  --url https://{install}/api/mail/mailbox \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity": "<string>",
  "name": "<string>",
  "connectionType": 123,
  "server": "<string>",
  "port": 123,
  "inboxFolder": "<string>",
  "categoryProcessed": "<string>",
  "categorySkipped": "<string>",
  "imapUsername": "<string>",
  "imapPassword": "<string>",
  "imapSmtpServer": "<string>",
  "imapSmtpPort": 123,
  "microsoftEmailAddress": "<string>",
  "microsoftOAuthTenantId": "<string>",
  "microsoftOAuthClientId": "<string>",
  "microsoftOAuthClientSecret": "<string>",
  "tenantId": "<string>",
  "id": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "updated": "2023-11-07T05:31:56Z",
  "updatedBy": "<string>",
  "deleted": true
}
'

import requests

url = "https://{install}/api/mail/mailbox"

payload = {
    "entity": "<string>",
    "name": "<string>",
    "connectionType": 123,
    "server": "<string>",
    "port": 123,
    "inboxFolder": "<string>",
    "categoryProcessed": "<string>",
    "categorySkipped": "<string>",
    "imapUsername": "<string>",
    "imapPassword": "<string>",
    "imapSmtpServer": "<string>",
    "imapSmtpPort": 123,
    "microsoftEmailAddress": "<string>",
    "microsoftOAuthTenantId": "<string>",
    "microsoftOAuthClientId": "<string>",
    "microsoftOAuthClientSecret": "<string>",
    "tenantId": "<string>",
    "id": "<string>",
    "created": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "updated": "2023-11-07T05:31:56Z",
    "updatedBy": "<string>",
    "deleted": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    entity: '<string>',
    name: '<string>',
    connectionType: 123,
    server: '<string>',
    port: 123,
    inboxFolder: '<string>',
    categoryProcessed: '<string>',
    categorySkipped: '<string>',
    imapUsername: '<string>',
    imapPassword: '<string>',
    imapSmtpServer: '<string>',
    imapSmtpPort: 123,
    microsoftEmailAddress: '<string>',
    microsoftOAuthTenantId: '<string>',
    microsoftOAuthClientId: '<string>',
    microsoftOAuthClientSecret: '<string>',
    tenantId: '<string>',
    id: '<string>',
    created: '2023-11-07T05:31:56Z',
    createdBy: '<string>',
    updated: '2023-11-07T05:31:56Z',
    updatedBy: '<string>',
    deleted: true
  })
};

fetch('https://{install}/api/mail/mailbox', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://{install}/api/mail/mailbox");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"entity\": \"<string>\",\n  \"name\": \"<string>\",\n  \"connectionType\": 123,\n  \"server\": \"<string>\",\n  \"port\": 123,\n  \"inboxFolder\": \"<string>\",\n  \"categoryProcessed\": \"<string>\",\n  \"categorySkipped\": \"<string>\",\n  \"imapUsername\": \"<string>\",\n  \"imapPassword\": \"<string>\",\n  \"imapSmtpServer\": \"<string>\",\n  \"imapSmtpPort\": 123,\n  \"microsoftEmailAddress\": \"<string>\",\n  \"microsoftOAuthTenantId\": \"<string>\",\n  \"microsoftOAuthClientId\": \"<string>\",\n  \"microsoftOAuthClientSecret\": \"<string>\",\n  \"tenantId\": \"<string>\",\n  \"id\": \"<string>\",\n  \"created\": \"2023-11-07T05:31:56Z\",\n  \"createdBy\": \"<string>\",\n  \"updated\": \"2023-11-07T05:31:56Z\",\n  \"updatedBy\": \"<string>\",\n  \"deleted\": true\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{install}/api/mail/mailbox",
  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([
    'entity' => '<string>',
    'name' => '<string>',
    'connectionType' => 123,
    'server' => '<string>',
    'port' => 123,
    'inboxFolder' => '<string>',
    'categoryProcessed' => '<string>',
    'categorySkipped' => '<string>',
    'imapUsername' => '<string>',
    'imapPassword' => '<string>',
    'imapSmtpServer' => '<string>',
    'imapSmtpPort' => 123,
    'microsoftEmailAddress' => '<string>',
    'microsoftOAuthTenantId' => '<string>',
    'microsoftOAuthClientId' => '<string>',
    'microsoftOAuthClientSecret' => '<string>',
    'tenantId' => '<string>',
    'id' => '<string>',
    'created' => '2023-11-07T05:31:56Z',
    'createdBy' => '<string>',
    'updated' => '2023-11-07T05:31:56Z',
    'updatedBy' => '<string>',
    'deleted' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://{install}/api/mail/mailbox"

	payload := strings.NewReader("{\n  \"entity\": \"<string>\",\n  \"name\": \"<string>\",\n  \"connectionType\": 123,\n  \"server\": \"<string>\",\n  \"port\": 123,\n  \"inboxFolder\": \"<string>\",\n  \"categoryProcessed\": \"<string>\",\n  \"categorySkipped\": \"<string>\",\n  \"imapUsername\": \"<string>\",\n  \"imapPassword\": \"<string>\",\n  \"imapSmtpServer\": \"<string>\",\n  \"imapSmtpPort\": 123,\n  \"microsoftEmailAddress\": \"<string>\",\n  \"microsoftOAuthTenantId\": \"<string>\",\n  \"microsoftOAuthClientId\": \"<string>\",\n  \"microsoftOAuthClientSecret\": \"<string>\",\n  \"tenantId\": \"<string>\",\n  \"id\": \"<string>\",\n  \"created\": \"2023-11-07T05:31:56Z\",\n  \"createdBy\": \"<string>\",\n  \"updated\": \"2023-11-07T05:31:56Z\",\n  \"updatedBy\": \"<string>\",\n  \"deleted\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{install}/api/mail/mailbox")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entity\": \"<string>\",\n  \"name\": \"<string>\",\n  \"connectionType\": 123,\n  \"server\": \"<string>\",\n  \"port\": 123,\n  \"inboxFolder\": \"<string>\",\n  \"categoryProcessed\": \"<string>\",\n  \"categorySkipped\": \"<string>\",\n  \"imapUsername\": \"<string>\",\n  \"imapPassword\": \"<string>\",\n  \"imapSmtpServer\": \"<string>\",\n  \"imapSmtpPort\": 123,\n  \"microsoftEmailAddress\": \"<string>\",\n  \"microsoftOAuthTenantId\": \"<string>\",\n  \"microsoftOAuthClientId\": \"<string>\",\n  \"microsoftOAuthClientSecret\": \"<string>\",\n  \"tenantId\": \"<string>\",\n  \"id\": \"<string>\",\n  \"created\": \"2023-11-07T05:31:56Z\",\n  \"createdBy\": \"<string>\",\n  \"updated\": \"2023-11-07T05:31:56Z\",\n  \"updatedBy\": \"<string>\",\n  \"deleted\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{install}/api/mail/mailbox")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entity\": \"<string>\",\n  \"name\": \"<string>\",\n  \"connectionType\": 123,\n  \"server\": \"<string>\",\n  \"port\": 123,\n  \"inboxFolder\": \"<string>\",\n  \"categoryProcessed\": \"<string>\",\n  \"categorySkipped\": \"<string>\",\n  \"imapUsername\": \"<string>\",\n  \"imapPassword\": \"<string>\",\n  \"imapSmtpServer\": \"<string>\",\n  \"imapSmtpPort\": 123,\n  \"microsoftEmailAddress\": \"<string>\",\n  \"microsoftOAuthTenantId\": \"<string>\",\n  \"microsoftOAuthClientId\": \"<string>\",\n  \"microsoftOAuthClientSecret\": \"<string>\",\n  \"tenantId\": \"<string>\",\n  \"id\": \"<string>\",\n  \"created\": \"2023-11-07T05:31:56Z\",\n  \"createdBy\": \"<string>\",\n  \"updated\": \"2023-11-07T05:31:56Z\",\n  \"updatedBy\": \"<string>\",\n  \"deleted\": true\n}"

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

Authorizations

Authorization · string · header · required

JWT Bearer token. Obtain via the OAuth 2.0 token endpoint.

Body

application/jsonapplication/*+json

The mailbox configuration to create with plaintext credentials.

entity · null | string

name · string

connectionType · integer

server · string

port · integer<int32>

inboxFolder · string

categoryProcessed · string

categorySkipped · string

imapUsername · string

imapPassword · string

imapSmtpServer · string

imapSmtpPort · integer<int32>

microsoftEmailAddress · string

microsoftOAuthTenantId · string

microsoftOAuthClientId · string

microsoftOAuthClientSecret · string

tenantId · string

id · string

created · string<date-time>

createdBy · string

updated · string<date-time>

updatedBy · string

deleted · boolean

Response

200

application/json

Mailbox created successfully.