Skip to content
Console(the OVHcloud Console, opens in a new tab)

Remote Mailboxes

All operations require authentication.

10 operationsv1/email/exchange
OpenAPI
Agent setup

List remote mailboxesProduction

GET
/1.0/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox

List remote mailboxes. Returns the primary email addresses of the remote mailboxes. Filter them by primaryEmailAddress or id.

Path parameters

exchangeService
required
string

The internal name of your exchange service

organizationName
required
string

The internal name of your exchange organization

Query parameters

id
integer

Filter the value of id property (like)

primaryEmailAddress
string

Filter the value of primaryEmailAddress property (like)

Response

200string[]successful operation

Example uses exchangeService = string, organizationName = string

$ curl https://api.eu.ovhcloud.com/1.0/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  "string"]

Get a remote mailboxProduction

GET
/1.0/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}

Get a remote mailbox. Returns the login, names, type, remote routing address, state, spam settings and contact details of the remote mailbox.

Path parameters

exchangeService
required
string

The internal name of your exchange service

organizationName
required
string

The internal name of your exchange organization

primaryEmailAddress
required
string

Default email for this mailbox

Response

200exchangeRemoteMailboxsuccessful operation
SAMAccountName
read-only
string

SAM account name

city
string

city

company
string

Company name

countryCode
CountryCodeEnum

Country code

ValuesACADAEAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDGDJDKDMDODZEAECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHNHRHTHUICIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTATCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSXKYEYTZAZMZW
creationDate
read-only
stringdate-time

Creation date

description
string

Description

displayName
string

Remote mailbox display name

domain
string

Remote mailbox domain

exchangeGuid
read-only
string

exchangeGuid for manual configuration

fax
phoneNumber

Fax number

firstName
string

Remote mailbox first name

guid
read-only
string

GUID for user in active directory

hiddenFromGAL
boolean

Hide remote mailbox in Global Address List

id
read-only
integer

Remote mailbox id

initial
string

Remote mailbox initials

jobDepartment
string

Job Department

jobTitle
string

Job title

lastName
string

Remote mailbox last name

login
string

Remote mailbox login

mobile
phoneNumber

Mobile phone

numberOfAliases
read-only
integer

Count the number of related aliases attached to this account

office
string

Job office

phone
phoneNumber

Phone number

postalCode
string

Postal code

primaryEmailAddress
read-only
string

Default email for this mailbox

region
string

region

remoteRoutingAddress
read-only
string

Email address of associated mailbox

spamAndVirusConfiguration
spamAndVirusConfiguration

Spam and Antivirus configuration

state
read-only
ObjectStateEnum

Remote mailbox state

ValuescreatingdeletinginternalMigrationokreopeningsuspendedsuspending
streetAddress
string

Street address

taskPendingId
read-only
integer

Pending task for this remote mailbox

type
read-only
ExchangeRemoteMailboxTypeEnum

Type of mailbox

Valuesequipmentregularroom

Example uses exchangeService = string, organizationName = string, primaryEmailAddress = string

$ curl https://api.eu.ovhcloud.com/1.0/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "SAMAccountName": "string",  "city": "string",  "company": "string",  "countryCode": "AC",  "creationDate": "2024-01-01T12:00:00Z",  "description": "string",  "displayName": "string",  "domain": "string",  "exchangeGuid": "string",  "fax": "string",  "firstName": "string",  "guid": "string",  "hiddenFromGAL": true,  "id": 0,  "initial": "string",  "jobDepartment": "string",  "jobTitle": "string",  "lastName": "string",  "login": "string",  "mobile": "string",  "numberOfAliases": 0,  "office": "string",  "phone": "string",  "postalCode": "string",  "primaryEmailAddress": "string",  "region": "string",  "remoteRoutingAddress": "string",  "spamAndVirusConfiguration": {    "checkDKIM": true,    "checkSPF": true,    "deleteSpam": true,    "deleteVirus": true,    "putInJunk": true,    "tagSpam": true,    "tagVirus": true  },  "state": "creating",  "streetAddress": "string",  "taskPendingId": 0,  "type": "equipment"}

Create a remote mailboxProduction

POST
/1.0/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox

Create a remote mailbox. Creates a regular, room or equipment remote mailbox from a login, a domain, a password, an exchangeGuid and the remoteRoutingAddress of the associated mailbox, and returns the task.

Path parameters

exchangeService
required
string

The internal name of your exchange service

organizationName
required
string

The internal name of your exchange organization

Request body (required)

city
string

City

company
string

Company name

countryCode
CountryCodeEnum

Country code

ValuesACADAEAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDGDJDKDMDODZEAECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHNHRHTHUICIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTATCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSXKYEYTZAZMZW
description
string

Description

displayName
string

Display name

domain
required
string

Email domain

exchangeGuid
required
string

Remote exchangeGuid

fax
phoneNumber

Fax number

