Retrieve an instance of mailboxes

get

/services/rest/connect/latest/mailboxes/{id}

Request

Path Parameters

Response

Supported Media Types

Default Response

Body ()
An email box used by the system that is dedicated to collecting email inquiries sent by customers, responses to mailings, and bounced messages.
Root Schema : mailboxes
Type: object
An email box used by the system that is dedicated to collecting email inquiries sent by customers, responses to mailings, and bounced messages.
Show Source
Nested Schema : mailboxes-incomingEmailSettings
Type: object
Settings for incoming emails for an email box
Show Source
  • Indicates whether the Force Reply Between the Lines feature is enabled on outgoing emails from the mailbox
  • Maximum Length: 80
    Pattern: ^(((([-_!#$%&'*+/=?^~`{|}\w]+(\.[.]?[-_!#$%&'*+/=?^~`{|}\w]+)*)|("[^"]+"))@[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*(\.[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*)+[;, ]*)+|((("[^"]+")?|([-_!#$%&'*+/=?^~`{|}\w[:blank:]])*)[[:blank:]]*[<]([-_!#$%&'*+/=?^~`{|}\w]+(\.[.]?[-_!#$%&'*+/=?^~`{|}\w]+)*))@[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*(\.[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*)+[>]|((("[^"]+")?|([-_!#$%&'*+/=?^~`{|}\w[:blank:]])*)[[:blank:]]*[(]([-_!#$%&'*+/=?^~`{|}\w]+(\.[.]?[-_!#$%&'*+/=?^~`{|}\w]+)*))@[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*(\.[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*)+[)])$
    The address that rejected messages are sent to
  • Indicates whether incoming email is enabled
Nested Schema : siteInterfaces
Type: object
The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. The interface name determines the URL for the web site, the name of the system executables, and the .cfg directory name.
Show Source
Nested Schema : mailboxes-outgoingEmailSettings
Type: object
Settings for outgoing emails for an email box
Show Source
  • Maximum Length: 80
    Pattern: ^[^ ]*$
    The display name used in the outgoing emails from the mailbox
  • Maximum Length: 80
    Pattern: ^((([-_!#$%&'*+/=?^~`{|}\w]+(\.[.]?[-_!#$%&'*+/=?^~`{|}\w]+)*)|("[^"]+"))@[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*(\.[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*)+[; ]*)$
    The friendly from address used to brand outgoing emails from the mailbox
  • Maximum Length: 80
    Pattern: ^(((([-_!#$%&'*+/=?^~`{|}\w]+(\.[.]?[-_!#$%&'*+/=?^~`{|}\w]+)*)|("[^"]+"))@[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*(\.[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*)+[;, ]*)+|((("[^"]+")?|([-_!#$%&'*+/=?^~`{|}\w[:blank:]])*)[[:blank:]]*[<]([-_!#$%&'*+/=?^~`{|}\w]+(\.[.]?[-_!#$%&'*+/=?^~`{|}\w]+)*))@[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*(\.[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*)+[>]|((("[^"]+")?|([-_!#$%&'*+/=?^~`{|}\w[:blank:]])*)[[:blank:]]*[(]([-_!#$%&'*+/=?^~`{|}\w]+(\.[.]?[-_!#$%&'*+/=?^~`{|}\w]+)*))@[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*(\.[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*)+[)])$
    The email address specified on the outgoing email from the mailbox
  • Indicates whether outgoing email is enabled
  • Maximum Length: 80
    Pattern: ^(((([-_!#$%&'*+/=?^~`{|}\w]+(\.[.]?[-_!#$%&'*+/=?^~`{|}\w]+)*)|("[^"]+"))@[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*(\.[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*)+[;, ]*)+|((("[^"]+")?|([-_!#$%&'*+/=?^~`{|}\w[:blank:]])*)[[:blank:]]*[<]([-_!#$%&'*+/=?^~`{|}\w]+(\.[.]?[-_!#$%&'*+/=?^~`{|}\w]+)*))@[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*(\.[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*)+[>]|((("[^"]+")?|([-_!#$%&'*+/=?^~`{|}\w[:blank:]])*)[[:blank:]]*[(]([-_!#$%&'*+/=?^~`{|}\w]+(\.[.]?[-_!#$%&'*+/=?^~`{|}\w]+)*))@[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*(\.[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*)+[)])$
    The reply to address used on the outgoing emails from the mailbox
Nested Schema : namedIDs-mailboxes-type
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-siteInterfaces-language
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source

Examples

Use GET with the following syntax to retrieve data for a mailbox:

https://your_site_interface/services/rest/connect/version/mailboxes/mailbox_id

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/mailboxes/1

Response body example

{
  "id": 1,
  "lookupName": "General Service",
  "createdTime": "2010-01-01T00:00:00.000Z",
  "updatedTime": "2010-01-01T00:00:00.000Z",
  "incomingEmailSettings": {
    "forceReplyBetweenLines": true,
    "forwardRejectMessageAddress": null,
    "isEnabled": false
  },
  "interface": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/siteInterfaces/1"
      },
      {
        "rel": "canonical",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/siteInterfaces/1"
      },
      {
        "rel": "describedby",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/siteInterfaces",
        "mediaType": "application/schema+json"
      }
    ]
  },
  "isDefault": true,
  "name": "General Service",
  "outgoingEmailSettings": {
    "displayName": "Global Wireless Customer Support",
    "friendlyFromAddress": null,
    "fromAddress": "generalservice@mail.example.com",
    "isEnabled": false,
    "replyToAddress": "generalservice@mail.example.com"
  },
  "type": {
    "id": 1,
    "lookupName": "Service"
  },
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/mailboxes/1"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/mailboxes/1"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/mailboxes",
      "mediaType": "application/schema+json"
    }
  ]
}