freefaxes

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

Overview

Name	freefaxes
Type	Resource
Id	ovh.freefax.freefaxes

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
from_name	string	Name of the sender of the email (wire: fromName)
fax_max_call	integer	Number of tries when sending a fax (1, 2, 3, 4, 5, 6, 7, 8, 9) (wire: faxMaxCall)
fax_quality	string	Available quality for fax documents (best, high, normal) (wire: faxQuality)
fax_tag_line	string	Customised freefax header (wire: faxTagLine)
from_email	string	FROM email header (wire: fromEmail)
iam	object	IAM resource metadata
number	string (phone-number)	Phone number
redirection_email	array	Email address to redirect fax response. (wire: redirectionEmail)

list

Freefax properties

Name	Datatype	Description
from_name	string	Name of the sender of the email (wire: fromName)
fax_max_call	integer	Number of tries when sending a fax (1, 2, 3, 4, 5, 6, 7, 8, 9) (wire: faxMaxCall)
fax_quality	string	Available quality for fax documents (best, high, normal) (wire: faxQuality)
fax_tag_line	string	Customised freefax header (wire: faxTagLine)
from_email	string	FROM email header (wire: fromEmail)
iam	object	IAM resource metadata
number	string (phone-number)	Phone number
redirection_email	array	Email address to redirect fax response. (wire: redirectionEmail)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Get Freefax information
list	select		iam_tags, x_pagination_mode	List Freefax line accounts
update	update	service_name		Edit the Freefax properties
change_password	exec	serviceName		Generates a new password for your fax account

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"}})
serviceName	string (phone-number)	Service name
service_name	string (phone-number)	Service name (wire: serviceName)
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
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 Freefax information

SELECT
from_name,
fax_max_call,
fax_quality,
fax_tag_line,
from_email,
iam,
number,
redirection_email
FROM ovh.freefax.freefaxes
WHERE service_name = '{{ service_name }}' -- required
;

list

List Freefax line accounts

SELECT
from_name,
fax_max_call,
fax_quality,
fax_tag_line,
from_email,
iam,
number,
redirection_email
FROM ovh.freefax.freefaxes
WHERE iam_tags = '{{ iam_tags }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Edit the Freefax properties

UPDATE ovh.freefax.freefaxes
SET 
fax_max_call = {{ fax_max_call }},
fax_quality = '{{ fax_quality }}',
fax_tag_line = '{{ fax_tag_line }}',
from_email = '{{ from_email }}',
from_name = '{{ from_name }}',
redirection_email = '{{ redirection_email }}'
WHERE 
service_name = '{{ service_name }}' --required;

Lifecycle Methods

EXEC variables use wire (API) names.

change_password

Generates a new password for your fax account

EXEC ovh.freefax.freefaxes.change_password 
@serviceName='{{ serviceName }}' --required
;