Mailbox Management API

What’s new – Oct 23, 2024

At Sophos we are listening to your feedback on improving the manageability of Sophos Central Email to make it more responsive to your needs. One such feedback has been that some customers – particularly those who are keen on saving cost of directory services or those with high churn rate in users onboarded on Sophos Email – prefer to use API to manage mailboxes rather than by synchronizing with a directory. Also, many of our MSPs (Managed Service Providers) have expressed preference for API to avoid configuring directory synchronization for each of the numerous tenants that they manage. Thus, we have released a new feature, Mailbox Management API, in Sophos Email. Using this API, you can perform all the CRUD (Create, Read, Update, and Delete) operations on mailboxes in Sophos Email.

Watch the video attached at end of this post to familiarize yourself with the Mailbox Management API.

Applies to the following Sophos products
Sophos Email

Operations supported

Using the API, you can perform the following operations on the mailboxes in Sophos Email:

1. Create mailbox
   • Create mailbox – creates a mailbox with given set of attributes
   • Create multiple mailbox – creates a set of mailboxes in a single API call

2. Read mailbox
   • Read mailbox – returns all the attributes of the mailbox
   • Find mailbox – lists mailboxes matching a set of criteria or lists all the mailboxes

3. Update mailbox
   • Update mailbox name – change/correct the name of the user of the mailbox
   • Update mailbox aliases – add or remove aliases of a mailbox
   • Request bulk sender privilege – raises request for bulk sender privilege for a mailbox
   • Update mailbox delegates – add or remove delegates of a mailbox
   • Update DL owner – add or remove owner of a distribution list

4. Delete mailbox
   • Delete mailbox – deletes the mailbox
   • Delete multiple mailbox – deletes a set of mailboxes in a single API call

API Documentation

Refer the following resources for additional information:

• Sophos Central API documentation for all API(s) supported by Sophos Email
• Sophos Central API documentation for Mailbox Management API(s)
• Sophos Email documentation for all API(s) supported
• Sophos Central API documentation

The following screenshot is of the Mailbox Management API documentation.

Watch the video demo

If you are new to API(s) in Sophos Email, refer to these other API demo video(s):

• https://techvids.sophos.com/watch/Fbcv5tihWe9CiUyy7BmqxZ
• https://techvids.sophos.com/watch/jUXMws7XGSRZt67CiANsSq