Create Default E Mail Entity

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/EMail/CreateDefaultEMailEntity");
var client = new RestClient(options);
var request = new RestRequest("");
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {method: 'POST'};

fetch('http://localhost:56350/api/v1/Agents/EMail/CreateDefaultEMailEntity', 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/CreateDefaultEMailEntity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

const options = {method: 'POST'};

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

{
  "To": [
    {
      "ContactId": 123,
      "ContactName": "<string>",
      "PersonId": 123,
      "PersonName": "<string>",
      "AssociateId": 123,
      "Address": "<string>",
      "EmailId": 123,
      "DuplicatePersonIds": [
        123
      ],
      "Name": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "Cc": [
    {
      "ContactId": 123,
      "ContactName": "<string>",
      "PersonId": 123,
      "PersonName": "<string>",
      "AssociateId": 123,
      "Address": "<string>",
      "EmailId": 123,
      "DuplicatePersonIds": [
        123
      ],
      "Name": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "Bcc": [
    {
      "ContactId": 123,
      "ContactName": "<string>",
      "PersonId": 123,
      "PersonName": "<string>",
      "AssociateId": 123,
      "Address": "<string>",
      "EmailId": 123,
      "DuplicatePersonIds": [
        123
      ],
      "Name": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "Subject": "<string>",
  "HTMLBody": "<string>",
  "From": {
    "ContactId": 123,
    "ContactName": "<string>",
    "PersonId": 123,
    "PersonName": "<string>",
    "AssociateId": 123,
    "Address": "<string>",
    "EmailId": 123,
    "DuplicatePersonIds": [
      123
    ],
    "Name": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Sent": "2023-11-07T05:31:56Z",
  "Size": 123,
  "Priority": "NoPriority",
  "Flags": "None",
  "MessageID": "<string>",
  "PlainBody": "<string>",
  "IsSent": true,
  "EMailSOInfo": {
    "DocumentId": 123,
    "AppointmentId": 123,
    "ProjectId": 123,
    "SaleId": 123,
    "Archived": true,
    "ArchivedAt": "2023-11-07T05:31:56Z",
    "ArchivedBy": 123,
    "ArchivedDisplayName": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "ServerId": 123,
  "ServerIdentifier": "<string>",
  "Attachments": [
    {
      "Description": "<string>",
      "Filename": "<string>",
      "Size": 123,
      "Type": "<string>",
      "Encoding": "<string>",
      "Id": "<string>",
      "Disposition": "<string>",
      "IsSafeFileExtension": true,
      "Stream": "aSDinaTvuI8gbWludGxpZnk=",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "CustomHeaderList": [
    {
      "Name": "<string>",
      "Values": [
        "<string>"
      ],
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "FolderName": "<string>",
  "EmailItemId": 123,
  "AccountId": 123,
  "ReceivedAt": "2023-11-07T05:31:56Z",
  "InReplyTo": {
    "ServerId": 123,
    "ServerIdentifier": "<string>",
    "MessageId": "<string>",
    "Subject": "<string>",
    "From": {
      "ContactId": 123,
      "ContactName": "<string>",
      "PersonId": 123,
      "PersonName": "<string>",
      "AssociateId": 123,
      "Address": "<string>",
      "EmailId": 123,
      "DuplicatePersonIds": [
        123
      ],
      "Name": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    },
    "To": [
      {
        "ContactId": 123,
        "ContactName": "<string>",
        "PersonId": 123,
        "PersonName": "<string>",
        "AssociateId": 123,
        "Address": "<string>",
        "EmailId": 123,
        "DuplicatePersonIds": [
          123
        ],
        "Name": "<string>",
        "TableRight": {
          "Mask": "<string>",
          "Reason": "<string>"
        },
        "FieldProperties": {}
      }
    ],
    "Sent": "2023-11-07T05:31:56Z",
    "Priority": "NoPriority",
    "Flags": "None",
    "Size": 123,
    "EMailSOInfo": {
      "DocumentId": 123,
      "AppointmentId": 123,
      "ProjectId": 123,
      "SaleId": 123,
      "Archived": true,
      "ArchivedAt": "2023-11-07T05:31:56Z",
      "ArchivedBy": 123,
      "ArchivedDisplayName": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    },
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "RepliedAt": "2023-11-07T05:31:56Z",
  "HasCalendarData": true,
  "CalMethod": "Unknown",
  "CalReplyStatus": "Unknown",
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Create Default E Mail Entity

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/EMail/CreateDefaultEMailEntity");
var client = new RestClient(options);
var request = new RestRequest("");
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {method: 'POST'};

fetch('http://localhost:56350/api/v1/Agents/EMail/CreateDefaultEMailEntity', 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/CreateDefaultEMailEntity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

const options = {method: 'POST'};

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

{
  "To": [
    {
      "ContactId": 123,
      "ContactName": "<string>",
      "PersonId": 123,
      "PersonName": "<string>",
      "AssociateId": 123,
      "Address": "<string>",
      "EmailId": 123,
      "DuplicatePersonIds": [
        123
      ],
      "Name": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "Cc": [
    {
      "ContactId": 123,
      "ContactName": "<string>",
      "PersonId": 123,
      "PersonName": "<string>",
      "AssociateId": 123,
      "Address": "<string>",
      "EmailId": 123,
      "DuplicatePersonIds": [
        123
      ],
      "Name": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "Bcc": [
    {
      "ContactId": 123,
      "ContactName": "<string>",
      "PersonId": 123,
      "PersonName": "<string>",
      "AssociateId": 123,
      "Address": "<string>",
      "EmailId": 123,
      "DuplicatePersonIds": [
        123
      ],
      "Name": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "Subject": "<string>",
  "HTMLBody": "<string>",
  "From": {
    "ContactId": 123,
    "ContactName": "<string>",
    "PersonId": 123,
    "PersonName": "<string>",
    "AssociateId": 123,
    "Address": "<string>",
    "EmailId": 123,
    "DuplicatePersonIds": [
      123
    ],
    "Name": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Sent": "2023-11-07T05:31:56Z",
  "Size": 123,
  "Priority": "NoPriority",
  "Flags": "None",
  "MessageID": "<string>",
  "PlainBody": "<string>",
  "IsSent": true,
  "EMailSOInfo": {
    "DocumentId": 123,
    "AppointmentId": 123,
    "ProjectId": 123,
    "SaleId": 123,
    "Archived": true,
    "ArchivedAt": "2023-11-07T05:31:56Z",
    "ArchivedBy": 123,
    "ArchivedDisplayName": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "ServerId": 123,
  "ServerIdentifier": "<string>",
  "Attachments": [
    {
      "Description": "<string>",
      "Filename": "<string>",
      "Size": 123,
      "Type": "<string>",
      "Encoding": "<string>",
      "Id": "<string>",
      "Disposition": "<string>",
      "IsSafeFileExtension": true,
      "Stream": "aSDinaTvuI8gbWludGxpZnk=",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "CustomHeaderList": [
    {
      "Name": "<string>",
      "Values": [
        "<string>"
      ],
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "FolderName": "<string>",
  "EmailItemId": 123,
  "AccountId": 123,
  "ReceivedAt": "2023-11-07T05:31:56Z",
  "InReplyTo": {
    "ServerId": 123,
    "ServerIdentifier": "<string>",
    "MessageId": "<string>",
    "Subject": "<string>",
    "From": {
      "ContactId": 123,
      "ContactName": "<string>",
      "PersonId": 123,
      "PersonName": "<string>",
      "AssociateId": 123,
      "Address": "<string>",
      "EmailId": 123,
      "DuplicatePersonIds": [
        123
      ],
      "Name": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    },
    "To": [
      {
        "ContactId": 123,
        "ContactName": "<string>",
        "PersonId": 123,
        "PersonName": "<string>",
        "AssociateId": 123,
        "Address": "<string>",
        "EmailId": 123,
        "DuplicatePersonIds": [
          123
        ],
        "Name": "<string>",
        "TableRight": {
          "Mask": "<string>",
          "Reason": "<string>"
        },
        "FieldProperties": {}
      }
    ],
    "Sent": "2023-11-07T05:31:56Z",
    "Priority": "NoPriority",
    "Flags": "None",
    "Size": 123,
    "EMailSOInfo": {
      "DocumentId": 123,
      "AppointmentId": 123,
      "ProjectId": 123,
      "SaleId": 123,
      "Archived": true,
      "ArchivedAt": "2023-11-07T05:31:56Z",
      "ArchivedBy": 123,
      "ArchivedDisplayName": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    },
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "RepliedAt": "2023-11-07T05:31:56Z",
  "HasCalendarData": true,
  "CalMethod": "Unknown",
  "CalReplyStatus": "Unknown",
  "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.

Response

All information about an e-mail Carrier object for EMailEntity. Services for the EMailEntity Carrier is available from the EMail Agent.

object[]

To recipients of e-mail

Show child attributes

object[]

Cc recipients of e-mail

Show child attributes

Bcc

object[]

Bcc recipient of e-mail

Show child attributes

Subject

string

Subject of the e-mail

HTMLBody

string

Body formatted in HTML

From

object

Carrier object for EMailAddress. Services for the EMailAddress Carrier is available from the EMail Agent.

Show child attributes

Sent

string<date-time>

When was the e-mail sent

Size

integer<int32>

Total size of the e-mail

Priority

enum<string>

Importance of the e-mail

Available options:

NoPriority,

Highest,

High,

Normal,

Low,

Lowest

Flags

enum<string>

Flag status of this mail (unread, replied, deleted )

Available options:

None,

Seen,

Deleted,

Recent,

Flagged,

Draft,

Answered

MessageID

string

Unique id of e-mails

PlainBody

string

Body formatted in plain text

IsSent

boolean

Is this a sent e-mail (not new)

EMailSOInfo

object

Glue between SuperOffice data and an e-mail. Carrier object for EMailSOInfo. Services for the EMailSOInfo Carrier is available from the EMail Agent.

Show child attributes

ServerId

integer<int32>

Unique id for the e-mail on the server

ServerIdentifier

string

Server identifier of this email item (GraphApi uses string Id's)

Attachments

object[]

Show child attributes

CustomHeaderList

object[]

Non standard e-mail headers

Show child attributes

FolderName

string

Name of folder the e-mail belongs in

EmailItemId

integer<int32>

Primary key

AccountId

integer<int32>

Account Id

ReceivedAt

string<date-time>

Received date time

InReplyTo

object

Limited information about one e-mail. Carrier object for EMailEnvelope. Services for the EMailEnvelope Carrier is available from the EMail Agent.

Show child attributes

RepliedAt

string<date-time>

When this email was replied at

HasCalendarData

boolean

If this email contains exactly one iCal appointment

CalMethod

enum<string>

Method stored in the associated iCal appointment. Indicates if the iCal data is a reply, counter proposal etc.

Available options:

Unknown,

Add,

Cancel,

Counter,

DeclineCounter,

Publish,

Refresh,

Reply,

Request

CalReplyStatus

enum<string>

Reply status stored in calendar data for the ical method is REPLY

Available options:

Unknown,

Accepted,

Declined,

Tentative

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