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

Get a marketing mailbox

get

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

Request

Path Parameters
Back to Top

Response

Default Response

Body ()
Root Schema : marketingMailboxes
Type: object
The mailbox used to send and receive emails and process bounced messages.
Show Source
Nested Schema : marketingMailboxes-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: 255
    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 : marketingMailboxes-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: 255
    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: 255
    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: 255
    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-marketingMailboxes-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 an Outreach mailbox:

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

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/marketingMailboxes/3

Response body example

{
  "id": 3,
  "lookupName": "Offers",
  "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": false,
  "name": "Offers",
  "outgoingEmailSettings": {
    "displayName": "Global Wireless Offers",
    "friendlyFromAddress": null,
    "fromAddress": "offers@mail.example.com",
    "isEnabled": false,
    "replyToAddress": "offers@mail.example.com"
  },
  "type": {
    "id": 2,
    "lookupName": "Marketing"
  },
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/marketingMailboxes/3"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/marketingMailboxes/3"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/marketingMailboxes",
      "mediaType": "application/schema+json"
    }
  ]
}
Back to Top