Shares
All operations require authentication.
List public foldersProduction
List public folders. Returns the paths of the public folders of the service. Filter them by path to look for a given folder.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Query parameters
Filter the value of path property (like)
Response
Example uses exchangeService = string, organizationName = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ email/ exchange/ {organizationName}/ service/ {exchangeService}/ publicFolder \
-H "authorization: Bearer $OVH_TOKEN"[ "string"]
Get a public folderProduction
Get a public folder. Returns the type, quota, size, item count, default and anonymous permissions and access dates of the public folder.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Path for public folder
Response
Access right for the guest users
editornonereviewerCreation date
Default access right
editornonereviewerIf true, this public folder has subfolders
Number of items in public folder
Time for which public folder was accessed for the last time
Time for which public folder was modified for the last time
Time for which public folder was accessed for the last time by the user
Time for which public folder was modified for the last time by the user
Path for public folder
Quota for public folder in MB
Current object state
creatingdeletinginternalMigrationokreopeningsuspendedsuspendingtask pending id
Sum of all items in public folder in MB
Type for public folder
calendarcontactsplaintasksExample uses exchangeService = string, organizationName = string, path = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ email/ exchange/ {organizationName}/ service/ {exchangeService}/ publicFolder/ {path} \
-H "authorization: Bearer $OVH_TOKEN"{ "anonymousPermission": "editor", "creationDate": "2024-01-01T12:00:00Z", "defaultPermission": "editor", "hasSubFolders": true, "itemCount": 0, "lastAccessTime": "2024-01-01T12:00:00Z", "lastModificationTime": "2024-01-01T12:00:00Z", "lastUserAccessTime": "2024-01-01T12:00:00Z", "lastUserModificationTime": "2024-01-01T12:00:00Z", "path": "string", "quota": 0, "state": "creating", "taskPendingId": 0, "totalItemSize": 0, "type": "calendar"}
Create a public folderProduction
Create a public folder. Creates a calendar, contacts, plain or tasks public folder from its path and its quota in MB, and returns the task.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Request body (required)
Access right for the guest users
editornonereviewerDefault access right
editornonereviewerPath for public folder
Quota for public folder in MB
Type for public folder
calendarcontactsplaintasksResponse
Completion date
Function name
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016Task id
Task status
cancelleddoingdoneerrortodoCreation date
Example uses exchangeService = string, organizationName = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ email/ exchange/ {organizationName}/ service/ {exchangeService}/ publicFolder \
-H "authorization: Bearer $OVH_TOKEN"{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}
Delete a public folderProduction
Delete a public folder. Deletes the public folder with its content and permissions, and returns the task.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Path for public folder
Response
Completion date
Function name
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016Task id
Task status
cancelleddoingdoneerrortodoCreation date
Example uses exchangeService = string, organizationName = string, path = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ email/ exchange/ {organizationName}/ service/ {exchangeService}/ publicFolder/ {path} \
-H "authorization: Bearer $OVH_TOKEN"{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}
Update a public folderProduction
Update a public folder. Updates the quota of the public folder, in MB, and its default and anonymous permissions.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Path for public folder
Request body (required)
Access right for the guest users
editornonereviewerCreation date
Default access right
editornonereviewerIf true, this public folder has subfolders
Number of items in public folder
Time for which public folder was accessed for the last time
Time for which public folder was modified for the last time
Time for which public folder was accessed for the last time by the user
Time for which public folder was modified for the last time by the user
Path for public folder
Quota for public folder in MB
Current object state
creatingdeletinginternalMigrationokreopeningsuspendedsuspendingtask pending id
Sum of all items in public folder in MB
Type for public folder
calendarcontactsplaintasksResponse
Example uses exchangeService = string, organizationName = string, path = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ email/ exchange/ {organizationName}/ service/ {exchangeService}/ publicFolder/ {path} \
-H "authorization: Bearer $OVH_TOKEN"List public folder permissionsProduction
List public folder permissions. Returns the IDs of the accounts that have a permission on the public folder.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Path for public folder
Response
Example uses exchangeService = string, organizationName = string, path = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ email/ exchange/ {organizationName}/ service/ {exchangeService}/ publicFolder/ {path}/ permission \
-H "authorization: Bearer $OVH_TOKEN"[ 0]
Get a public folder permissionProduction
Get a public folder permission. Returns the ID of the account given access to the public folder, its access rights and its state.
Path parameters
Account id
The internal name of your exchange service
The internal name of your exchange organization
Path for public folder
Response
Access right set for the account
editornonereviewerAccount id
Creation date
Current object state
creatingdeletinginternalMigrationokreopeningsuspendedsuspendingtask pending id
Example uses allowedAccountId = 0, exchangeService = string, organizationName = string, path = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ email/ exchange/ {organizationName}/ service/ {exchangeService}/ publicFolder/ {path}/ permission/ {allowedAccountId} \
-H "authorization: Bearer $OVH_TOKEN"{ "accessRights": "editor", "allowedAccountId": 0, "creationDate": "2024-01-01T12:00:00Z", "state": "creating", "taskPendingId": 0}
Add a public folder permissionProduction
Add a public folder permission. Gives the account given by allowedAccountId the editor, reviewer or none access right on the public folder, and returns the task.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Path for public folder
Request body (required)
Access rights to be set for the account
editornonereviewerAccount id to have access to public folder
Response
Completion date
Function name
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016Task id
Task status
cancelleddoingdoneerrortodoCreation date
Example uses exchangeService = string, organizationName = string, path = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ email/ exchange/ {organizationName}/ service/ {exchangeService}/ publicFolder/ {path}/ permission \
-H "authorization: Bearer $OVH_TOKEN"{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}
Remove a public folder permissionProduction
Remove a public folder permission. Withdraws the access of the account to the public folder, and returns the task.
Path parameters
Account id
The internal name of your exchange service
The internal name of your exchange organization
Path for public folder
Response
Completion date
Function name
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016Task id
Task status
cancelleddoingdoneerrortodoCreation date
Example uses allowedAccountId = 0, exchangeService = string, organizationName = string, path = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ email/ exchange/ {organizationName}/ service/ {exchangeService}/ publicFolder/ {path}/ permission/ {allowedAccountId} \
-H "authorization: Bearer $OVH_TOKEN"{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}
Update a public folder permissionProduction
Update a public folder permission. Sets the access right of the account on the public folder: editor, reviewer or none.
Path parameters
Account id
The internal name of your exchange service
The internal name of your exchange organization
Path for public folder
Request body (required)
Access right set for the account
editornonereviewerAccount id
Creation date
Current object state
creatingdeletinginternalMigrationokreopeningsuspendedsuspendingtask pending id
Response
Example uses allowedAccountId = 0, exchangeService = string, organizationName = string, path = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ email/ exchange/ {organizationName}/ service/ {exchangeService}/ publicFolder/ {path}/ permission/ {allowedAccountId} \
-H "authorization: Bearer $OVH_TOKEN"Get the public folder quotaProduction
Get the public folder quota. Returns the total space of the public folders, the space already reserved and the space used, in MB.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Response
total amount of space in MB for public folders within organization
space in MB already reserved from the quota limit
currently used space in MB within all public folders
Example uses exchangeService = string, organizationName = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ email/ exchange/ {organizationName}/ service/ {exchangeService}/ publicFolderQuota \
-H "authorization: Bearer $OVH_TOKEN"{ "quotaLimit": 0, "quotaReserved": 0, "quotaUsed": 0}