service_accounts

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

Overview

Name	service_accounts
Type	Resource
Id	ovh.email_exchange.service_accounts

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Account id
authentication_policy_id	integer	ID of the authentication policy to apply on this account (wire: authenticationPolicyId)
custom_isolation_id	integer	custom isolation apply on this account (wire: customIsolationId)
send_connector_id	integer	Custom sendConnectorId used to send mails when SBR is configured (wire: sendConnectorId)
task_pending_id	integer	Pending task for this account (wire: taskPendingId)
display_name	string	Account display name (wire: displayName)
first_name	string	Account first name (wire: firstName)
last_name	string	Account last name (wire: lastName)
sam_account_name	string	SAM account name (wire: SAMAccountName)
account_license	string	Exchange account type (basic, enterprise, standard) (wire: accountLicense)
city	string	city
company	string	Company name
configured	boolean	Indicates if the account is configured
country_code	string	Country code (AC, AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW) (wire: countryCode)
creation_date	string (date-time)	Creation date (wire: creationDate)
current_usage	integer	Mailbox usage (wire: currentUsage)
delete_at_expiration	boolean	delete at expiration (wire: deleteAtExpiration)
delete_outlook_at_expiration	boolean	delete outlook at expiration (wire: deleteOutlookAtExpiration)
description	string	Description
domain	string	Email domain
exchange_guid	string	exchangeGuid for manual configuration (wire: exchangeGuid)
expiration_date	string (date-time)	expiration date (wire: expirationDate)
expiration_outlook_date	string (date-time)	expiration date (wire: expirationOutlookDate)
fax	string (phone-number)	Fax number
forwarding_email	string	Email address to forward email (wire: forwardingEmail)
guid	string	GUID for user in active directory
hidden_from_gal	boolean	Hide account in Global Address List (wire: hiddenFromGAL)
initial	string	Account initials
job_department	string	Job Department (wire: jobDepartment)
job_title	string	Job title (wire: jobTitle)
last_logoff_date	string (date-time)	Last logoff (wire: lastLogoffDate)
last_logon_date	string (date-time)	Last logon (wire: lastLogonDate)
last_update_date	string (date-time)	Last update (wire: lastUpdateDate)
litigation	boolean	Litigation hold feature enabled on this mailbox
litigation_period	integer	Litigation hold period in days (0 means unlimited). This setting covers all items in the mailbox. (wire: litigationPeriod)
login	string	Account login
mail_sender_display	string	Email display as sender (wire: mailSenderDisplay)
mailing_filter	array	Enable or disable anti-virus and anti-spam (wire: mailingFilter)
mobile	string (phone-number)	Mobile phone
number_of_aliases	integer	Count the number of related aliases attached to this account (wire: numberOfAliases)
office	string	Job office
outlook_license	boolean	Outlook licence (wire: outlookLicense)
owa_limited	boolean	OWA policy restriction is applied (wire: owaLimited)
password_last_update	string (date-time)	Time of account's password last update (wire: passwordLastUpdate)
phone	string (phone-number)	Phone number
postal_code	string	Postal code (wire: postalCode)
primary_email_address	string	Default email for this mailbox (wire: primaryEmailAddress)
quota	integer	Account maximum size
region	string	region
renew_outlook_period	string	change the renew period for outlook (monthly, yearly) (wire: renewOutlookPeriod)
renew_period	string	change the renew period (monthly, yearly) (wire: renewPeriod)
sbr_destination	string	Relay domain address that will be used to all e-mails send from this account (wire: sbrDestination)
spam_and_virus_configuration	object	Spam and Antivirus configuration (wire: spamAndVirusConfiguration)
spam_detected	boolean	Account was sending spam (wire: spamDetected)
spam_ticket_number	integer	Ticket number of spam detection (wire: spamTicketNumber)
state	string	Account state (creating, deleting, internalMigration, ok, reopening, suspended, suspending)
store_copy_of_email	boolean	Store copy of email when forward is enable (wire: storeCopyOfEmail)
street_address	string	Street address (wire: streetAddress)

list

Exchange mailbox

