Set Subscription
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/EMail/SetSubscription");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"ConnectionInfo\": {\n \"ServerName\": \"<string>\",\n \"UserName\": \"<string>\",\n \"Password\": \"<string>\",\n \"Folder\": \"<string>\",\n \"UseSSL\": true,\n \"UseGraphApi\": true,\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"Folders\": [\n {\n \"Name\": \"<string>\",\n \"Delimiter\": \"<string>\",\n \"Flags\": \"<string>\",\n \"TotalItems\": 123,\n \"UnreadItems\": 123,\n \"Subscribed\": true,\n \"EmailFolderId\": 123,\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ]\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
ConnectionInfo: {
ServerName: '<string>',
UserName: '<string>',
Password: '<string>',
Folder: '<string>',
UseSSL: true,
UseGraphApi: true,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
Folders: [
{
Name: '<string>',
Delimiter: '<string>',
Flags: '<string>',
TotalItems: 123,
UnreadItems: 123,
Subscribed: true,
EmailFolderId: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
]
})
};
fetch('http://localhost:56350/api/v1/Agents/EMail/SetSubscription', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/EMail/SetSubscription",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ConnectionInfo' => [
'ServerName' => '<string>',
'UserName' => '<string>',
'Password' => '<string>',
'Folder' => '<string>',
'UseSSL' => true,
'UseGraphApi' => true,
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'Folders' => [
[
'Name' => '<string>',
'Delimiter' => '<string>',
'Flags' => '<string>',
'TotalItems' => 123,
'UnreadItems' => 123,
'Subscribed' => true,
'EmailFolderId' => 123,
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:56350/api/v1/Agents/EMail/SetSubscription"
payload = {
"ConnectionInfo": {
"ServerName": "<string>",
"UserName": "<string>",
"Password": "<string>",
"Folder": "<string>",
"UseSSL": True,
"UseGraphApi": True,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Folders": [
{
"Name": "<string>",
"Delimiter": "<string>",
"Flags": "<string>",
"TotalItems": 123,
"UnreadItems": 123,
"Subscribed": True,
"EmailFolderId": 123,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
ConnectionInfo: {
ServerName: '<string>',
UserName: '<string>',
Password: '<string>',
Folder: '<string>',
UseSSL: true,
UseGraphApi: true,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
Folders: [
{
Name: '<string>',
Delimiter: '<string>',
Flags: '<string>',
TotalItems: 123,
UnreadItems: 123,
Subscribed: true,
EmailFolderId: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
]
})
};
fetch('http://localhost:56350/api/v1/Agents/EMail/SetSubscription', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Set subscription on or off on a set of folders
NsApiSlow threshold: 5000 ms.
Set Subscription
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/EMail/SetSubscription");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"ConnectionInfo\": {\n \"ServerName\": \"<string>\",\n \"UserName\": \"<string>\",\n \"Password\": \"<string>\",\n \"Folder\": \"<string>\",\n \"UseSSL\": true,\n \"UseGraphApi\": true,\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"Folders\": [\n {\n \"Name\": \"<string>\",\n \"Delimiter\": \"<string>\",\n \"Flags\": \"<string>\",\n \"TotalItems\": 123,\n \"UnreadItems\": 123,\n \"Subscribed\": true,\n \"EmailFolderId\": 123,\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ]\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
ConnectionInfo: {
ServerName: '<string>',
UserName: '<string>',
Password: '<string>',
Folder: '<string>',
UseSSL: true,
UseGraphApi: true,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
Folders: [
{
Name: '<string>',
Delimiter: '<string>',
Flags: '<string>',
TotalItems: 123,
UnreadItems: 123,
Subscribed: true,
EmailFolderId: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
]
})
};
fetch('http://localhost:56350/api/v1/Agents/EMail/SetSubscription', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/EMail/SetSubscription",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ConnectionInfo' => [
'ServerName' => '<string>',
'UserName' => '<string>',
'Password' => '<string>',
'Folder' => '<string>',
'UseSSL' => true,
'UseGraphApi' => true,
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'Folders' => [
[
'Name' => '<string>',
'Delimiter' => '<string>',
'Flags' => '<string>',
'TotalItems' => 123,
'UnreadItems' => 123,
'Subscribed' => true,
'EmailFolderId' => 123,
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:56350/api/v1/Agents/EMail/SetSubscription"
payload = {
"ConnectionInfo": {
"ServerName": "<string>",
"UserName": "<string>",
"Password": "<string>",
"Folder": "<string>",
"UseSSL": True,
"UseGraphApi": True,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Folders": [
{
"Name": "<string>",
"Delimiter": "<string>",
"Flags": "<string>",
"TotalItems": 123,
"UnreadItems": 123,
"Subscribed": True,
"EmailFolderId": 123,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
ConnectionInfo: {
ServerName: '<string>',
UserName: '<string>',
Password: '<string>',
Folder: '<string>',
UseSSL: true,
UseGraphApi: true,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
Folders: [
{
Name: '<string>',
Delimiter: '<string>',
Flags: '<string>',
TotalItems: 123,
UnreadItems: 123,
Subscribed: true,
EmailFolderId: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
]
})
};
fetch('http://localhost:56350/api/v1/Agents/EMail/SetSubscription', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Headers
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Body
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/json-patch+jsonapplication/merge-patch+json
ConnectionInfo, Folders
SetSubscription: Set subscription on or off on a set of folders
Response
204
No Content
⌘I