service_public_folders

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

Overview

Name	service_public_folders
Type	Resource
Id	ovh.email_exchange.service_public_folders

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
task_pending_id	integer	task pending id (wire: taskPendingId)
anonymous_permission	string	Access right for the guest users (editor, none, reviewer) (wire: anonymousPermission)
creation_date	string (date-time)	Creation date (wire: creationDate)
default_permission	string	Default access right (editor, none, reviewer) (wire: defaultPermission)
has_sub_folders	boolean	If true, this public folder has subfolders (wire: hasSubFolders)
item_count	integer	Number of items in public folder (wire: itemCount)
last_access_time	string (date-time)	Time for which public folder was accessed for the last time (wire: lastAccessTime)
last_modification_time	string (date-time)	Time for which public folder was modified for the last time (wire: lastModificationTime)
last_user_access_time	string (date-time)	Time for which public folder was accessed for the last time by the user (wire: lastUserAccessTime)
last_user_modification_time	string (date-time)	Time for which public folder was modified for the last time by the user (wire: lastUserModificationTime)
path	string	Path for public folder
quota	integer	Quota for public folder in MB
state	string	Current object state (creating, deleting, internalMigration, ok, reopening, suspended, suspending)
total_item_size	integer	Sum of all items in public folder in MB (wire: totalItemSize)
type	string	Type for public folder (calendar, contacts, plain, tasks)

list

Exchange organization public folder

Name	Datatype	Description
task_pending_id	integer	task pending id (wire: taskPendingId)
anonymous_permission	string	Access right for the guest users (editor, none, reviewer) (wire: anonymousPermission)
creation_date	string (date-time)	Creation date (wire: creationDate)
default_permission	string	Default access right (editor, none, reviewer) (wire: defaultPermission)
has_sub_folders	boolean	If true, this public folder has subfolders (wire: hasSubFolders)
item_count	integer	Number of items in public folder (wire: itemCount)
last_access_time	string (date-time)	Time for which public folder was accessed for the last time (wire: lastAccessTime)
last_modification_time	string (date-time)	Time for which public folder was modified for the last time (wire: lastModificationTime)
last_user_access_time	string (date-time)	Time for which public folder was accessed for the last time by the user (wire: lastUserAccessTime)
last_user_modification_time	string (date-time)	Time for which public folder was modified for the last time by the user (wire: lastUserModificationTime)
path	string	Path for public folder
quota	integer	Quota for public folder in MB
state	string	Current object state (creating, deleting, internalMigration, ok, reopening, suspended, suspending)
total_item_size	integer	Sum of all items in public folder in MB (wire: totalItemSize)
type	string	Type for public folder (calendar, contacts, plain, tasks)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	exchange_service, organization_name, path		Get a public folder. Returns the type, quota, size, item count, default and anonymous permissions and access dates of the public folder.
list	select	exchange_service, organization_name	path, x_pagination_mode	List public folders. Returns the paths of the public folders of the service. Filter them by path to look for a given folder.
create	insert	exchange_service, organization_name, path, quota, type		Create a public folder. Creates a calendar, contacts, plain or tasks public folder from its path and its quota in MB, and returns the task.
update	update	exchange_service, organization_name, path		Update a public folder. Updates the quota of the public folder, in MB, and its default and anonymous permissions.
delete	delete	exchange_service, organization_name, path		Delete a public folder. Deletes the public folder with its content and permissions, 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)
path	string	Path for public folder
path	string	Filter the value of path property (like)
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 public folder. Returns the type, quota, size, item count, default and anonymous permissions and access dates of the public folder.

SELECT
task_pending_id,
anonymous_permission,
creation_date,
default_permission,
has_sub_folders,
item_count,
last_access_time,
last_modification_time,
last_user_access_time,
last_user_modification_time,
path,
quota,
state,
total_item_size,
type
FROM ovh.email_exchange.service_public_folders
WHERE exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND path = '{{ path }}' -- required
;

list

List public folders. Returns the paths of the public folders of the service. Filter them by path to look for a given folder.

SELECT
task_pending_id,
anonymous_permission,
creation_date,
default_permission,
has_sub_folders,
item_count,
last_access_time,
last_modification_time,
last_user_access_time,
last_user_modification_time,
path,
quota,
state,
total_item_size,
type
FROM ovh.email_exchange.service_public_folders
WHERE exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND path = '{{ path }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a public folder. Creates a calendar, contacts, plain or tasks public folder from its path and its quota in MB, and returns the task.

INSERT INTO ovh.email_exchange.service_public_folders (
anonymous_permission,
default_permission,
path,
quota,
type,
exchange_service,
organization_name
)
SELECT 
'{{ anonymous_permission }}',
'{{ default_permission }}',
'{{ path }}' /* required */,
{{ quota }} /* required */,
'{{ type }}' /* required */,
'{{ exchange_service }}',
'{{ organization_name }}'
RETURNING
id,
finish_date,
function,
status,
todo_date
;

Manifest

# Description fields are for documentation purposes
- name: service_public_folders
props:
  - name: exchange_service
    value: "{{ exchange_service }}"
    description: Required parameter for the service_public_folders resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the service_public_folders resource.
  - name: anonymous_permission
    value: "{{ anonymous_permission }}"
    description: |
      Access right for the guest users
    valid_values: ['editor', 'none', 'reviewer']
  - name: default_permission
    value: "{{ default_permission }}"
    description: |
      Default access right
    valid_values: ['editor', 'none', 'reviewer']
  - name: path
    value: "{{ path }}"
    description: |
      Path for public folder
  - name: quota
    value: {{ quota }}
    description: |
      Quota for public folder in MB
  - name: type
    value: "{{ type }}"
    description: |
      Type for public folder
    valid_values: ['calendar', 'contacts', 'plain', 'tasks']

UPDATE examples

update

Update a public folder. Updates the quota of the public folder, in MB, and its default and anonymous permissions.

UPDATE ovh.email_exchange.service_public_folders
SET 
anonymous_permission = '{{ anonymous_permission }}',
default_permission = '{{ default_permission }}',
quota = {{ quota }}
WHERE 
exchange_service = '{{ exchange_service }}' --required
AND organization_name = '{{ organization_name }}' --required
AND path = '{{ path }}' --required;

DELETE examples

delete

Delete a public folder. Deletes the public folder with its content and permissions, and returns the task.

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