Name	Datatype	Description
id	integer	Account id
authentication_policy_id	integer	ID of the authentication policy to apply on this account (wire: authenticationPolicyId)
custom_isolation_id	integer	custom isolation apply on this account (wire: customIsolationId)
send_connector_id	integer	Custom sendConnectorId used to send mails when SBR is configured (wire: sendConnectorId)
task_pending_id	integer	Pending task for this account (wire: taskPendingId)
display_name	string	Account display name (wire: displayName)
first_name	string	Account first name (wire: firstName)
last_name	string	Account last name (wire: lastName)
sam_account_name	string	SAM account name (wire: SAMAccountName)
account_license	string	Exchange account type (basic, enterprise, standard) (wire: accountLicense)
city	string	city
company	string	Company name
configured	boolean	Indicates if the account is configured
country_code	string	Country code (AC, AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW) (wire: countryCode)
creation_date	string (date-time)	Creation date (wire: creationDate)
current_usage	integer	Mailbox usage (wire: currentUsage)
delete_at_expiration	boolean	delete at expiration (wire: deleteAtExpiration)
delete_outlook_at_expiration	boolean	delete outlook at expiration (wire: deleteOutlookAtExpiration)
description	string	Description
domain	string	Email domain
exchange_guid	string	exchangeGuid for manual configuration (wire: exchangeGuid)
expiration_date	string (date-time)	expiration date (wire: expirationDate)
expiration_outlook_date	string (date-time)	expiration date (wire: expirationOutlookDate)
fax	string (phone-number)	Fax number
forwarding_email	string	Email address to forward email (wire: forwardingEmail)
guid	string	GUID for user in active directory
hidden_from_gal	boolean	Hide account in Global Address List (wire: hiddenFromGAL)
initial	string	Account initials
job_department	string	Job Department (wire: jobDepartment)
job_title	string	Job title (wire: jobTitle)
last_logoff_date	string (date-time)	Last logoff (wire: lastLogoffDate)
last_logon_date	string (date-time)	Last logon (wire: lastLogonDate)
last_update_date	string (date-time)	Last update (wire: lastUpdateDate)
litigation	boolean	Litigation hold feature enabled on this mailbox
litigation_period	integer	Litigation hold period in days (0 means unlimited). This setting covers all items in the mailbox. (wire: litigationPeriod)
login	string	Account login
mail_sender_display	string	Email display as sender (wire: mailSenderDisplay)
mailing_filter	array	Enable or disable anti-virus and anti-spam (wire: mailingFilter)
mobile	string (phone-number)	Mobile phone
number_of_aliases	integer	Count the number of related aliases attached to this account (wire: numberOfAliases)
office	string	Job office
outlook_license	boolean	Outlook licence (wire: outlookLicense)
owa_limited	boolean	OWA policy restriction is applied (wire: owaLimited)
password_last_update	string (date-time)	Time of account's password last update (wire: passwordLastUpdate)
phone	string (phone-number)	Phone number
postal_code	string	Postal code (wire: postalCode)
primary_email_address	string	Default email for this mailbox (wire: primaryEmailAddress)
quota	integer	Account maximum size
region	string	region
renew_outlook_period	string	change the renew period for outlook (monthly, yearly) (wire: renewOutlookPeriod)
renew_period	string	change the renew period (monthly, yearly) (wire: renewPeriod)
sbr_destination	string	Relay domain address that will be used to all e-mails send from this account (wire: sbrDestination)
spam_and_virus_configuration	object	Spam and Antivirus configuration (wire: spamAndVirusConfiguration)
spam_detected	boolean	Account was sending spam (wire: spamDetected)
spam_ticket_number	integer	Ticket number of spam detection (wire: spamTicketNumber)
state	string	Account state (creating, deleting, internalMigration, ok, reopening, suspended, suspending)
store_copy_of_email	boolean	Store copy of email when forward is enable (wire: storeCopyOfEmail)
street_address	string	Street address (wire: streetAddress)

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 an email account. Returns the login, names, license, quota, usage, state, spam settings, forwarding, litigation hold and contact details of the email account.
list	select	exchange_service, organization_name	account_license, company, id, primary_email_address, x_pagination_mode	List email accounts. Returns the primary email addresses of the email accounts. Filter them by primaryEmailAddress, id, accountLicense or company.
create	insert	exchange_service, organization_name, domain, license, login, password		Create an email account. Creates an email account from a login, a domain, a password and a license, and returns the task. Set quota in GB.
update	update	exchange_service, organization_name, primary_email_address		Update an email account. Updates the names, license, quota, renewal, forwarding, litigation hold, spam settings, authentication policy and contact details of the email account.
delete	delete	exchange_service, organization_name, primary_email_address		Delete an email account. Deletes the email account and returns the task. On Hosted Exchange, the account is reset instead: its content is deleted and it becomes an unconfigured slot in configureme.me that keeps its subscription.
change_password	exec	exchangeService, organizationName, primaryEmailAddress		Change an email account password. Changes the password and returns the task. Set forcePasswordChangeAtNextLogon to make the user change it at the next logon.
terminate	exec	exchangeService, organizationName, primaryEmailAddress		Terminate an email account at expiration. Sets the email account to be suspended at its expiration date, and returns a message giving that date. Set deleteAtExpiration to false on the account to cancel.

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)
organizationName	string	The internal name of your exchange organization
organization_name	string	The internal name of your exchange organization (wire: organizationName)
primaryEmailAddress	string	Default email for this mailbox
primary_email_address	string	Default email for this mailbox (wire: primaryEmailAddress)
account_license	string	Filter the value of accountLicense property (=) (wire: accountLicense)
company	string	Filter the value of company property (like)
id	integer	Filter the value of id property (like)
primary_email_address	string	Filter the value of primaryEmailAddress property (like) (wire: primaryEmailAddress)
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 an email account. Returns the login, names, license, quota, usage, state, spam settings, forwarding, litigation hold and contact details of the email account.

