POST Agents/EMail/CreateDefaultEMailEnvelope

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/EMail/CreateDefaultEMailEnvelope

Loading default values into a new EMailEnvelope.

NsApiSlow threshold: 5000 ms.

Online Restricted: ## The EMail agent is not available in Online by default. Access must be requested specifically when app is registered.

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:

OK

Response Description
200 OK

Response body: EMailEnvelope

Property Name Type Description
ServerId int32 Unique id for the e-mail on the server
MessageId string Unique id of e-mails
Subject string Subject of the e-mail
From EMailAddress Who did the e-mail originate from
To array To recipients of e-mail
Sent date-time When was the e-mail sent
Priority string Importance of the e-mail
Flags string Flag status of this mail (unread, replied, deleted )
Size int32 Total size of the e-mail
EMailSOInfo EMailSOInfo Glue between SuperOffice data and an e-mail.
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/EMail/CreateDefaultEMailEnvelope
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "ServerId": 183,
  "MessageId": "<20061228101059.78901@acmecorp.com>",
  "Subject": "Invoice Approval Request - December 2024",
  "From": null,
  "To": [
    {
      "ContactId": 70,
      "ContactName": "Acme Corporation",
      "PersonId": 267,
      "PersonName": "John Anderson",
      "AssociateId": 374,
      "Address": "john.anderson@acmecorp.com",
      "EmailId": 566,
      "DuplicatePersonIds": [
        634,
        753
      ],
      "Name": "John Anderson",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.String",
          "FieldLength": 221
        }
      }
    }
  ],
  "Sent": "2006-12-28T10:10:59.9939684+01:00",
  "Priority": "High",
  "Flags": "Answered",
  "Size": 662,
  "EMailSOInfo": null,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 201
    }
  }
}