firstName
string

First name

hiddenFromGAL
boolean

Hide the remote mailbox in Global Address List

initials
string

Initials

jobDepartment
string

Job department

jobTitle
string

Job title

lastName
string

Last name

login
required
string

Login

mobile
phoneNumber

Mobile phone number

office
string

Office

password
required
stringpassword

Password

phone
phoneNumber

Phone Number

postalCode
string

Postal code

region
string

Region

remoteRoutingAddress
required
string

Address of associated mailbox

spamAndVirusConfiguration
spamAndVirusConfiguration

Antispam and Antivirus configuration

streetAddress
string

Street address

type
required
ExchangeRemoteMailboxTypeEnum

Type of mailbox

Valuesequipmentregularroom

Response

200Tasksuccessful operation
finishDate
read-only
stringdate-time

Completion date

function
read-only
TaskFunctionEnum

Function name

ValuesactivateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016
id
read-only
integer

Task id

status
read-only
TaskStatusEnum

Task status

Valuescancelleddoingdoneerrortodo
todoDate
read-only
stringdate-time

Creation date

Example uses exchangeService = string, organizationName = string

$ curl https://api.eu.ovhcloud.com/1.0/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "finishDate": "2024-01-01T12:00:00Z",  "function": "activateSharepoint",  "id": 0,  "status": "cancelled",  "todoDate": "2024-01-01T12:00:00Z"}

Delete a remote mailboxProduction

DELETE
/1.0/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}

Delete a remote mailbox. Removes the remote mailbox from the Exchange service and returns the task. Its aliases are removed with it.

Path parameters

exchangeService
required
string

The internal name of your exchange service

organizationName
required
string

The internal name of your exchange organization

primaryEmailAddress
required
string

Default email for this mailbox

Response

200Tasksuccessful operation
finishDate
read-only
stringdate-time

Completion date

function
read-only
TaskFunctionEnum

Function name

ValuesactivateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016
id
read-only
integer

Task id

status
read-only
TaskStatusEnum

Task status

Valuescancelleddoingdoneerrortodo
todoDate
read-only
stringdate-time

Creation date

Example uses exchangeService = string, organizationName = string, primaryEmailAddress = string

$ curl https://api.eu.ovhcloud.com/1.0/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "finishDate": "2024-01-01T12:00:00Z",  "function": "activateSharepoint",  "id": 0,  "status": "cancelled",  "todoDate": "2024-01-01T12:00:00Z"}

Update a remote mailboxProduction

PUT
/1.0/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}

Update a remote mailbox. Updates the names, display name, spam settings, Global Address List visibility and contact details of the remote mailbox.

Path parameters

exchangeService
required
string

The internal name of your exchange service

organizationName
required
string

The internal name of your exchange organization

primaryEmailAddress
required
string

Default email for this mailbox

Request body (required)

SAMAccountName
read-only
string

SAM account name

city
string

city

company
string

Company name

countryCode
CountryCodeEnum

Country code

ValuesACADAEAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDGDJDKDMDODZEAECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHNHRHTHUICIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTATCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSXKYEYTZAZMZW
creationDate
read-only
stringdate-time

Creation date

description
string

Description

displayName
string

Remote mailbox display name

domain
string

Remote mailbox domain

exchangeGuid
read-only
string

exchangeGuid for manual configuration

fax
phoneNumber

Fax number

firstName
string

Remote mailbox first name

guid
read-only
string

GUID for user in active directory

hiddenFromGAL
boolean

Hide remote mailbox in Global Address List

id
read-only
integer

Remote mailbox id

initial
string

Remote mailbox initials

jobDepartment
string

Job Department

jobTitle
string

Job title

lastName
string

Remote mailbox last name

login
string

Remote mailbox login

mobile
phoneNumber

Mobile phone

numberOfAliases
read-only
integer

Count the number of related aliases attached to this account

office
string

Job office

phone
phoneNumber

Phone number

postalCode
string

Postal code

primaryEmailAddress
read-only
string

Default email for this mailbox

region
string

region

remoteRoutingAddress
read-only
string

Email address of associated mailbox

spamAndVirusConfiguration
spamAndVirusConfiguration

Spam and Antivirus configuration

state
read-only
ObjectStateEnum

Remote mailbox state

ValuescreatingdeletinginternalMigrationokreopeningsuspendedsuspending
streetAddress
string

Street address

taskPendingId
read-only
integer

Pending task for this remote mailbox

type
read-only
ExchangeRemoteMailboxTypeEnum

Type of mailbox

Valuesequipmentregularroom

Response

200—successful operation

Example uses exchangeService = string, organizationName = string, primaryEmailAddress = string

$ curl https://api.eu.ovhcloud.com/1.0/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress} \
  -H "authorization: Bearer $OVH_TOKEN"

List remote mailbox aliasesProduction

GET
/1.0/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}/alias

