Difference between revisions of "NATS5 REST API Site GET email-settings"
From TMM Wiki
Jump to navigationJump to search| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_site_section = true |
}} | }} | ||
== '''GET /site/email-settings''' == | == '''GET /site/email-settings''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get email settings | * Get email settings | ||
| Line 9: | Line 10: | ||
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] |
*GET | *GET | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 25: | Line 26: | ||
** optional | ** optional | ||
* '''populate''' | * '''populate''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
| + | == '''Example Request''' == | ||
| + | Method: '''GET'''<br/> | ||
| + | URL: <nowiki>http://domain/api/site/email-settings</nowiki><br/> | ||
| + | Query String: <nowiki>siteid=2&populate=0</nowiki><br/> | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "success": 1, | ||
| + | "email_settings": { | ||
| + | "ALL": [ | ||
| + | { | ||
| + | "key": "EMAIL_FROM_AFFILIATE", | ||
| + | "value": "", | ||
| + | "default": "change@changeme.com", | ||
| + | "nice": "From Email", | ||
| + | "source": "config", | ||
| + | "readonly": 0 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_FROM_NICE_AFFILIATE", | ||
| + | "value": "", | ||
| + | "nice": "From Name", | ||
| + | "source": "unset", | ||
| + | "readonly": 0 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_REPLY_AFFILIATE", | ||
| + | "value": "", | ||
| + | "nice": "Reply Email", | ||
| + | "source": "unset", | ||
| + | "readonly": 0 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_REPLY_NICE_AFFILIATE", | ||
| + | "value": "", | ||
| + | "nice": "Reply Name", | ||
| + | "source": "unset", | ||
| + | "readonly": 0 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_BCC_TO_AFFILIATE", | ||
| + | "value": "", | ||
| + | "nice": "BCC Email", | ||
| + | "source": "unset", | ||
| + | "readonly": 0 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_FROM_MEMBER", | ||
| + | "value": "test1", | ||
| + | "default": "change@changeme.com", | ||
| + | "nice": "From Email", | ||
| + | "source": "site", | ||
| + | "readonly": 0 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_FROM_NICE_MEMBER", | ||
| + | "value": "test2", | ||
| + | "nice": "From Name", | ||
| + | "source": "site", | ||
| + | "readonly": 0 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_REPLY_MEMBER", | ||
| + | "value": "test3", | ||
| + | "nice": "Reply Email", | ||
| + | "source": "site", | ||
| + | "readonly": 0 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_REPLY_NICE_MEMBER", | ||
| + | "value": "test4", | ||
| + | "nice": "Reply Name", | ||
| + | "source": "site", | ||
| + | "readonly": 0 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_BCC_TO_MEMBER", | ||
| + | "value": "test5", | ||
| + | "nice": "BCC Email", | ||
| + | "source": "site", | ||
| + | "readonly": 0 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_FROM_OWNER", | ||
| + | "value": "", | ||
| + | "default": "change@changeme.com", | ||
| + | "nice": "From Email", | ||
| + | "source": "config", | ||
| + | "readonly": 1 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_FROM_NICE_OWNER", | ||
| + | "value": "", | ||
| + | "nice": "From Name", | ||
| + | "source": "unset", | ||
| + | "readonly": 1 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_REPLY_OWNER", | ||
| + | "value": "", | ||
| + | "nice": "Reply Email", | ||
| + | "source": "unset", | ||
| + | "readonly": 1 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_REPLY_NICE_OWNER", | ||
| + | "value": "", | ||
| + | "nice": "Reply Name", | ||
| + | "source": "unset", | ||
| + | "readonly": 1 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_BCC_TO_OWNER", | ||
| + | "value": "", | ||
| + | "nice": "BCC Email", | ||
| + | "source": "unset", | ||
| + | "readonly": 1 | ||
| + | } | ||
| + | ], | ||
| + | "AFFILIATE": [ | ||
| + | { | ||
| + | "key": "EMAIL_FROM_AFFILIATE", | ||
| + | "value": "", | ||
| + | "default": "change@changeme.com", | ||
| + | "nice": "From Email", | ||
| + | "source": "config", | ||
| + | "readonly": 0 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_FROM_NICE_AFFILIATE", | ||
| + | "value": "", | ||
| + | "nice": "From Name", | ||
| + | "source": "unset", | ||
| + | "readonly": 0 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_REPLY_AFFILIATE", | ||
| + | "value": "", | ||
| + | "nice": "Reply Email", | ||
| + | "source": "unset", | ||
| + | "readonly": 0 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_REPLY_NICE_AFFILIATE", | ||
| + | "value": "", | ||
| + | "nice": "Reply Name", | ||
| + | "source": "unset", | ||
| + | "readonly": 0 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_BCC_TO_AFFILIATE", | ||
| + | "value": "", | ||
| + | "nice": "BCC Email", | ||
| + | "source": "unset", | ||
| + | "readonly": 0 | ||
| + | } | ||
| + | ], | ||
| + | "MEMBER": [ | ||
| + | { | ||
| + | "key": "EMAIL_FROM_MEMBER", | ||
| + | "value": "test1", | ||
| + | "default": "change@changeme.com", | ||
| + | "nice": "From Email", | ||
| + | "source": "site", | ||
| + | "readonly": 0 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_FROM_NICE_MEMBER", | ||
| + | "value": "test2", | ||
| + | "nice": "From Name", | ||
| + | "source": "site", | ||
| + | "readonly": 0 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_REPLY_MEMBER", | ||
| + | "value": "test3", | ||
| + | "nice": "Reply Email", | ||
| + | "source": "site", | ||
| + | "readonly": 0 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_REPLY_NICE_MEMBER", | ||
| + | "value": "test4", | ||
| + | "nice": "Reply Name", | ||
| + | "source": "site", | ||
| + | "readonly": 0 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_BCC_TO_MEMBER", | ||
| + | "value": "test5", | ||
| + | "nice": "BCC Email", | ||
| + | "source": "site", | ||
| + | "readonly": 0 | ||
| + | } | ||
| + | ], | ||
| + | "OWNER": [ | ||
| + | { | ||
| + | "key": "EMAIL_FROM_OWNER", | ||
| + | "value": "", | ||
| + | "default": "change@changeme.com", | ||
| + | "nice": "From Email", | ||
| + | "source": "config", | ||
| + | "readonly": 1 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_FROM_NICE_OWNER", | ||
| + | "value": "", | ||
| + | "nice": "From Name", | ||
| + | "source": "unset", | ||
| + | "readonly": 1 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_REPLY_OWNER", | ||
| + | "value": "", | ||
| + | "nice": "Reply Email", | ||
| + | "source": "unset", | ||
| + | "readonly": 1 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_REPLY_NICE_OWNER", | ||
| + | "value": "", | ||
| + | "nice": "Reply Name", | ||
| + | "source": "unset", | ||
| + | "readonly": 1 | ||
| + | }, | ||
| + | { | ||
| + | "key": "EMAIL_BCC_TO_OWNER", | ||
| + | "value": "", | ||
| + | "nice": "BCC Email", | ||
| + | "source": "unset", | ||
| + | "readonly": 1 | ||
| + | } | ||
| + | ], | ||
| + | "OWNER_TO": null | ||
| + | } | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 41: | Line 283: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = | + | $data = Array( |
| − | + | 'siteid' => '2', | |
| + | 'populate' => 0, | ||
); | ); | ||
| Line 84: | Line 327: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_site_Collection]] |
[[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | [[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | ||
| + | [[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | ||
Latest revision as of 16:01, 9 August 2019
GET /site/email-settings
Description
- Get email settings
Resource URL
- http://domain/api/site/email-settings
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- siteid
- type: digit
- optional
- populate
- type: boolean_digit (0 or 1)
- optional
Example Request
Method: GET
URL: http://domain/api/site/email-settings
Query String: siteid=2&populate=0
Response:
{
"success": 1,
"email_settings": {
"ALL": [
{
"key": "EMAIL_FROM_AFFILIATE",
"value": "",
"default": "change@changeme.com",
"nice": "From Email",
"source": "config",
"readonly": 0
},
{
"key": "EMAIL_FROM_NICE_AFFILIATE",
"value": "",
"nice": "From Name",
"source": "unset",
"readonly": 0
},
{
"key": "EMAIL_REPLY_AFFILIATE",
"value": "",
"nice": "Reply Email",
"source": "unset",
"readonly": 0
},
{
"key": "EMAIL_REPLY_NICE_AFFILIATE",
"value": "",
"nice": "Reply Name",
"source": "unset",
"readonly": 0
},
{
"key": "EMAIL_BCC_TO_AFFILIATE",
"value": "",
"nice": "BCC Email",
"source": "unset",
"readonly": 0
},
{
"key": "EMAIL_FROM_MEMBER",
"value": "test1",
"default": "change@changeme.com",
"nice": "From Email",
"source": "site",
"readonly": 0
},
{
"key": "EMAIL_FROM_NICE_MEMBER",
"value": "test2",
"nice": "From Name",
"source": "site",
"readonly": 0
},
{
"key": "EMAIL_REPLY_MEMBER",
"value": "test3",
"nice": "Reply Email",
"source": "site",
"readonly": 0
},
{
"key": "EMAIL_REPLY_NICE_MEMBER",
"value": "test4",
"nice": "Reply Name",
"source": "site",
"readonly": 0
},
{
"key": "EMAIL_BCC_TO_MEMBER",
"value": "test5",
"nice": "BCC Email",
"source": "site",
"readonly": 0
},
{
"key": "EMAIL_FROM_OWNER",
"value": "",
"default": "change@changeme.com",
"nice": "From Email",
"source": "config",
"readonly": 1
},
{
"key": "EMAIL_FROM_NICE_OWNER",
"value": "",
"nice": "From Name",
"source": "unset",
"readonly": 1
},
{
"key": "EMAIL_REPLY_OWNER",
"value": "",
"nice": "Reply Email",
"source": "unset",
"readonly": 1
},
{
"key": "EMAIL_REPLY_NICE_OWNER",
"value": "",
"nice": "Reply Name",
"source": "unset",
"readonly": 1
},
{
"key": "EMAIL_BCC_TO_OWNER",
"value": "",
"nice": "BCC Email",
"source": "unset",
"readonly": 1
}
],
"AFFILIATE": [
{
"key": "EMAIL_FROM_AFFILIATE",
"value": "",
"default": "change@changeme.com",
"nice": "From Email",
"source": "config",
"readonly": 0
},
{
"key": "EMAIL_FROM_NICE_AFFILIATE",
"value": "",
"nice": "From Name",
"source": "unset",
"readonly": 0
},
{
"key": "EMAIL_REPLY_AFFILIATE",
"value": "",
"nice": "Reply Email",
"source": "unset",
"readonly": 0
},
{
"key": "EMAIL_REPLY_NICE_AFFILIATE",
"value": "",
"nice": "Reply Name",
"source": "unset",
"readonly": 0
},
{
"key": "EMAIL_BCC_TO_AFFILIATE",
"value": "",
"nice": "BCC Email",
"source": "unset",
"readonly": 0
}
],
"MEMBER": [
{
"key": "EMAIL_FROM_MEMBER",
"value": "test1",
"default": "change@changeme.com",
"nice": "From Email",
"source": "site",
"readonly": 0
},
{
"key": "EMAIL_FROM_NICE_MEMBER",
"value": "test2",
"nice": "From Name",
"source": "site",
"readonly": 0
},
{
"key": "EMAIL_REPLY_MEMBER",
"value": "test3",
"nice": "Reply Email",
"source": "site",
"readonly": 0
},
{
"key": "EMAIL_REPLY_NICE_MEMBER",
"value": "test4",
"nice": "Reply Name",
"source": "site",
"readonly": 0
},
{
"key": "EMAIL_BCC_TO_MEMBER",
"value": "test5",
"nice": "BCC Email",
"source": "site",
"readonly": 0
}
],
"OWNER": [
{
"key": "EMAIL_FROM_OWNER",
"value": "",
"default": "change@changeme.com",
"nice": "From Email",
"source": "config",
"readonly": 1
},
{
"key": "EMAIL_FROM_NICE_OWNER",
"value": "",
"nice": "From Name",
"source": "unset",
"readonly": 1
},
{
"key": "EMAIL_REPLY_OWNER",
"value": "",
"nice": "Reply Email",
"source": "unset",
"readonly": 1
},
{
"key": "EMAIL_REPLY_NICE_OWNER",
"value": "",
"nice": "Reply Name",
"source": "unset",
"readonly": 1
},
{
"key": "EMAIL_BCC_TO_OWNER",
"value": "",
"nice": "BCC Email",
"source": "unset",
"readonly": 1
}
],
"OWNER_TO": null
}
}
Example Code
PHP
<?php
$headers = array( //set your username and API key here
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
$url = 'http://yourdomain.com'; //set your NATS URL here
$data = Array(
'siteid' => '2',
'populate' => 0,
);
$request = Array(
'method' => 'GET',
'path' => 'v1/site/email-settings',
'data' => $data
);
/*code below is the same for (almost) every API call */
$curl = curl_init();
$url = $url.'/api/'.$request['path'];
$query = http_build_query($request['data']);
if($request['method'] == 'GET'){
//add query string parameters to the end of the url
$url = $url.'?'.$query;
}else{
//send parameters as POST fields
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, $query);
if($request['method'] != 'POST'){
$headers[] ='X-HTTP-Method: '.$request['method']; //send custom request method
}
}
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
