service_send_connectors

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

Overview

Name	service_send_connectors
Type	Resource
Id	ovh.email_exchange.service_send_connectors

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Id of this send connector
task_pending_id	integer	Pending task for this send connector (wire: taskPendingId)
display_name	string	Name of your send connector (wire: displayName)
creation_date	string (date-time)	Creation date (wire: creationDate)
default	boolean	Default send connector, which is used to send all e-mails that are not handled by other send connectors that have been custom-created
dns_routing	boolean	Use dns MX record to route emails via this send connector (wire: dnsRouting)
last_update_date	string (date-time)	Last update date (wire: lastUpdateDate)
max_send_size	integer	Maximum send size in MB (wire: maxSendSize)
port	integer	Port adress that will be used to all e-mails send via this send connector
require_tls	boolean	All messages sent through this connector will be transmitted using TLS (wire: requireTLS)
smart_host	string	Relay domain address that will be used to all e-mails send via this send connector (wire: smartHost)
smart_host_auth_mechanism	string	Authentication mechanism to use for authentication with a smart host (basicAuth, basicAuthRequireTLS, none) (wire: smartHostAuthMechanism)
state	string	Send connector state (creating, deleting, internalMigration, ok, reopening, suspended, suspending)

list

Exchange Send Connector

Name	Datatype	Description
id	integer	Id of this send connector
task_pending_id	integer	Pending task for this send connector (wire: taskPendingId)
display_name	string	Name of your send connector (wire: displayName)
creation_date	string (date-time)	Creation date (wire: creationDate)
default	boolean	Default send connector, which is used to send all e-mails that are not handled by other send connectors that have been custom-created
dns_routing	boolean	Use dns MX record to route emails via this send connector (wire: dnsRouting)
last_update_date	string (date-time)	Last update date (wire: lastUpdateDate)
max_send_size	integer	Maximum send size in MB (wire: maxSendSize)
port	integer	Port adress that will be used to all e-mails send via this send connector
require_tls	boolean	All messages sent through this connector will be transmitted using TLS (wire: requireTLS)
smart_host	string	Relay domain address that will be used to all e-mails send via this send connector (wire: smartHost)
smart_host_auth_mechanism	string	Authentication mechanism to use for authentication with a smart host (basicAuth, basicAuthRequireTLS, none) (wire: smartHostAuthMechanism)
state	string	Send connector state (creating, deleting, internalMigration, ok, reopening, suspended, suspending)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	exchange_service, id, organization_name		Get a send connector. Returns the smart host, port, authentication mechanism, TLS requirement, size limit, DNS routing and state of the send connector.
list	select	exchange_service, organization_name	x_pagination_mode	List send connectors. Returns the IDs of the send connectors of the service, which relay outgoing emails through a smart host.
create	insert	exchange_service, organization_name, display_name, smart_host		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.
update	update	exchange_service, id, organization_name		Update a send connector. Updates the name, smart host, port, maximum send size, TLS requirement and DNS routing of the send connector.
delete	delete	exchange_service, id, organization_name		Delete a send connector. Deletes the send connector, so that outgoing emails no longer go through its smart host, and returns the task.
change_authentication	exec	exchangeService, id, organizationName		Change send connector authentication. Sets the smart host authentication mechanism, user and password of the send connector, 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"}})
exchangeService	string	The internal name of your exchange service
exchange_service	string	The internal name of your exchange service (wire: exchangeService)
id	integer	Id of this send connector
organizationName	string	The internal name of your exchange organization
organization_name	string	The internal name of your exchange organization (wire: organizationName)
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 send connector. Returns the smart host, port, authentication mechanism, TLS requirement, size limit, DNS routing and state of the send connector.

SELECT
id,
task_pending_id,
display_name,
creation_date,
default,
dns_routing,
last_update_date,
max_send_size,
port,
require_tls,
smart_host,
smart_host_auth_mechanism,
state
FROM ovh.email_exchange.service_send_connectors
WHERE exchange_service = '{{ exchange_service }}' -- required
AND id = '{{ id }}' -- required
AND organization_name = '{{ organization_name }}' -- required
;

