Save E Mail Account

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/EMail/SaveEMailAccount");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"EMailAccountId\": 123,\n  \"EMailAddress\": \"<string>\",\n  \"AssociateId\": 123,\n  \"IncomingCredentials\": {\n    \"ServiceAuthId\": 123,\n    \"Server\": \"<string>\",\n    \"Port\": 123,\n    \"AuthType\": \"<string>\",\n    \"Username\": \"<string>\",\n    \"Password\": \"<string>\",\n    \"TableRight\": {\n      \"Mask\": \"<string>\",\n      \"Reason\": \"<string>\"\n    },\n    \"FieldProperties\": {}\n  },\n  \"OutgoingCredentials\": {\n    \"ServiceAuthId\": 123,\n    \"Server\": \"<string>\",\n    \"Port\": 123,\n    \"AuthType\": \"<string>\",\n    \"Username\": \"<string>\",\n    \"Password\": \"<string>\",\n    \"TableRight\": {\n      \"Mask\": \"<string>\",\n      \"Reason\": \"<string>\"\n    },\n    \"FieldProperties\": {}\n  },\n  \"AccountStatus\": 123,\n  \"ErrorCount\": 123,\n  \"ErrorReason\": \"<string>\",\n  \"InboxFolder\": \"<string>\",\n  \"SentFolder\": \"<string>\",\n  \"LastFetch\": \"2023-11-07T05:31:56Z\",\n  \"UseGraphApi\": 123,\n  \"TableRight\": {\n    \"Mask\": \"<string>\",\n    \"Reason\": \"<string>\"\n  },\n  \"FieldProperties\": {}\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({
    EMailAccountId: 123,
    EMailAddress: '<string>',
    AssociateId: 123,
    IncomingCredentials: {
      ServiceAuthId: 123,
      Server: '<string>',
      Port: 123,
      AuthType: '<string>',
      Username: '<string>',
      Password: '<string>',
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    },
    OutgoingCredentials: {
      ServiceAuthId: 123,
      Server: '<string>',
      Port: 123,
      AuthType: '<string>',
      Username: '<string>',
      Password: '<string>',
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    },
    AccountStatus: 123,
    ErrorCount: 123,
    ErrorReason: '<string>',
    InboxFolder: '<string>',
    SentFolder: '<string>',
    LastFetch: '2023-11-07T05:31:56Z',
    UseGraphApi: 123,
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:56350/api/v1/Agents/EMail/SaveEMailAccount', 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/SaveEMailAccount",
  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([
    'EMailAccountId' => 123,
    'EMailAddress' => '<string>',
    'AssociateId' => 123,
    'IncomingCredentials' => [
        'ServiceAuthId' => 123,
        'Server' => '<string>',
        'Port' => 123,
        'AuthType' => '<string>',
        'Username' => '<string>',
        'Password' => '<string>',
        'TableRight' => [
                'Mask' => '<string>',
                'Reason' => '<string>'
        ],
        'FieldProperties' => [
                
        ]
    ],
    'OutgoingCredentials' => [
        'ServiceAuthId' => 123,
        'Server' => '<string>',
        'Port' => 123,
        'AuthType' => '<string>',
        'Username' => '<string>',
        'Password' => '<string>',
        'TableRight' => [
                'Mask' => '<string>',
                'Reason' => '<string>'
        ],
        'FieldProperties' => [
                
        ]
    ],
    'AccountStatus' => 123,
    'ErrorCount' => 123,
    'ErrorReason' => '<string>',
    'InboxFolder' => '<string>',
    'SentFolder' => '<string>',
    'LastFetch' => '2023-11-07T05:31:56Z',
    'UseGraphApi' => 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/SaveEMailAccount"

payload = {
    "EMailAccountId": 123,
    "EMailAddress": "<string>",
    "AssociateId": 123,
    "IncomingCredentials": {
        "ServiceAuthId": 123,
        "Server": "<string>",
        "Port": 123,
        "AuthType": "<string>",
        "Username": "<string>",
        "Password": "<string>",
        "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
        },
        "FieldProperties": {}
    },
    "OutgoingCredentials": {
        "ServiceAuthId": 123,
        "Server": "<string>",
        "Port": 123,
        "AuthType": "<string>",
        "Username": "<string>",
        "Password": "<string>",
        "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
        },
        "FieldProperties": {}
    },
    "AccountStatus": 123,
    "ErrorCount": 123,
    "ErrorReason": "<string>",
    "InboxFolder": "<string>",
    "SentFolder": "<string>",
    "LastFetch": "2023-11-07T05:31:56Z",
    "UseGraphApi": 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({
    EMailAccountId: 123,
    EMailAddress: '<string>',
    AssociateId: 123,
    IncomingCredentials: {
      ServiceAuthId: 123,
      Server: '<string>',
      Port: 123,
      AuthType: '<string>',
      Username: '<string>',
      Password: '<string>',
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    },
    OutgoingCredentials: {
      ServiceAuthId: 123,
      Server: '<string>',
      Port: 123,
      AuthType: '<string>',
      Username: '<string>',
      Password: '<string>',
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    },
    AccountStatus: 123,
    ErrorCount: 123,
    ErrorReason: '<string>',
    InboxFolder: '<string>',
    SentFolder: '<string>',
    LastFetch: '2023-11-07T05:31:56Z',
    UseGraphApi: 123,
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:56350/api/v1/Agents/EMail/SaveEMailAccount', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "EMailAccountId": 123,
  "EMailAddress": "<string>",
  "AssociateId": 123,
  "IncomingCredentials": {
    "ServiceAuthId": 123,
    "Server": "<string>",
    "Port": 123,
    "AuthType": "<string>",
    "Username": "<string>",
    "Password": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "OutgoingCredentials": {
    "ServiceAuthId": 123,
    "Server": "<string>",
    "Port": 123,
    "AuthType": "<string>",
    "Username": "<string>",
    "Password": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "AccountStatus": 123,
  "ErrorCount": 123,
  "ErrorReason": "<string>",
  "InboxFolder": "<string>",
  "SentFolder": "<string>",
  "LastFetch": "2023-11-07T05:31:56Z",
  "UseGraphApi": 123,
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Save E Mail Account

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/EMail/SaveEMailAccount");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"EMailAccountId\": 123,\n  \"EMailAddress\": \"<string>\",\n  \"AssociateId\": 123,\n  \"IncomingCredentials\": {\n    \"ServiceAuthId\": 123,\n    \"Server\": \"<string>\",\n    \"Port\": 123,\n    \"AuthType\": \"<string>\",\n    \"Username\": \"<string>\",\n    \"Password\": \"<string>\",\n    \"TableRight\": {\n      \"Mask\": \"<string>\",\n      \"Reason\": \"<string>\"\n    },\n    \"FieldProperties\": {}\n  },\n  \"OutgoingCredentials\": {\n    \"ServiceAuthId\": 123,\n    \"Server\": \"<string>\",\n    \"Port\": 123,\n    \"AuthType\": \"<string>\",\n    \"Username\": \"<string>\",\n    \"Password\": \"<string>\",\n    \"TableRight\": {\n      \"Mask\": \"<string>\",\n      \"Reason\": \"<string>\"\n    },\n    \"FieldProperties\": {}\n  },\n  \"AccountStatus\": 123,\n  \"ErrorCount\": 123,\n  \"ErrorReason\": \"<string>\",\n  \"InboxFolder\": \"<string>\",\n  \"SentFolder\": \"<string>\",\n  \"LastFetch\": \"2023-11-07T05:31:56Z\",\n  \"UseGraphApi\": 123,\n  \"TableRight\": {\n    \"Mask\": \"<string>\",\n    \"Reason\": \"<string>\"\n  },\n  \"FieldProperties\": {}\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({
    EMailAccountId: 123,
    EMailAddress: '<string>',
    AssociateId: 123,
    IncomingCredentials: {
      ServiceAuthId: 123,
      Server: '<string>',
      Port: 123,
      AuthType: '<string>',
      Username: '<string>',
      Password: '<string>',
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    },
    OutgoingCredentials: {
      ServiceAuthId: 123,
      Server: '<string>',
      Port: 123,
      AuthType: '<string>',
      Username: '<string>',
      Password: '<string>',
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    },
    AccountStatus: 123,
    ErrorCount: 123,
    ErrorReason: '<string>',
    InboxFolder: '<string>',
    SentFolder: '<string>',
    LastFetch: '2023-11-07T05:31:56Z',
    UseGraphApi: 123,
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:56350/api/v1/Agents/EMail/SaveEMailAccount', 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/SaveEMailAccount",
  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([
    'EMailAccountId' => 123,
    'EMailAddress' => '<string>',
    'AssociateId' => 123,
    'IncomingCredentials' => [
        'ServiceAuthId' => 123,
        'Server' => '<string>',
        'Port' => 123,
        'AuthType' => '<string>',
        'Username' => '<string>',
        'Password' => '<string>',
        'TableRight' => [
                'Mask' => '<string>',
                'Reason' => '<string>'
        ],
        'FieldProperties' => [
                
        ]
    ],
    'OutgoingCredentials' => [
        'ServiceAuthId' => 123,
        'Server' => '<string>',
        'Port' => 123,
        'AuthType' => '<string>',
        'Username' => '<string>',
        'Password' => '<string>',
        'TableRight' => [
                'Mask' => '<string>',
                'Reason' => '<string>'
        ],
        'FieldProperties' => [
                
        ]
    ],
    'AccountStatus' => 123,
    'ErrorCount' => 123,
    'ErrorReason' => '<string>',
    'InboxFolder' => '<string>',
    'SentFolder' => '<string>',
    'LastFetch' => '2023-11-07T05:31:56Z',
    'UseGraphApi' => 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/SaveEMailAccount"

payload = {
    "EMailAccountId": 123,
    "EMailAddress": "<string>",
    "AssociateId": 123,
    "IncomingCredentials": {
        "ServiceAuthId": 123,
        "Server": "<string>",
        "Port": 123,
        "AuthType": "<string>",
        "Username": "<string>",
        "Password": "<string>",
        "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
        },
        "FieldProperties": {}
    },
    "OutgoingCredentials": {
        "ServiceAuthId": 123,
        "Server": "<string>",
        "Port": 123,
        "AuthType": "<string>",
        "Username": "<string>",
        "Password": "<string>",
        "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
        },
        "FieldProperties": {}
    },
    "AccountStatus": 123,
    "ErrorCount": 123,
    "ErrorReason": "<string>",
    "InboxFolder": "<string>",
    "SentFolder": "<string>",
    "LastFetch": "2023-11-07T05:31:56Z",
    "UseGraphApi": 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({
    EMailAccountId: 123,
    EMailAddress: '<string>',
    AssociateId: 123,
    IncomingCredentials: {
      ServiceAuthId: 123,
      Server: '<string>',
      Port: 123,
      AuthType: '<string>',
      Username: '<string>',
      Password: '<string>',
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    },
    OutgoingCredentials: {
      ServiceAuthId: 123,
      Server: '<string>',
      Port: 123,
      AuthType: '<string>',
      Username: '<string>',
      Password: '<string>',
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    },
    AccountStatus: 123,
    ErrorCount: 123,
    ErrorReason: '<string>',
    InboxFolder: '<string>',
    SentFolder: '<string>',
    LastFetch: '2023-11-07T05:31:56Z',
    UseGraphApi: 123,
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:56350/api/v1/Agents/EMail/SaveEMailAccount', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "EMailAccountId": 123,
  "EMailAddress": "<string>",
  "AssociateId": 123,
  "IncomingCredentials": {
    "ServiceAuthId": 123,
    "Server": "<string>",
    "Port": 123,
    "AuthType": "<string>",
    "Username": "<string>",
    "Password": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "OutgoingCredentials": {
    "ServiceAuthId": 123,
    "Server": "<string>",
    "Port": 123,
    "AuthType": "<string>",
    "Username": "<string>",
    "Password": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "AccountStatus": 123,
  "ErrorCount": 123,
  "ErrorReason": "<string>",
  "InboxFolder": "<string>",
  "SentFolder": "<string>",
  "LastFetch": "2023-11-07T05:31:56Z",
  "UseGraphApi": 123,
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Headers

Accept-Language

string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language

string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture

string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone

string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken

string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Body

The EMailAccount that is saved

Properties for an email account Carrier object for EMailAccount. Services for the EMailAccount Carrier is available from the EMail Agent.

EMailAccountId

integer<int32>

The account primary key

EMailAddress

string

The account (from) address

AssociateId

integer<int32>

Id of the associate who owns this account

IncomingCredentials

object

Properties for service authentication Carrier object for ServiceAuth. Services for the ServiceAuth Carrier is available from the User Agent.

Show child attributes

OutgoingCredentials

object

Properties for service authentication Carrier object for ServiceAuth. Services for the ServiceAuth Carrier is available from the User Agent.

Show child attributes

AccountStatus

integer<int32>

The account status (Disabled or...) Readonly field

ErrorCount

integer<int32>

Count of concurring errors of fetching email. Readonly field

ErrorReason

string

Reason/Error message. Readonly field

InboxFolder

string

Inbox folder name if available in the db

SentFolder

string

Sent email folder name if available in the db

LastFetch

string<date-time>

When we last fetched email in UTC.

UseGraphApi

integer<int32>

Use the GraphApi for this account

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes

Response

Properties for an email account Carrier object for EMailAccount. Services for the EMailAccount Carrier is available from the EMail Agent.

EMailAccountId

integer<int32>

The account primary key

EMailAddress

string

The account (from) address

AssociateId

integer<int32>

Id of the associate who owns this account

IncomingCredentials

object

Properties for service authentication Carrier object for ServiceAuth. Services for the ServiceAuth Carrier is available from the User Agent.

Show child attributes

OutgoingCredentials

object

Properties for service authentication Carrier object for ServiceAuth. Services for the ServiceAuth Carrier is available from the User Agent.

Show child attributes

AccountStatus

integer<int32>

The account status (Disabled or...) Readonly field

ErrorCount

integer<int32>

Count of concurring errors of fetching email. Readonly field

ErrorReason

string

Reason/Error message. Readonly field

InboxFolder

string

Inbox folder name if available in the db

SentFolder

string

Sent email folder name if available in the db

LastFetch

string<date-time>

When we last fetched email in UTC.

UseGraphApi

integer<int32>

Use the GraphApi for this account

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes