account_migrate_destination_email_addresses

Creates, updates, deletes, gets or lists an account_migrate_destination_email_addresses resource.

Overview

Name	account_migrate_destination_email_addresses
Type	Resource
Id	ovh.email_domain.account_migrate_destination_email_addresses

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
destination_email_address	string	Destination account name (wire: destinationEmailAddress)
quota	integer	Account maximum size

list

Migration account

Name	Datatype	Description
destination_email_address	string	Destination account name (wire: destinationEmailAddress)
quota	integer	Account maximum size

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_name, destination_email_address, destination_service_name, domain		Get a destination email account. Returns the email address and maximum size of the destination account. (Beta version)
list	select	account_name, destination_service_name, domain	quota, x_pagination_mode	List destination email accounts. Returns the email addresses of the destination service the email account can be migrated to. Filter them by minimum size with quota. (Beta version)
migrate	exec	accountName, destinationEmailAddress, destinationServiceName, domain, password		Migrate an email account. Migrates the email account to the destination account and returns the task. password is the new password used for the migration. (Beta version)

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
accountName	string	Name of account
account_name	string	Name of account (wire: accountName)
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
destinationEmailAddress	string	Destination account name
destinationServiceName	string	Service name allowed as migration destination
destination_email_address	string	Destination account name (wire: destinationEmailAddress)
destination_service_name	string	Service name allowed as migration destination (wire: destinationServiceName)
domain	string	Name of your domain name
quota	integer	Account maximum size
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get a destination email account. Returns the email address and maximum size of the destination account. (Beta version)

SELECT
destination_email_address,
quota
FROM ovh.email_domain.account_migrate_destination_email_addresses
WHERE account_name = '{{ account_name }}' -- required
AND destination_email_address = '{{ destination_email_address }}' -- required
AND destination_service_name = '{{ destination_service_name }}' -- required
AND domain = '{{ domain }}' -- required
;

list

List destination email accounts. Returns the email addresses of the destination service the email account can be migrated to. Filter them by minimum size with quota. (Beta version)

SELECT
destination_email_address,
quota
FROM ovh.email_domain.account_migrate_destination_email_addresses
WHERE account_name = '{{ account_name }}' -- required
AND destination_service_name = '{{ destination_service_name }}' -- required
AND domain = '{{ domain }}' -- required
AND quota = '{{ quota }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

migrate

Migrate an email account. Migrates the email account to the destination account and returns the task. password is the new password used for the migration. (Beta version)

EXEC ovh.email_domain.account_migrate_destination_email_addresses.migrate 
@accountName='{{ accountName }}' --required, 
@destinationEmailAddress='{{ destinationEmailAddress }}' --required, 
@destinationServiceName='{{ destinationServiceName }}' --required, 
@domain='{{ domain }}' --required 
@@json=
'{
"password": "{{ password }}"
}'
;