SELECT
id,
authentication_policy_id,
custom_isolation_id,
send_connector_id,
task_pending_id,
display_name,
first_name,
last_name,
sam_account_name,
account_license,
city,
company,
configured,
country_code,
creation_date,
current_usage,
delete_at_expiration,
delete_outlook_at_expiration,
description,
domain,
exchange_guid,
expiration_date,
expiration_outlook_date,
fax,
forwarding_email,
guid,
hidden_from_gal,
initial,
job_department,
job_title,
last_logoff_date,
last_logon_date,
last_update_date,
litigation,
litigation_period,
login,
mail_sender_display,
mailing_filter,
mobile,
number_of_aliases,
office,
outlook_license,
owa_limited,
password_last_update,
phone,
postal_code,
primary_email_address,
quota,
region,
renew_outlook_period,
renew_period,
sbr_destination,
spam_and_virus_configuration,
spam_detected,
spam_ticket_number,
state,
store_copy_of_email,
street_address
FROM ovh.email_exchange.service_accounts
WHERE exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND primary_email_address = '{{ primary_email_address }}' -- required
;

list

List email accounts. Returns the primary email addresses of the email accounts. Filter them by primaryEmailAddress, id, accountLicense or company.

SELECT
id,
authentication_policy_id,
custom_isolation_id,
send_connector_id,
task_pending_id,
display_name,
first_name,
last_name,
sam_account_name,
account_license,
city,
company,
configured,
country_code,
creation_date,
current_usage,
delete_at_expiration,
delete_outlook_at_expiration,
description,
domain,
exchange_guid,
expiration_date,
expiration_outlook_date,
fax,
forwarding_email,
guid,
hidden_from_gal,
initial,
job_department,
job_title,
last_logoff_date,
last_logon_date,
last_update_date,
litigation,
litigation_period,
login,
mail_sender_display,
mailing_filter,
mobile,
number_of_aliases,
office,
outlook_license,
owa_limited,
password_last_update,
phone,
postal_code,
primary_email_address,
quota,
region,
renew_outlook_period,
renew_period,
sbr_destination,
spam_and_virus_configuration,
spam_detected,
spam_ticket_number,
state,
store_copy_of_email,
street_address
FROM ovh.email_exchange.service_accounts
WHERE exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND account_license = '{{ account_license }}'
AND company = '{{ company }}'
AND id = '{{ id }}'
AND primary_email_address = '{{ primary_email_address }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create an email account. Creates an email account from a login, a domain, a password and a license, and returns the task. Set quota in GB.