List remote mailbox aliases. Returns the aliases of the remote mailbox: extra addresses that deliver to the same mailbox.

Path parameters

exchangeService
required
string

The internal name of your exchange service

organizationName
required
string

The internal name of your exchange organization

primaryEmailAddress
required
string

Default email for this mailbox

Response

200string[]successful operation

Example uses exchangeService = string, organizationName = string, primaryEmailAddress = string

$ curl https://api.eu.ovhcloud.com/1.0/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}/alias \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  "string"]

Get a remote mailbox aliasProduction

GET
/1.0/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}/alias/{alias}

Get a remote mailbox alias. Returns the alias address, its creation date and the ID of its pending task, if any (taskPendingId).

Path parameters

alias
required
string

Alias

exchangeService
required
string

The internal name of your exchange service

organizationName
required
string

The internal name of your exchange organization

primaryEmailAddress
required
string

Default email for this mailbox

Response

200exchangeRemoteMailboxAliassuccessful operation
alias
read-only
string

Alias

creationDate
read-only
stringdate-time

Creation date

taskPendingId
read-only
integer

Pending task id

Example uses alias = string, exchangeService = string, organizationName = string, primaryEmailAddress = string

$ curl https://api.eu.ovhcloud.com/1.0/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}/alias/{alias} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "alias": "string",  "creationDate": "2024-01-01T12:00:00Z",  "taskPendingId": 0}

Create a remote mailbox aliasProduction

POST
/1.0/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}/alias

Create a remote mailbox alias. Adds the alias address to the remote mailbox, so that it receives its emails, and returns the task.

Path parameters

exchangeService
required
string

The internal name of your exchange service

organizationName
required
string

The internal name of your exchange organization

primaryEmailAddress
required
string

Default email for this mailbox

Request body (required)

alias
required
string

Alias

Response

200Tasksuccessful operation
finishDate
read-only
stringdate-time

Completion date

function
read-only
TaskFunctionEnum

Function name

ValuesactivateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016
id
read-only
integer

Task id

status
read-only
TaskStatusEnum

Task status

Valuescancelleddoingdoneerrortodo
todoDate
read-only
stringdate-time

Creation date

Example uses exchangeService = string, organizationName = string, primaryEmailAddress = string

$ curl https://api.eu.ovhcloud.com/1.0/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}/alias \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "finishDate": "2024-01-01T12:00:00Z",  "function": "activateSharepoint",  "id": 0,  "status": "cancelled",  "todoDate": "2024-01-01T12:00:00Z"}

Delete a remote mailbox aliasProduction

DELETE
/1.0/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}/alias/{alias}

Delete a remote mailbox alias. Removes the alias address from the remote mailbox, which no longer receives its emails, and returns the task.

Path parameters

alias
required
string

Alias

exchangeService
required
string

The internal name of your exchange service

organizationName
required
string

The internal name of your exchange organization

primaryEmailAddress
required
string

Default email for this mailbox

Response

200Tasksuccessful operation
finishDate
read-only
stringdate-time

Completion date

function
read-only
TaskFunctionEnum

Function name

ValuesactivateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016
id
read-only
integer

Task id

status
read-only
TaskStatusEnum

Task status

Valuescancelleddoingdoneerrortodo
todoDate
read-only
stringdate-time

Creation date

Example uses alias = string, exchangeService = string, organizationName = string, primaryEmailAddress = string

$ curl https://api.eu.ovhcloud.com/1.0/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}/alias/{alias} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "finishDate": "2024-01-01T12:00:00Z",  "function": "activateSharepoint",  "id": 0,  "status": "cancelled",  "todoDate": "2024-01-01T12:00:00Z"}

Change a remote mailbox passwordProduction

POST
/1.0/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}/changePassword

Change a remote mailbox password. Changes the password and returns the task. Set forcePasswordChangeAtNextLogon to make the user change it at the next logon.

Path parameters

exchangeService
required
string

The internal name of your exchange service

organizationName
required
string

The internal name of your exchange organization

primaryEmailAddress
required
string

Default email for this mailbox

Request body (required)

forcePasswordChangeAtNextLogon
boolean

The password will need to be changed at the next time you log on

password
stringpassword

New password

Response

200Tasksuccessful operation
finishDate
read-only
stringdate-time

Completion date

function
read-only
TaskFunctionEnum

Function name

ValuesactivateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016
id
read-only
integer

Task id

status
read-only
TaskStatusEnum

Task status

Valuescancelleddoingdoneerrortodo
todoDate
read-only
stringdate-time

Creation date

Example uses exchangeService = string, organizationName = string, primaryEmailAddress = string

$ curl https://api.eu.ovhcloud.com/1.0/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}/changePassword \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "finishDate": "2024-01-01T12:00:00Z",  "function": "activateSharepoint",  "id": 0,  "status": "cancelled",  "todoDate": "2024-01-01T12:00:00Z"}