service_account_diagnostics

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

Overview

Name	service_account_diagnostics
Type	Resource
Id	ovh.email_exchange.service_account_diagnostics

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
can_receive_email	boolean	Determines if ingoing message has been received (wire: canReceiveEmail)
can_send_email	boolean	Determines if outgoing message has been delivered (wire: canSendEmail)
connective_owa	boolean	Determines if possible to authenticate with credentials (wire: connectiveOWA)
is_locked	boolean	Determines if account is locked (wire: isLocked)
is_mx_valid	boolean	Determines if MX record for account's domain is properly set (wire: isMxValid)
is_spammer	boolean	Determines if account is flagged as spammer (wire: isSpammer)
is_srv_valid	boolean	Determines if SRV (autodiscovery) record for account's domain is properly set (wire: isSrvValid)
is_suspended	boolean	Determines if account is suspended (wire: isSuspended)
last_check	string (date-time)	Last performed diagnostics date (wire: lastCheck)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	exchange_service, organization_name, primary_email_address		Get the account diagnosis. Returns the results of the last diagnosis of the email account: sending, receiving, webmail login, lock, suspension, spam flag, and MX and SRV records.
create	insert	exchange_service, organization_name, primary_email_address, password		Run an account diagnosis. Starts a diagnosis of the email account, which needs its password, and returns the task.

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"}})
exchange_service	string	The internal name of your exchange service (wire: exchangeService)
organization_name	string	The internal name of your exchange organization (wire: organizationName)
primary_email_address	string	Default email for this mailbox (wire: primaryEmailAddress)

SELECT examples

get

Get the account diagnosis. Returns the results of the last diagnosis of the email account: sending, receiving, webmail login, lock, suspension, spam flag, and MX and SRV records.

SELECT
can_receive_email,
can_send_email,
connective_owa,
is_locked,
is_mx_valid,
is_spammer,
is_srv_valid,
is_suspended,
last_check
FROM ovh.email_exchange.service_account_diagnostics
WHERE exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND primary_email_address = '{{ primary_email_address }}' -- required
;

INSERT examples

create

Run an account diagnosis. Starts a diagnosis of the email account, which needs its password, and returns the task.

INSERT INTO ovh.email_exchange.service_account_diagnostics (
password,
exchange_service,
organization_name,
primary_email_address
)
SELECT 
'{{ password }}' /* required */,
'{{ exchange_service }}',
'{{ organization_name }}',
'{{ primary_email_address }}'
RETURNING
id,
finish_date,
function,
status,
todo_date
;

Manifest

# Description fields are for documentation purposes
- name: service_account_diagnostics
props:
  - name: exchange_service
    value: "{{ exchange_service }}"
    description: Required parameter for the service_account_diagnostics resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the service_account_diagnostics resource.
  - name: primary_email_address
    value: "{{ primary_email_address }}"
    description: Required parameter for the service_account_diagnostics resource.
  - name: password
    value: "{{ password }}"
    description: |
      Account password