INSERT INTO ovh.email_exchange.service_accounts (
sam_account_name,
authentication_policy_id,
city,
company,
country_code,
description,
display_name,
domain,
fax,
first_name,
forwarding_email,
hidden_from_gal,
initials,
job_department,
job_title,
last_name,
license,
litigation,
litigation_period,
login,
mail_sender_display,
mailing_filter,
mobile,
office,
outlook_license,
password,
phone,
postal_code,
quota,
region,
sbr_destination,
send_connector_id,
spam_and_virus_configuration,
store_copy_of_email,
street_address,
exchange_service,
organization_name
)
SELECT 
'{{ sam_account_name }}',
{{ authentication_policy_id }},
'{{ city }}',
'{{ company }}',
'{{ country_code }}',
'{{ description }}',
'{{ display_name }}',
'{{ domain }}' /* required */,
'{{ fax }}',
'{{ first_name }}',
'{{ forwarding_email }}',
{{ hidden_from_gal }},
'{{ initials }}',
'{{ job_department }}',
'{{ job_title }}',
'{{ last_name }}',
'{{ license }}' /* required */,
{{ litigation }},
{{ litigation_period }},
'{{ login }}' /* required */,
'{{ mail_sender_display }}',
'{{ mailing_filter }}',
'{{ mobile }}',
'{{ office }}',
{{ outlook_license }},
'{{ password }}' /* required */,
'{{ phone }}',
'{{ postal_code }}',
{{ quota }},
'{{ region }}',
'{{ sbr_destination }}',
{{ send_connector_id }},
'{{ spam_and_virus_configuration }}',
{{ store_copy_of_email }},
'{{ street_address }}',
'{{ exchange_service }}',
'{{ organization_name }}'
RETURNING
id,
finish_date,
function,
status,
todo_date
;

Manifest

