Skip to main content

Documentation Index

Fetch the complete documentation index at: https://ekso.dev/llms.txt

Use this file to discover all available pages before exploring further.

Sample shape for ConfigMailbox.

​
Sample JSON

Copy, edit, paste. Server-set fields (id, created, tenantId, …) are omitted from the example — they’re populated by the server on response. 
{
  "name": "Example name",
  "connectionType": "<mailbox-connection-type>",
  "server": "example",
  "port": 0,
  "inboxFolder": "example",
  "categoryProcessed": "example",
  "categorySkipped": "example",
  "imapUsername": "example",
  "imapPassword": "example",
  "imapSmtpServer": "example",
  "imapSmtpPort": 0,
  "microsoftEmailAddress": "[email protected]",
  "microsoftOAuthTenantId": "<microsoft-o-auth-tenant_id>",
  "microsoftOAuthClientId": "<microsoft-o-auth-client_id>",
  "microsoftOAuthClientSecret": "example"
}

​
Fields

FieldTypeRequiredNotes
entitystring • nullableServer-setSet by the server. Read-only on writes.
namestringRequired
connectionTypeMailboxConnectionTypeOptional
serverstringOptional
portintegerOptional
inboxFolderstringOptional
categoryProcessedstringOptional
categorySkippedstringOptional
imapUsernamestringOptional
imapPasswordstringOptional
imapSmtpServerstringOptional
imapSmtpPortintegerOptional
microsoftEmailAddressstringOptional
microsoftOAuthTenantIdstringOptional
microsoftOAuthClientIdstringOptional
microsoftOAuthClientSecretstringOptional
tenantIdstringServer-setSet by the server. Read-only on writes.
idstringServer-setSet by the server. Read-only on writes.
createdstring (date-time)Server-setSet by the server. Read-only on writes.
createdBystringServer-setSet by the server. Read-only on writes.
updatedstring (date-time)Server-setSet by the server. Read-only on writes.
updatedBystringServer-setSet by the server. Read-only on writes.
deletedbooleanServer-setSet by the server. Read-only on writes.

​
Used by

​
Request body

  • POST /api/mail/mailbox
  • PUT /api/mail/mailbox/{id}

​
Response body

  • GET /api/mail/mailbox/{id}
  • GET /api/mail/mailbox

​
CLI

ekso mail-mailbox — see the command branches page for available verbs. Body for create / update verbs typically passed via --data @file.json matching the sample JSON above.