GET v1/EmailSettings

User roles allowed to make this request: DomainAdministrator PowerUser RegularUser LimitedUser SampleManager DemoUser

Permissions required to make this request: DomainEmailSetting.Read

Gets the domain's email settings.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Response Message

DomainEmailSettingsModel
NameDescriptionTypeAdditional information
DefaultFromAddress

The default 'from' email address

 string

None.
DefaultReplyToAddress

The default 'reply to' address

 string

None.
FromAddress

The 'from' email address

 string

Max length: 512
FromName

Name of the sender

 string

Max length: 512
ReplyToAddress

The 'reply to' address

 string

Max length: 512
PostalAddress

The physical address

 string

Max length: 512

Response Formats

application/json, text/json

Sample: 
{
  "DefaultFromAddress": "sample string 1",
  "DefaultReplyToAddress": "sample string 2",
  "FromAddress": "sample string 3",
  "FromName": "sample string 4",
  "ReplyToAddress": "sample string 5",
  "PostalAddress": "sample string 6"
}

application/xml, text/xml

Sample: 
<DomainEmailSettingsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <FromAddress>sample string 3</FromAddress>
  <FromName>sample string 4</FromName>
  <PostalAddress>sample string 6</PostalAddress>
  <ReplyToAddress>sample string 5</ReplyToAddress>
  <DefaultFromAddress i:nil="true" />
  <DefaultReplyToAddress i:nil="true" />
  <DefaultFromAddress>sample string 1</DefaultFromAddress>
  <DefaultReplyToAddress>sample string 2</DefaultReplyToAddress>
</DomainEmailSettingsModel>