• Document Up to Date
  • Updated On 4.0.0

Get Email Configuration

Returns an email configuration for a given Social Context.

Resource Information

This service uses the tomcat application on port 8080 by default.

The context for this API is /crafter-social, please prefix the API URLs with this context.

HTTP Verb
GET
URL
/api/3/system/context/preferences/email/config
Response Formats
JSON

Parameters

Name
Type
Required
Description
context
String
The ID of the Social Context

Example

Request

GET .../api/3/system/context/preferences/email/config?context=f5b143c2-f1c0-4a10-b56e-f485f00d3fe9

Response

Status 200 OK

 1{
 2  "host": "localhost",
 3  "encoding": "UTF-8",
 4  "port": 25.0,
 5  "auth": false,
 6  "username": "",
 7  "password": "",
 8  "tls": false,
 9  "replyTo": "social@example.com",
10  "from": "social@example.com",
11  "priority": 5.0,
12  "subject": "Latest change on your subscribed threads for Social"
13}

Responses

Status
Location
Response Body
200

See example above.
401

{ "message" : "User must be logged in" }
403







{ "message" : "Current subject does not have
permission to execute global action ..." }
500

{ "message" : "Internal server error" }