list

List send connectors. Returns the IDs of the send connectors of the service, which relay outgoing emails through a smart host.

SELECT
id,
task_pending_id,
display_name,
creation_date,
default,
dns_routing,
last_update_date,
max_send_size,
port,
require_tls,
smart_host,
smart_host_auth_mechanism,
state
FROM ovh.email_exchange.service_send_connectors
WHERE exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

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.

INSERT INTO ovh.email_exchange.service_send_connectors (
display_name,
max_send_size,
password,
port,
require_tls,
smart_host,
smart_host_auth_mechanism,
user,
exchange_service,
organization_name
)
SELECT 
'{{ display_name }}' /* required */,
{{ max_send_size }},
'{{ password }}',
{{ port }},
{{ require_tls }},
'{{ smart_host }}' /* required */,
'{{ smart_host_auth_mechanism }}',
'{{ user }}',
'{{ exchange_service }}',
'{{ organization_name }}'
RETURNING
id,
finish_date,
function,
status,
todo_date
;

Manifest

# Description fields are for documentation purposes
- name: service_send_connectors
props:
  - name: exchange_service
    value: "{{ exchange_service }}"
    description: Required parameter for the service_send_connectors resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the service_send_connectors resource.
  - name: display_name
    value: "{{ display_name }}"
    description: |
      Name of your send connector
  - name: max_send_size
    value: {{ max_send_size }}
    description: |
      Maximum message size allowd on that send connector
  - name: password
    value: "{{ password }}"
    description: |
      Password that will be used to connect to smartHost
  - name: port
    value: {{ port }}
    description: |
      Port adress that will be used to all e-mails send via this send connector
  - name: require_tls
    value: {{ require_tls }}
    description: |
      All messages sent through this connector will be transmitted using TLS
  - name: smart_host
    value: "{{ smart_host }}"
    description: |
      Relay domain address that will be used to all e-mails send via this send connector
  - name: smart_host_auth_mechanism
    value: "{{ smart_host_auth_mechanism }}"
    description: |
      Authentication mechanism to use for authentication with a smart host
    valid_values: ['basicAuth', 'basicAuthRequireTLS', 'none']
  - name: user
    value: "{{ user }}"
    description: |
      User that will be used to connect to smartHost

UPDATE examples

update

Update a send connector. Updates the name, smart host, port, maximum send size, TLS requirement and DNS routing of the send connector.

UPDATE ovh.email_exchange.service_send_connectors
SET 
display_name = '{{ display_name }}',
dns_routing = {{ dns_routing }},
max_send_size = {{ max_send_size }},
port = {{ port }},
require_tls = {{ require_tls }},
smart_host = '{{ smart_host }}'
WHERE 
exchange_service = '{{ exchange_service }}' --required
AND id = '{{ id }}' --required
AND organization_name = '{{ organization_name }}' --required;

DELETE examples

delete

Delete a send connector. Deletes the send connector, so that outgoing emails no longer go through its smart host, and returns the task.

DELETE FROM ovh.email_exchange.service_send_connectors
WHERE exchange_service = '{{ exchange_service }}' --required
AND id = '{{ id }}' --required
AND organization_name = '{{ organization_name }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

change_authentication

Change send connector authentication. Sets the smart host authentication mechanism, user and password of the send connector, and returns the task.

EXEC ovh.email_exchange.service_send_connectors.change_authentication 
@exchangeService='{{ exchangeService }}' --required, 
@id='{{ id }}' --required, 
@organizationName='{{ organizationName }}' --required 
@@json=
'{
"password": "{{ password }}", 
"smartHostAuthMechanism": "{{ smartHostAuthMechanism }}", 
"user": "{{ user }}"
}'
;