hosted_email_services

Creates, updates, deletes, gets or lists a hosted_email_services resource.

Overview

Name	hosted_email_services
Type	Resource
Id	ovh.pack_xdsl.hosted_email_services

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
domain	string

list

Hosted email services

Name	Datatype	Description
domain	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	domain, pack_name		Get a hosted email service of an xDSL pack. Returns the domain of a hosted email service activated with the pack.
list	select	pack_name	x_pagination_mode	List the hosted email services of an xDSL pack. Returns the domains of the hosted email services activated with the pack.
create	insert	pack_name, email, password		Create a hosted email service in an xDSL pack. Activates a hosted email account from an email address and a password. Returns the task that performs it.
delete	delete	domain, pack_name		Delete a hosted email service of an xDSL pack. Deletes the hosted email account and its mailbox from the pack.
change_password	exec	domain, packName, password		Change the password of a hosted email service. Sets a new password for the hosted email account of the xDSL pack.

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
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"}})
domain	string
packName	string	The internal name of your pack
pack_name	string	The internal name of your pack (wire: packName)
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 hosted email service of an xDSL pack. Returns the domain of a hosted email service activated with the pack.

SELECT
domain
FROM ovh.pack_xdsl.hosted_email_services
WHERE domain = '{{ domain }}' -- required
AND pack_name = '{{ pack_name }}' -- required
;

list

List the hosted email services of an xDSL pack. Returns the domains of the hosted email services activated with the pack.

SELECT
domain
FROM ovh.pack_xdsl.hosted_email_services
WHERE pack_name = '{{ pack_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a hosted email service in an xDSL pack. Activates a hosted email account from an email address and a password. Returns the task that performs it.

INSERT INTO ovh.pack_xdsl.hosted_email_services (
email,
password,
pack_name
)
SELECT 
'{{ email }}' /* required */,
'{{ password }}' /* required */,
'{{ pack_name }}'
RETURNING
id,
function,
status,
update_date
;

Manifest

# Description fields are for documentation purposes
- name: hosted_email_services
props:
  - name: pack_name
    value: "{{ pack_name }}"
    description: Required parameter for the hosted_email_services resource.
  - name: email
    value: "{{ email }}"
    description: |
      Email address
  - name: password
    value: "{{ password }}"
    description: |
      Password

DELETE examples

delete

Delete a hosted email service of an xDSL pack. Deletes the hosted email account and its mailbox from the pack.

DELETE FROM ovh.pack_xdsl.hosted_email_services
WHERE domain = '{{ domain }}' --required
AND pack_name = '{{ pack_name }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

change_password

Change the password of a hosted email service. Sets a new password for the hosted email account of the xDSL pack.

EXEC ovh.pack_xdsl.hosted_email_services.change_password 
@domain='{{ domain }}' --required, 
@packName='{{ packName }}' --required 
@@json=
'{
"password": "{{ password }}"
}'
;