# Description fields are for documentation purposes
- name: service_accounts
props:
  - name: exchange_service
    value: "{{ exchange_service }}"
    description: Required parameter for the service_accounts resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the service_accounts resource.
  - name: sam_account_name
    value: "{{ sam_account_name }}"
    description: |
      SAM account name (exchange 2010 login)
  - name: authentication_policy_id
    value: {{ authentication_policy_id }}
    description: |
      ID of the authentication policy
  - name: city
    value: "{{ city }}"
    description: |
      City
  - name: company
    value: "{{ company }}"
    description: |
      Company name
  - name: country_code
    value: "{{ country_code }}"
    description: |
      Country code
    valid_values: ['AC', 'AD', 'AE', 'AF', 'AG', 'AI', 'AL', 'AM', 'AO', 'AQ', 'AR', 'AS', 'AT', 'AU', 'AW', 'AX', 'AZ', 'BA', 'BB', 'BD', 'BE', 'BF', 'BG', 'BH', 'BI', 'BJ', 'BL', 'BM', 'BN', 'BO', 'BQ', 'BR', 'BS', 'BT', 'BW', 'BY', 'BZ', 'CA', 'CC', 'CD', 'CF', 'CG', 'CH', 'CI', 'CK', 'CL', 'CM', 'CN', 'CO', 'CR', 'CU', 'CV', 'CW', 'CX', 'CY', 'CZ', 'DE', 'DG', 'DJ', 'DK', 'DM', 'DO', 'DZ', 'EA', 'EC', 'EE', 'EG', 'EH', 'ER', 'ES', 'ET', 'FI', 'FJ', 'FK', 'FM', 'FO', 'FR', 'GA', 'GB', 'GD', 'GE', 'GF', 'GG', 'GH', 'GI', 'GL', 'GM', 'GN', 'GP', 'GQ', 'GR', 'GS', 'GT', 'GU', 'GW', 'GY', 'HK', 'HN', 'HR', 'HT', 'HU', 'IC', 'ID', 'IE', 'IL', 'IM', 'IN', 'IO', 'IQ', 'IR', 'IS', 'IT', 'JE', 'JM', 'JO', 'JP', 'KE', 'KG', 'KH', 'KI', 'KM', 'KN', 'KP', 'KR', 'KW', 'KY', 'KZ', 'LA', 'LB', 'LC', 'LI', 'LK', 'LR', 'LS', 'LT', 'LU', 'LV', 'LY', 'MA', 'MC', 'MD', 'ME', 'MF', 'MG', 'MH', 'MK', 'ML', 'MM', 'MN', 'MO', 'MP', 'MQ', 'MR', 'MS', 'MT', 'MU', 'MV', 'MW', 'MX', 'MY', 'MZ', 'NA', 'NC', 'NE', 'NF', 'NG', 'NI', 'NL', 'NO', 'NP', 'NR', 'NU', 'NZ', 'OM', 'PA', 'PE', 'PF', 'PG', 'PH', 'PK', 'PL', 'PM', 'PN', 'PR', 'PS', 'PT', 'PW', 'PY', 'QA', 'RE', 'RO', 'RS', 'RU', 'RW', 'SA', 'SB', 'SC', 'SD', 'SE', 'SG', 'SH', 'SI', 'SJ', 'SK', 'SL', 'SM', 'SN', 'SO', 'SR', 'SS', 'ST', 'SV', 'SX', 'SY', 'SZ', 'TA', 'TC', 'TD', 'TF', 'TG', 'TH', 'TJ', 'TK', 'TL', 'TM', 'TN', 'TO', 'TR', 'TT', 'TV', 'TW', 'TZ', 'UA', 'UG', 'UM', 'US', 'UY', 'UZ', 'VA', 'VC', 'VE', 'VG', 'VI', 'VN', 'VU', 'WF', 'WS', 'XK', 'YE', 'YT', 'ZA', 'ZM', 'ZW']
  - name: description
    value: "{{ description }}"
    description: |
      Description
  - name: display_name
    value: "{{ display_name }}"
    description: |
      Account display name
  - name: domain
    value: "{{ domain }}"
    description: |
      Email domain
  - name: fax
    value: "{{ fax }}"
    description: |
      Fax number
  - name: first_name
    value: "{{ first_name }}"
    description: |
      Account first name
  - name: forwarding_email
    value: "{{ forwarding_email }}"
    description: |
      Email address to forward email
  - name: hidden_from_gal
    value: {{ hidden_from_gal }}
    description: |
      Hide the account in Global Address List
  - name: initials
    value: "{{ initials }}"
    description: |
      Account initials
  - name: job_department
    value: "{{ job_department }}"
    description: |
      Job department
  - name: job_title
    value: "{{ job_title }}"
    description: |
      Job title
  - name: last_name
    value: "{{ last_name }}"
    description: |
      Account last name
  - name: license
    value: "{{ license }}"
    description: |
      OVH licence account
    valid_values: ['basic', 'enterprise', 'standard']
  - name: litigation
    value: {{ litigation }}
    description: |
      Litigation status
  - name: litigation_period
    value: {{ litigation_period }}
    description: |
      Litigation length in days, 0 means unlimited
  - name: login
    value: "{{ login }}"
    description: |
      Account login
  - name: mail_sender_display
    value: "{{ mail_sender_display }}"
    description: |
      Email display as sender
  - name: mailing_filter
    value:
      - "{{ mailing_filter }}"
    description: |
      Enable mailing filtrering
  - name: mobile
    value: "{{ mobile }}"
    description: |
      Mobile phone number
  - name: office
    value: "{{ office }}"
    description: |
      office
  - name: outlook_license
    value: {{ outlook_license }}
    description: |
      Buy outlook license
  - name: password
    value: "{{ password }}"
    description: |
      Account password
  - name: phone
    value: "{{ phone }}"
    description: |
      Phone Number
  - name: postal_code
    value: "{{ postal_code }}"
    description: |
      Postal code
  - name: quota
    value: {{ quota }}
    description: |
      Quota specified in GB. Check pricing table before use
  - name: region
    value: "{{ region }}"
    description: |
      Region
  - name: sbr_destination
    value: "{{ sbr_destination }}"
    description: |
      Sender base routing destination domain
  - name: send_connector_id
    value: {{ send_connector_id }}
    description: |
      Send connector id used to send mails when SBR is defined
  - name: spam_and_virus_configuration
    description: |
      Antispam and Antivirus configuration
    value:
      checkDKIM: {{ checkDKIM }}
      checkSPF: {{ checkSPF }}
      deleteSpam: {{ deleteSpam }}
      deleteVirus: {{ deleteVirus }}
      putInJunk: {{ putInJunk }}
      tagSpam: {{ tagSpam }}
      tagVirus: {{ tagVirus }}
  - name: store_copy_of_email
    value: {{ store_copy_of_email }}
    description: |
      Store copy of email when forward is enable
  - name: street_address
    value: "{{ street_address }}"
    description: |
      Street address

