Email - Configs

Email configuration management for tenant-specific SMTP or OAuth email providers. Provides CRUD operations for creating, retrieving, updating, and deleting email configurations. Supports multiple configurations per tenant with default/shared management, SMTP settings, and OAuth (Microsoft365/Google) flows. Includes a test endpoint to verify configurations.

OpenAPI Spec

Guides Operations Schemas

GET List Email Configs
Returns a paginated list of email configurations the current user can access (owned or shared). EmailConnections admins see all configurations includi...
/tenants/{tenant}/email-configs
POST Create Email Config
Creates a new email configuration. For SMTP: provide SmtpSettings. For OAuth (Microsoft365/Google): provide OAuthSettings with returnUrl - response in...
/tenants/{tenant}/email-configs
GET Get Email Config
Returns a single email configuration including provider details (SMTP settings, OAuth status). User must be the owner or an admin, or the config must ...
/tenants/{tenant}/email-configs/{code}
PUT Update Email Config
Updates an existing email configuration. Supports updating provider settings (SMTP or OAuth), display name (FromName), and flags (IsDefault, IsSendSha...
/tenants/{tenant}/email-configs/{code}
DELETE Delete Email Config
Deletes an email configuration. Cannot delete the tenant's default config unless it is the only one remaining. User must be the connection's owner or ...
/tenants/{tenant}/email-configs/{code}
POST Test Email Config
Sends a test email using the specified configuration to verify it is working correctly. User must be the connection's owner or an admin. Requires: Up...
/tenants/{tenant}/email-configs/{code}/test
POST Reconnect OAuth email configuration
Generates a fresh OAuth authorisation URL for reconnecting an expired or incorrectly-connected email configuration. Only works for OAuth providers (Mi...
/tenants/{tenant}/email-configs/{code}/reconnect
GET List Share Rules
Returns every rule on this mailbox with isExclusion on each row. Rules with isExclusion false decide which emails colleagues may read when the mailbox...
/tenants/{tenant}/email-configs/{code}/share-rules
POST Add Share Rule
Adds an address, domain, conversation, folder or message rule. With isExclusion false it shares what it matches; with isExclusion true it hides what i...
/tenants/{tenant}/email-configs/{code}/share-rules
DELETE Delete Share Rule
Removes a rule. A removed share stops its emails being visible to colleagues at once; a removed exclusion makes its emails visible again wherever anot...
/tenants/{tenant}/email-configs/{code}/share-rules/{ruleId}