{"openapi":"3.0.0","info":{"title":"OVHcloud API specification","description":"Specification for OVHcloud API","version":"1.0","contact":{"name":"OVH","email":"api@ml.ovh.net"}},"servers":[{"url":"https://api.eu.ovhcloud.com/1.0"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"domain.DomainFilterActionEnum":{"type":"string","description":"Possible values for filter action","enum":["accept","account","delete","redirect"]},"domain.DomainFilterOperandEnum":{"type":"string","description":"Possible values for filter operation","enum":["checkspf","contains","noContains"]},"domain.DomainPopActionEnum":{"type":"string","description":"Possible values for pop action task","enum":["addAccount","changeAccount","changePassword","deleteAccount","internalMigration","migration","temporaryTask","unknown"]},"domain.DomainSpecialAccountActionEnum":{"type":"string","description":"Possible values for pop action task","enum":["add","change","delete"]},"domain.DomainSpecialAccountTypeEnum":{"type":"string","description":"Possible type task","enum":["25g","alias","delete","filter","forward","responder"]},"domain.DomainUsageAccountStruct":{"type":"object","description":"Structure of usage account","properties":{"date":{"type":"string","description":"Timestamp","nullable":true,"format":"date-time"},"emailCount":{"type":"integer","description":"Number of message in mailbox","nullable":true},"quota":{"type":"integer","description":"Size of mailbox (bytes)","nullable":true}}},"duration":{"type":"string","description":"Duration (e.g., P1Y2M3DT4H6M9S)","example":"P1Y2M3DT4H6M9S"},"email":{"type":"string","description":"Email address (e.g., api@ml.ovh.net)","format":"email","example":"api@ml.ovh.net"},"email.domain.AccountDelegated":{"type":"object","description":"Account List","properties":{"accountName":{"type":"string","description":"Name of account","readOnly":true},"allowedAccountSize":{"type":"array","description":"List of allowed sizes for this account in bytes","nullable":true,"items":{"type":"integer"},"readOnly":true},"description":{"type":"string","description":"Account description"},"domain":{"type":"string","description":"Name of domain","readOnly":true},"email":{"type":"string","description":"Email","readOnly":true},"isBlocked":{"type":"boolean","description":"If true your account is blocked","readOnly":true},"size":{"type":"integer","description":"Size of your account in bytes"}}},"email.domain.Filter":{"type":"object","description":"Filter List","properties":{"action":{"allOf":[{"$ref":"#/components/schemas/domain.DomainFilterActionEnum"}],"description":"Action of filter","nullable":true,"readOnly":true},"actionParam":{"type":"string","description":"Action parameter of filter","nullable":true,"readOnly":true},"active":{"type":"boolean","description":"If true filter is active","readOnly":true},"domain":{"type":"string","description":"Domain name of filter","readOnly":true},"name":{"type":"string","description":"Filter name","readOnly":true},"pop":{"type":"string","description":"Account name of filter","readOnly":true},"priority":{"type":"integer","description":"Priority of filter","readOnly":true}}},"email.domain.ResponderAccount":{"type":"object","description":"Responder of account","properties":{"account":{"type":"string","description":"Name of account","readOnly":true},"content":{"type":"string","description":"Content of responder"},"copy":{"type":"boolean","description":"If true, emails will be copy to emailToCopy address","readOnly":true},"copyTo":{"type":"string","description":"Account where copy emails","nullable":true,"readOnly":true},"from":{"type":"string","description":"Date of start responder","nullable":true,"format":"date-time"},"to":{"type":"string","description":"Date of end responder","nullable":true,"format":"date-time"}}},"email.domain.Rule":{"type":"object","description":"Rule List","properties":{"header":{"type":"string","description":"Header to be filtered","readOnly":true},"id":{"type":"integer","readOnly":true},"operand":{"allOf":[{"$ref":"#/components/schemas/domain.DomainFilterOperandEnum"}],"description":"Rule of filter","readOnly":true},"value":{"type":"string","description":"Rule parameter of filter","readOnly":true}}},"email.domain.TaskFilter":{"type":"object","description":"Task filter List","properties":{"account":{"type":"string","description":"Account name of task","readOnly":true},"action":{"type":"string","description":"Action of task","readOnly":true},"domain":{"type":"string","description":"Domain name of task","readOnly":true},"id":{"type":"integer","description":"Id of task","readOnly":true},"timestamp":{"type":"string","description":"Creation date of task","format":"date-time","readOnly":true}}},"email.domain.TaskPop":{"type":"object","description":"Task Pop List","properties":{"action":{"allOf":[{"$ref":"#/components/schemas/domain.DomainPopActionEnum"}],"description":"Action of task","readOnly":true},"date":{"type":"string","description":"Creation date of task","format":"date-time","readOnly":true},"domain":{"type":"string","description":"Domain name of task","readOnly":true},"id":{"type":"integer","description":"Id of task","readOnly":true},"name":{"type":"string","description":"Account name of task","readOnly":true}}},"email.domain.TaskSpecialAccount":{"type":"object","description":"Task special account List","properties":{"account":{"type":"string","description":"Account name of task","readOnly":true},"action":{"allOf":[{"$ref":"#/components/schemas/domain.DomainSpecialAccountActionEnum"}],"description":"Action of task","readOnly":true},"date":{"type":"string","description":"Creation date of task","format":"date-time","readOnly":true},"domain":{"type":"string","description":"Domain name of task","readOnly":true},"id":{"type":"integer","description":"Id of task","readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/domain.DomainSpecialAccountTypeEnum"}],"description":"Type of action filter","readOnly":true}}},"internationalPhoneNumber":{"type":"string","description":"International phone number","format":"phone-number"},"ip":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipBlock":{"type":"string","description":"IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)","format":"ip-block","example":"192.0.2.0/24"},"ipInterface":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4":{"type":"string","description":"IPv4 address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4Block":{"type":"string","description":"IPv4 CIDR notation (e.g., 192.0.2.0/24)","format":"ipv4-block","example":"192.0.2.0/24"},"ipv6":{"type":"string","description":"IPv6 address (e.g., 2001:41d0:1:1994::1)","format":"ipv6","example":"2001:41d0:1:1994::1"},"ipv6Block":{"type":"string","description":"IPv6 CIDR notation (e.g., 2001:41d0::/128)","format":"ipv6-block","example":"2001:41d0::/128"},"macAddress":{"type":"string","description":"MAC address (e.g., 00:00:5e:00:53:01)","format":"mac-address","example":"00:00:5e:00:53:01"},"phoneNumber":{"type":"string","description":"Phone number","format":"phone-number"},"time":{"type":"string","description":"Time (e.g., 15:04:05)","format":"time","example":"15:04:05"}},"securitySchemes":{"oAuth2AuthCode":{"type":"oauth2","description":"Oauth2","x-client-id":"1bb9c7df371741c0","x-client-secret":"a5b4de870aca620d10fbf63cd18d205b","flows":{"authorizationCode":{"authorizationUrl":"https://auth.eu.ovhcloud.com/oauth2/authorize","tokenUrl":"https://auth.eu.ovhcloud.com/oauth2/token","scopes":{"account/all":"Manage your account","all":"Manage your whole account and all your services","services/all":"Manage your services lifecycle and billing"}}}}}},"paths":{"/email/domain/delegatedAccount":{"get":{"summary":"List delegated accounts","description":"List delegated accounts. Returns the email addresses of the email accounts delegated to the customer account. Filter them by `domain` or `accountName`.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"accountName","description":"Name of email address","schema":{"type":"string"}},{"in":"query","name":"domain","description":"Domain of email address","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Delegated Accounts@@@10"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/email/domain/delegatedAccount\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/email/domain/delegatedAccount\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:emailDomain/delegatedAccount/get","required":true}],"x-expanded-response":"EmailDomainAccountDelegated"}},"/email/domain/delegatedAccount/{email}":{"get":{"summary":"Get a delegated account","description":"Get a delegated account. Returns the email address, description, size in bytes, allowed sizes and blocked state of the delegated email account.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"email","description":"Email","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.domain.AccountDelegated"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Delegated Accounts@@@20"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/email/domain/delegatedAccount/{email}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/email/domain/delegatedAccount/{email}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:emailDomain/delegatedAccount/get","required":true}]},"put":{"summary":"Update a delegated account","description":"Update a delegated account. Updates the description or the size in bytes of the delegated email account. The allowed sizes are in `allowedAccountSize`.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"email","description":"Email","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.domain.AccountDelegated"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Delegated Accounts@@@30"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: email.domain.AccountDelegated\nresult = client.put(\"/email/domain/delegatedAccount/{email}\",\n\tdescription = None, # Account description (type: string)\n\tsize = None, # Size of your account in bytes (type: integer)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: email.domain.AccountDelegated\n$result = $ovh->put(\"/email/domain/delegatedAccount/{email}\", array(\n\tdescription => null, // Account description (type: string)\n\tsize => null, // Size of your account in bytes (type: integer)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:emailDomain/delegatedAccount/edit","required":true}]}},"/email/domain/delegatedAccount/{email}/changePassword":{"post":{"summary":"Change a delegated account password","description":"Change a delegated account password. Sets a new password and returns the task. The password needs 8 to 30 characters and no accents.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"email","description":"Email","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"password":{"type":"string","description":"New password","format":"password"}},"required":["password"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.domain.TaskPop"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Delegated Accounts@@@40"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: password\nresult = client.post(\"/email/domain/delegatedAccount/{email}/changePassword\",\n\tpassword = None, # New password (type: password)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: password\n$result = $ovh->post(\"/email/domain/delegatedAccount/{email}/changePassword\", array(\n\tpassword => null, // New password (type: password)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:delegatedAccount/changePassword","required":true}]}},"/email/domain/delegatedAccount/{email}/filter":{"get":{"summary":"List filters","description":"List filters. Returns the names of the filters of the delegated email account. Get one to read its action, priority and state.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"email","description":"Email","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Delegated Accounts@@@50"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/email/domain/delegatedAccount/{email}/filter\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/email/domain/delegatedAccount/{email}/filter\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:delegatedAccount/filter/get","required":true}],"x-expanded-response":"EmailDomainFilter"},"post":{"summary":"Create a filter","description":"Create a filter. Creates a filter with a rule on a `header` (`operand` and `value`), an `action`, a `priority` and an `active` state, and returns the task.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"email","description":"Email","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"description":"Action of filter","$ref":"#/components/schemas/domain.DomainFilterActionEnum"},"actionParam":{"type":"string","description":"Action parameter of filter"},"active":{"type":"boolean","description":"If true filter is active"},"header":{"type":"string","description":"Header to be filtered"},"name":{"type":"string","description":"Filter name"},"operand":{"description":"Rule of filter","$ref":"#/components/schemas/domain.DomainFilterOperandEnum"},"priority":{"type":"integer","description":"Priority of filter"},"value":{"type":"string","description":"Rule parameter of filter"}},"required":["action","active","header","name","operand","priority","value"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.domain.TaskFilter"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Delegated Accounts@@@70"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.post(\"/email/domain/delegatedAccount/{email}/filter\",\n\taction = None, # Action of filter (type: domain.DomainFilterActionEnum)\n\tactionParam = None, # Action parameter of filter (type: string, nullable)\n\tactive = None, # If true filter is active (type: boolean)\n\theader = None, # Header to be filtered (type: string)\n\tname = None, # Filter name (type: string)\n\toperand = None, # Rule of filter (type: domain.DomainFilterOperandEnum)\n\tpriority = None, # Priority of filter (type: long)\n\tvalue = None, # Rule parameter of filter (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/email/domain/delegatedAccount/{email}/filter\", array(\n\taction => null, // Action of filter (type: domain.DomainFilterActionEnum)\n\tactionParam => null, // Action parameter of filter (type: string, nullable)\n\tactive => null, // If true filter is active (type: boolean)\n\theader => null, // Header to be filtered (type: string)\n\tname => null, // Filter name (type: string)\n\toperand => null, // Rule of filter (type: domain.DomainFilterOperandEnum)\n\tpriority => null, // Priority of filter (type: long)\n\tvalue => null, // Rule parameter of filter (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:delegatedAccount/filter/create","required":true}]}},"/email/domain/delegatedAccount/{email}/filter/{name}":{"delete":{"summary":"Delete a filter","description":"Delete a filter. Removes the filter and its rules from the email account, and returns the tasks. Incoming emails are no longer filtered by it.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"email","description":"Email","required":true,"schema":{"type":"string"}},{"in":"path","name":"name","description":"Filter name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/email.domain.TaskFilter"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Delegated Accounts@@@80"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.delete(\"/email/domain/delegatedAccount/{email}/filter/{name}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/email/domain/delegatedAccount/{email}/filter/{name}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:delegatedAccount/filter/delete","required":true}]},"get":{"summary":"Get a filter","description":"Get a filter. Returns the account, priority, active state, action (accept, account, delete or redirect) and action parameter of the filter.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"email","description":"Email","required":true,"schema":{"type":"string"}},{"in":"path","name":"name","description":"Filter name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.domain.Filter"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Delegated Accounts@@@60"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/email/domain/delegatedAccount/{email}/filter/{name}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/email/domain/delegatedAccount/{email}/filter/{name}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:delegatedAccount/filter/get","required":true}]}},"/email/domain/delegatedAccount/{email}/filter/{name}/changeActivity":{"post":{"summary":"Enable or disable a filter","description":"Enable or disable a filter. Set `activity` to true to apply the filter to incoming emails, or to false to suspend it.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"email","description":"Email","required":true,"schema":{"type":"string"}},{"in":"path","name":"name","description":"Filter name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"activity":{"type":"boolean","description":"New activity"}},"required":["activity"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.domain.TaskFilter"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Delegated Accounts@@@90"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: boolean\nresult = client.post(\"/email/domain/delegatedAccount/{email}/filter/{name}/changeActivity\",\n\tactivity = None, # New activity (type: boolean)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: boolean\n$result = $ovh->post(\"/email/domain/delegatedAccount/{email}/filter/{name}/changeActivity\", array(\n\tactivity => null, // New activity (type: boolean)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:delegatedAccount/filter/changeActivity","required":true}]}},"/email/domain/delegatedAccount/{email}/filter/{name}/changePriority":{"post":{"summary":"Change filter priority","description":"Change filter priority. Sets the `priority` of the filter, which gives the order the filters of the account are applied in.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"email","description":"Email","required":true,"schema":{"type":"string"}},{"in":"path","name":"name","description":"Filter name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"priority":{"type":"integer","description":"New priority"}},"required":["priority"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.domain.TaskFilter"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Delegated Accounts@@@100"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: long\nresult = client.post(\"/email/domain/delegatedAccount/{email}/filter/{name}/changePriority\",\n\tpriority = None, # New priority (type: long)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: long\n$result = $ovh->post(\"/email/domain/delegatedAccount/{email}/filter/{name}/changePriority\", array(\n\tpriority => null, // New priority (type: long)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:delegatedAccount/filter/changePriority","required":true}]}},"/email/domain/delegatedAccount/{email}/filter/{name}/rule":{"get":{"summary":"List filter rules","description":"List filter rules. Returns the IDs of the rules of the filter. Get one to read the header it checks, its operand and its value.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"email","description":"Email","required":true,"schema":{"type":"string"}},{"in":"path","name":"name","description":"Filter name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Delegated Accounts@@@110"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/email/domain/delegatedAccount/{email}/filter/{name}/rule\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/email/domain/delegatedAccount/{email}/filter/{name}/rule\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:delegatedAccount/filter/rule/get","required":true}],"x-expanded-response":"EmailDomainRule"},"post":{"summary":"Create a filter rule","description":"Create a filter rule. Adds a rule to the filter on a `header`, with an `operand` (checkspf, contains or noContains) and a `value`, and returns the task.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"email","description":"Email","required":true,"schema":{"type":"string"}},{"in":"path","name":"name","description":"Filter name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"header":{"type":"string","description":"Header to be filtered"},"operand":{"description":"Rule of filter","$ref":"#/components/schemas/domain.DomainFilterOperandEnum"},"value":{"type":"string","description":"Rule parameter of filter"}},"required":["header","operand","value"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.domain.TaskFilter"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Delegated Accounts@@@130"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: string\nresult = client.post(\"/email/domain/delegatedAccount/{email}/filter/{name}/rule\",\n\theader = None, # Header to be filtered (type: string)\n\toperand = None, # Rule of filter (type: domain.DomainFilterOperandEnum)\n\tvalue = None, # Rule parameter of filter (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: string\n$result = $ovh->post(\"/email/domain/delegatedAccount/{email}/filter/{name}/rule\", array(\n\theader => null, // Header to be filtered (type: string)\n\toperand => null, // Rule of filter (type: domain.DomainFilterOperandEnum)\n\tvalue => null, // Rule parameter of filter (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:delegatedAccount/filter/rule/create","required":true}]}},"/email/domain/delegatedAccount/{email}/filter/{name}/rule/{id}":{"delete":{"summary":"Delete a filter rule","description":"Delete a filter rule. Removes the rule from the filter and returns the tasks. The filter keeps applying its other rules.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"email","description":"Email","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"name","description":"Filter name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/email.domain.TaskFilter"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Delegated Accounts@@@140"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.delete(\"/email/domain/delegatedAccount/{email}/filter/{name}/rule/{id}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/email/domain/delegatedAccount/{email}/filter/{name}/rule/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:delegatedAccount/filter/rule/delete","required":true}]},"get":{"summary":"Get a filter rule","description":"Get a filter rule. Returns the header, the operand (checkspf, contains or noContains) and the value of the rule.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"email","description":"Email","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"name","description":"Filter name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.domain.Rule"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Delegated Accounts@@@120"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/email/domain/delegatedAccount/{email}/filter/{name}/rule/{id}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/email/domain/delegatedAccount/{email}/filter/{name}/rule/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:delegatedAccount/filter/rule/get","required":true}]}},"/email/domain/delegatedAccount/{email}/responder":{"delete":{"summary":"Delete a delegated account responder","description":"Delete a delegated account responder. Removes the automatic reply of the delegated email account and returns the task.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"email","description":"Email","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.domain.TaskSpecialAccount"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Delegated Accounts@@@170"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.delete(\"/email/domain/delegatedAccount/{email}/responder\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/email/domain/delegatedAccount/{email}/responder\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:emailDomain/delegatedAccount/responder/delete","required":true}]},"get":{"summary":"Get a delegated account responder","description":"Get a delegated account responder. Returns the content, the start and end dates and the copy settings of the responder of the delegated email account.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"email","description":"Email","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.domain.ResponderAccount"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Delegated Accounts@@@150"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/email/domain/delegatedAccount/{email}/responder\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/email/domain/delegatedAccount/{email}/responder\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:emailDomain/delegatedAccount/responder/get","required":true}]},"post":{"summary":"Create a delegated account responder","description":"Create a delegated account responder. Creates the automatic reply of the delegated email account with its content and optional start and end dates, and returns the task. Set `copy` to true to copy the emails to `copyTo`.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"email","description":"Email","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"content":{"type":"string","description":"Content of responder"},"copy":{"type":"boolean","description":"If true, emails will be copy to emailToCopy address"},"copyTo":{"type":"string","description":"Account where copy emails"},"from":{"type":"string","description":"Date of start responder","format":"date-time"},"to":{"type":"string","description":"Date of end responder","format":"date-time"}},"required":["content","copy"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.domain.TaskSpecialAccount"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Delegated Accounts@@@160"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: datetime\nresult = client.post(\"/email/domain/delegatedAccount/{email}/responder\",\n\tcontent = None, # Content of responder (type: string)\n\tcopy = None, # If true, emails will be copy to emailToCopy address (type: boolean)\n\tcopyTo = None, # Account where copy emails (type: string, nullable)\n\tfrom = None, # Date of start responder (type: datetime, nullable)\n\tto = None, # Date of end responder (type: datetime, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: datetime\n$result = $ovh->post(\"/email/domain/delegatedAccount/{email}/responder\", array(\n\tcontent => null, // Content of responder (type: string)\n\tcopy => null, // If true, emails will be copy to emailToCopy address (type: boolean)\n\tcopyTo => null, // Account where copy emails (type: string, nullable)\n\tfrom => null, // Date of start responder (type: datetime, nullable)\n\tto => null, // Date of end responder (type: datetime, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:emailDomain/delegatedAccount/responder/create","required":true}]},"put":{"summary":"Update a delegated account responder","description":"Update a delegated account responder. Updates the content and the start and end dates of the responder.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"email","description":"Email","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.domain.ResponderAccount"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Delegated Accounts@@@180"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: email.domain.ResponderAccount\nresult = client.put(\"/email/domain/delegatedAccount/{email}/responder\",\n\tcontent = None, # Content of responder (type: string)\n\tfrom = None, # Date of start responder (type: string, nullable)\n\tto = None, # Date of end responder (type: string, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: email.domain.ResponderAccount\n$result = $ovh->put(\"/email/domain/delegatedAccount/{email}/responder\", array(\n\tcontent => null, // Content of responder (type: string)\n\tfrom => null, // Date of start responder (type: string, nullable)\n\tto => null, // Date of end responder (type: string, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:emailDomain/delegatedAccount/responder/edit","required":true}]}},"/email/domain/delegatedAccount/{email}/updateUsage":{"post":{"summary":"Refresh delegated account usage","description":"Refresh delegated account usage. Asks for the figures returned by `usage` to be recomputed; they are updated asynchronously.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"email","description":"Email","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Delegated Accounts@@@190"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.post(\"/email/domain/delegatedAccount/{email}/updateUsage\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/email/domain/delegatedAccount/{email}/updateUsage\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:emailDomain/delegatedAccount/updateUsage","required":true}]}},"/email/domain/delegatedAccount/{email}/usage":{"post":{"summary":"Get delegated account usage","description":"Get delegated account usage. Returns the number of emails, the maximum size in bytes of the mailbox (`quota`) and the date of the measure.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"email","description":"Email","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain.DomainUsageAccountStruct"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Delegated Accounts@@@200"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.post(\"/email/domain/delegatedAccount/{email}/usage\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/email/domain/delegatedAccount/{email}/usage\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:emailDomain/delegatedAccount/usage/create","required":true}]}}}}