1. REST API for Oracle B2C Service
  2. Tasks
  3. Mailboxes

Get a mailbox

get

/services/rest/connect/v1.4/mailboxes/{id}

Request

Path Parameters
Back to Top

Response

Default Response

Body ()
Root Schema : mailboxes
Type: object
The mailbox used for collecting email inquiries sent by customers, responses to mailings, and bounced messages.
Show Source
Nested Schema : mailboxes-incomingEmailSettings
Type: object
The settings for incoming emails for a mailbox.
Show Source
  • Indicates whether the Force Reply Between the Lines feature is enabled for outgoing emails from the mailbox. This attribute does not have a default value.
  • 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 to which rejected messages are sent.
  • Indicates whether incoming email option is enabled. This attribute does not have a default value.
Nested Schema : mailboxes-outgoingEmailSettings
Type: object
The settings for outgoing emails for a mailbox.
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 from address used to brand outgoing emails as friendly.
  • 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 from address on the outgoing email.
  • Indicates whether outgoing email is enabled. This attribute does not have a default value.
  • 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 on the outgoing email.
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
Back to Top

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"
    }
  ]
}
Back to Top