Get a mailbox
get
/services/rest/connect/v1.4/mailboxes/{id}
Request
Path Parameters
-
id(required): integer
The unique identifier of the mailbox.
Response
Default Response
Root Schema : mailboxes
Type:
object
The mailbox used for collecting email inquiries sent by customers, responses to mailings, and bounced messages.
Show Source
-
createdTime:
string
The date and time when the mailbox was created. This attribute is read-only.
-
id:
integer
Minimum Value:
1
Maximum Value:9223372036854776000
The unique identifier of the mailbox. -
incomingEmailSettings:
object mailboxes-incomingEmailSettings
The settings for incoming emails for a mailbox.
-
interface:
[
"object",
"null"
]
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. It is the reference to a resource in 'siteInterfaces' collection. Only ID or lookupName can be provided to specify the resource.
-
isDefault:
[
"boolean",
"null"
]
Indicates whether the mailbox is the default mailbox for the interface. This attribute does not have a default value.
-
lookupName:
string
Maximum Length:
255
The name used to look up the mailbox. -
name:
string
Maximum Length:
40
Pattern:^[^ ]*$
The name of the mailbox. -
outgoingEmailSettings:
object mailboxes-outgoingEmailSettings
The settings for outgoing emails for a mailbox.
-
type:
object namedIDs-mailboxes-type
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.
-
updatedTime:
string
The date and time when the mailbox was last updated. This attribute is read-only.
Nested Schema : mailboxes-incomingEmailSettings
Type:
object
The settings for incoming emails for a mailbox.
Show Source
-
forceReplyBetweenLines:
[
"boolean",
"null"
]
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.
-
forwardRejectMessageAddress:
[
"string",
"null"
]
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. -
isEnabled:
[
"boolean",
"null"
]
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
-
displayName:
[
"string",
"null"
]
Maximum Length:
80
Pattern:^[^ ]*$
The display name used in the outgoing emails from the mailbox. -
friendlyFromAddress:
[
"string",
"null"
]
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. -
fromAddress:
[
"string",
"null"
]
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. -
isEnabled:
[
"boolean",
"null"
]
Indicates whether outgoing email is enabled. This attribute does not have a default value.
-
replyToAddress:
[
"string",
"null"
]
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
-
id:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
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"
}
]
}