Connectors
All operations require authentication.
List receive connectorsProduction
Returns the IDs of the receive connectors of the service.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Response
Example uses exchangeService = string, organizationName = string
$ curl https:/[ 0]
Get a receive connectorProduction
Returns the name, status, remote IP ranges, maximum message size and TLS requirement of the receive connector, and whether it is the default one.
Path parameters
The internal name of your exchange service
Id
The internal name of your exchange organization
Response
Whether this is the default receive connector owned by Exchange. Read-only: only its status can be changed, and it cannot be deleted
Whether the receive connector is enabled
Id of this receive connector
The maximum message size to state, in megabytes.
Name of your receive connector, in 255 characters at most
List of remote IP entries, replacing the stored list as a whole. Each entry is a single IP address, a CIDR network, or an inclusive 'start-end' range, in IPv4 or IPv6, and cannot be already declared by another receive connector of the service. The entries are joined by commas in 255 characters at most
All messages received through this connector must be transmitted using TLS
Example uses exchangeService = string, id = 0, organizationName = string
$ curl https:/{ "default": true, "enabled": true, "id": 0, "maxMessageSize": 0, "name": "string", "remoteIpRanges": [ "string" ], "requireTls": true}
Create a receive connectorProduction
Creates a receive connector for the senders in remoteIpRanges and returns the task. A remote IP entry already declared by another receive connector of the service is refused. The connector is disabled unless enabled is true.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Request body (required)
Whether the receive connector must be enabled. Defaults to false
The maximum message size to state, in megabytes.
Name of your receive connector, in 255 characters at most
List of remote IP entries. Each entry is a single IP address, a CIDR network, or an inclusive 'start-end' range, in IPv4 or IPv6, and cannot be already declared by another receive connector of the service. The entries are joined by commas in 255 characters at most
All messages received through this connector must be transmitted using TLS
Response
Completion date, null while the task is still running
Creation date
The operation the task performs
Task id
Task status
cancelleddoingdoneerrortodoExample uses exchangeService = string, organizationName = string
$ curl https:/{ "completedAt": "2024-01-01T12:00:00Z", "createdAt": "2024-01-01T12:00:00Z", "function": "string", "id": 0, "status": "cancelled"}
Delete a receive connectorProduction
Deletes the receive connector and returns the task. The default receive connector cannot be deleted. When the last non-default connector is deleted, the default one is enabled again unless enableDefaultReceiveConnector is false.
Path parameters
The internal name of your exchange service
Id
The internal name of your exchange organization
Query parameters
When the deleted connector is the last non-default connector of the service, re-enable the default receive connector once it is removed. Defaults to true
Response
Completion date, null while the task is still running
Creation date
The operation the task performs
Task id
Task status
cancelleddoingdoneerrortodoExample uses exchangeService = string, id = 0, organizationName = string
$ curl https:/{ "completedAt": "2024-01-01T12:00:00Z", "createdAt": "2024-01-01T12:00:00Z", "function": "string", "id": 0, "status": "cancelled"}
Update a receive connectorProduction
Replaces the whole configuration of the receive connector and returns the task. name, remoteIpRanges, requireTls and enabled are all required: use PATCH to change only some of them. The default receive connector accepts enabled only, so it always refuses a PUT.
Path parameters
The internal name of your exchange service
Id
The internal name of your exchange organization
Request body (required)
Whether the receive connector is enabled
The maximum message size to state, in megabytes.
Name of your receive connector, in 255 characters at most
List of remote IP entries, replacing the stored list as a whole. Each entry is a single IP address, a CIDR network, or an inclusive 'start-end' range, in IPv4 or IPv6, and cannot be already declared by another receive connector of the service. The entries are joined by commas in 255 characters at most
All messages received through this connector must be transmitted using TLS
Response
Completion date, null while the task is still running
Creation date
The operation the task performs
Task id
Task status
cancelleddoingdoneerrortodoExample uses exchangeService = string, id = 0, organizationName = string
$ curl https:/{ "completedAt": "2024-01-01T12:00:00Z", "createdAt": "2024-01-01T12:00:00Z", "function": "string", "id": 0, "status": "cancelled"}
Partially update a receive connectorProduction
Updates only the given properties and returns the task: the others keep their value, and an omitted enabled leaves the status unchanged. At least one property must be given. The default receive connector accepts enabled only.
Path parameters
The internal name of your exchange service
Id
The internal name of your exchange organization
Request body (required)
Whether this is the default receive connector owned by Exchange. Read-only: only its status can be changed, and it cannot be deleted
Whether the receive connector is enabled
Id of this receive connector
The maximum message size to state, in megabytes.
Name of your receive connector, in 255 characters at most
List of remote IP entries, replacing the stored list as a whole. Each entry is a single IP address, a CIDR network, or an inclusive 'start-end' range, in IPv4 or IPv6, and cannot be already declared by another receive connector of the service. The entries are joined by commas in 255 characters at most
All messages received through this connector must be transmitted using TLS
Response
Completion date, null while the task is still running
Creation date
The operation the task performs
Task id
Task status
cancelleddoingdoneerrortodoExample uses exchangeService = string, id = 0, organizationName = string
$ curl https:/{ "completedAt": "2024-01-01T12:00:00Z", "createdAt": "2024-01-01T12:00:00Z", "function": "string", "id": 0, "status": "cancelled"}
List send connectorsProduction
List send connectors. Returns the IDs of the send connectors of the service, which relay outgoing emails through a smart host.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Response
Example uses exchangeService = string, organizationName = string
$ curl https:/[ 0]
Get a send connectorProduction
Get a send connector. Returns the smart host, port, authentication mechanism, TLS requirement, size limit, DNS routing and state of the send connector.
Path parameters
The internal name of your exchange service
Id of this send connector
The internal name of your exchange organization
Response
Creation date
Default send connector, which is used to send all e-mails that are not handled by other send connectors that have been custom-created
Name of your send connector
Use dns MX record to route emails via this send connector
Id of this send connector
Last update date
Maximum send size in MB
Port adress that will be used to all e-mails send via this send connector
All messages sent through this connector will be transmitted using TLS
Relay domain address that will be used to all e-mails send via this send connector
Authentication mechanism to use for authentication with a smart host
basicAuthbasicAuthRequireTLSnoneSend connector state
creatingdeletinginternalMigrationokreopeningsuspendedsuspendingPending task for this send connector
Example uses exchangeService = string, id = 0, organizationName = string
$ curl https:/{ "creationDate": "2024-01-01T12:00:00Z", "default": true, "displayName": "string", "dnsRouting": true, "id": 0, "lastUpdateDate": "2024-01-01T12:00:00Z", "maxSendSize": 0, "port": 0, "requireTLS": true, "smartHost": "string", "smartHostAuthMechanism": "basicAuth", "state": "creating", "taskPendingId": 0}
Create a send connectorProduction
Create a send connector. Creates a send connector that relays emails through a smartHost, with an optional port, TLS and authentication, and returns the task.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Request body (required)
Name of your send connector
Maximum message size allowd on that send connector
Password that will be used to connect to smartHost
Port adress that will be used to all e-mails send via this send connector
All messages sent through this connector will be transmitted using TLS
Relay domain address that will be used to all e-mails send via this send connector
Authentication mechanism to use for authentication with a smart host
basicAuthbasicAuthRequireTLSnoneUser that will be used to connect to smartHost
Response
Completion date
Function name
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016Task id
Task status
cancelleddoingdoneerrortodoCreation date
Example uses exchangeService = string, organizationName = string
$ curl https:/{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}
Delete a send connectorProduction
Delete a send connector. Deletes the send connector, so that outgoing emails no longer go through its smart host, and returns the task.
Path parameters
The internal name of your exchange service
Id of this send connector
The internal name of your exchange organization
Response
Completion date
Function name
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016Task id
Task status
cancelleddoingdoneerrortodoCreation date
Example uses exchangeService = string, id = 0, organizationName = string
$ curl https:/{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}
Update a send connectorProduction
Update a send connector. Updates the name, smart host, port, maximum send size, TLS requirement and DNS routing of the send connector.
Path parameters
The internal name of your exchange service
Id of this send connector
The internal name of your exchange organization
Request body (required)
Creation date
Default send connector, which is used to send all e-mails that are not handled by other send connectors that have been custom-created
Name of your send connector
Use dns MX record to route emails via this send connector
Id of this send connector
Last update date
Maximum send size in MB
Port adress that will be used to all e-mails send via this send connector
All messages sent through this connector will be transmitted using TLS
Relay domain address that will be used to all e-mails send via this send connector
Authentication mechanism to use for authentication with a smart host
basicAuthbasicAuthRequireTLSnoneSend connector state
creatingdeletinginternalMigrationokreopeningsuspendedsuspendingPending task for this send connector
Response
Example uses exchangeService = string, id = 0, organizationName = string
$ curl https:/Change send connector authenticationProduction
Change send connector authentication. Sets the smart host authentication mechanism, user and password of the send connector, and returns the task.
Path parameters
The internal name of your exchange service
Id of this send connector
The internal name of your exchange organization
Request body (required)
New password
The SmartHostAuthMechanism parameter specifies the smart host authentication mechanism to use for authentication with a remote server
basicAuthbasicAuthRequireTLSnoneUser that will be used to connect to smartHost
Response
Completion date
Function name
activateSharepointaddAccountaddAccountArchiveaddAccountImpersonationaddActiveSyncMailNotificationaddAliasaddDistributionGroupaddDistributionGroupManageraddDistributionGroupMemberaddDistributionGroupSendAsaddDistributionGroupSendOnBehalfToaddDomainaddDomainDisclaimeraddExchangeCustomIsolationaddExchangeDomainDKIMaddExchangeRemoteMailboxaddExchangeServiceAuthorizedIpaddExportPstRequestaddExternalContactaddFullAccessaddOutlookLicenseaddPublicFolderaddPublicFolderPermissionaddResourceAccountaddResourceDelegateaddSendAsaddSendConnectoraddSendOnBehalfToaddSharedAccountaddSharedAccountFullAccessaddSharedAccountSendAsaddSharedAccountSendOnBehalfTochangeHostnamechangePasswordclearDataOnDevicecloneTemplateExchangePrivateconfigureExchangeCustomerconfigureExchangeOwaMfacopyMailboxcreateExternalAntiSpamReceiveConnectordeleteAccountdeleteAccountArchivedeleteAccountImpersonationdeleteActiveSyncMailNotificationdeleteAliasdeleteDistributionGroupdeleteDistributionGroupManagerdeleteDistributionGroupMemberdeleteDistributionGroupSendAsdeleteDistributionGroupSendOnBehalfTodeleteDomaindeleteDomainDisclaimerdeleteExchangeCustomIsolationdeleteExchangeDomainDKIMdeleteExchangeRemoteMailboxdeleteExchangeServicedeleteExchangeServiceAuthorizedIpdeleteExportPstRequestdeleteExternalAntiSpamReceiveConnectordeleteExternalContactdeleteFullAccessdeleteOutlookLicensedeletePublicFolderdeletePublicFolderPermissiondeleteResourceAccountdeleteResourceDelegatedeleteSendAsdeleteSendConnectordeleteSendOnBehalfTodeleteSharedAccountdeleteSharedAccountFullAccessdeleteSharedAccountSendAsdeleteSharedAccountSendOnBehalfTodestroyPrivateVmdiagnoseAccountdisableExchangeDKIMenableExchangeDKIMexpandDrivegenerateOutlookUrlgeneratePstUrlinstallExchangeinstallSSLmaintenancemigrationAccountmigrationDisclaimermigrationExternalContactmigrationHistorymigrationMailingListmigrationResourceAccountmigrationServicereOpenHostedAccountreOpenOutlookLicensereOpenPrivateAccountreOpenPrivateVmsetAccountsetAccountArchivesetAliassetDistributionGroupsetDnssetDomainsetDomainDisclaimersetExchangeAccountProtocolsetExchangeRemoteMailboxsetExchangeServiceDevicesetExternalAntiSpamReceiveConnectorsetExternalContactsetPublicFoldersetPublicFolderPermissionsetResourceAccountsetSendConnectorsetServicesetSharedAccountsuspendAccountsuspendExchangeServicesuspendHostedAccountsuspendOutlookLicensesuspendPrivateAccountsuspendPrivateVmunsuspendAccountunsuspendExchangeServiceunsuspendHostedAccountupdateExchangeServiceDeviceupgrade2016Task id
Task status
cancelleddoingdoneerrortodoCreation date
Example uses exchangeService = string, id = 0, organizationName = string
$ curl https:/{ "finishDate": "2024-01-01T12:00:00Z", "function": "activateSharepoint", "id": 0, "status": "cancelled", "todoDate": "2024-01-01T12:00:00Z"}