Configuration Data

Allow your users to obtain configuration details that include the various limits that apply to emails.

Get Configuration Data

A call to getConfigurationData returns the various limits applied to email sending and receiving, as well as the limits applied to email management.

// Interface representing the configuration data returned
export interface ConfigurationData {
  deleteEmailMessagesLimit: number
  updateEmailMessagesLimit: number
  emailMessageMaxInboundMessageSize: number
  emailMessageMaxOutboundMessageSize: number
  emailMessageRecipientsLimit: number
  encryptedEmailMessageRecipientsLimit: number

try {
    const configurationData = await emailClient.getConfigurationData()
    // `configurationData` contains the various limits configured for emails.
} catch {
    // Handle/notify user of errors

Last updated