UPDATE examples

update

Update an email account. Updates the names, license, quota, renewal, forwarding, litigation hold, spam settings, authentication policy and contact details of the email account.

UPDATE ovh.email_exchange.service_accounts
SET 
account_license = '{{ account_license }}',
authentication_policy_id = {{ authentication_policy_id }},
city = '{{ city }}',
company = '{{ company }}',
country_code = '{{ country_code }}',
delete_at_expiration = {{ delete_at_expiration }},
delete_outlook_at_expiration = {{ delete_outlook_at_expiration }},
description = '{{ description }}',
display_name = '{{ display_name }}',
domain = '{{ domain }}',
fax = '{{ fax }}',
first_name = '{{ first_name }}',
forwarding_email = '{{ forwarding_email }}',
hidden_from_gal = {{ hidden_from_gal }},
initial = '{{ initial }}',
job_department = '{{ job_department }}',
job_title = '{{ job_title }}',
last_name = '{{ last_name }}',
litigation = {{ litigation }},
litigation_period = {{ litigation_period }},
login = '{{ login }}',
mail_sender_display = '{{ mail_sender_display }}',
mailing_filter = '{{ mailing_filter }}',
mobile = '{{ mobile }}',
office = '{{ office }}',
outlook_license = {{ outlook_license }},
phone = '{{ phone }}',
postal_code = '{{ postal_code }}',
quota = {{ quota }},
region = '{{ region }}',
renew_outlook_period = '{{ renew_outlook_period }}',
renew_period = '{{ renew_period }}',
sbr_destination = '{{ sbr_destination }}',
send_connector_id = {{ send_connector_id }},
spam_and_virus_configuration = '{{ spam_and_virus_configuration }}',
store_copy_of_email = {{ store_copy_of_email }},
street_address = '{{ street_address }}'
WHERE 
exchange_service = '{{ exchange_service }}' --required
AND organization_name = '{{ organization_name }}' --required
AND primary_email_address = '{{ primary_email_address }}' --required;

DELETE examples

delete

Delete an email account. Deletes the email account and returns the task. On Hosted Exchange, the account is reset instead: its content is deleted and it becomes an unconfigured slot in configureme.me that keeps its subscription.

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

Lifecycle Methods

EXEC variables use wire (API) names.

change_password

Change an email account password. Changes the password and returns the task. Set forcePasswordChangeAtNextLogon to make the user change it at the next logon.

EXEC ovh.email_exchange.service_accounts.change_password 
@exchangeService='{{ exchangeService }}' --required, 
@organizationName='{{ organizationName }}' --required, 
@primaryEmailAddress='{{ primaryEmailAddress }}' --required 
@@json=
'{
"forcePasswordChangeAtNextLogon": {{ forcePasswordChangeAtNextLogon }}, 
"password": "{{ password }}"
}'
;

terminate

Terminate an email account at expiration. Sets the email account to be suspended at its expiration date, and returns a message giving that date. Set deleteAtExpiration to false on the account to cancel.

EXEC ovh.email_exchange.service_accounts.terminate 
@exchangeService='{{ exchangeService }}' --required, 
@organizationName='{{ organizationName }}' --required, 
@primaryEmailAddress='{{ primaryEmailAddress }}' --required
;