Mailbox

Get

Retrieves Parallels RAS mailbox settings.

GET/api/MailboxSettings

Response

200401404

Success

Body

application/json; api-version=1.0

useTLSMailboxTLS (enum)

Use TLS / SSL (for Mailbox)

0 = No,1 = Yes,2 = YesIfAvailable,3 = YesTLS12IfAvailable

requireAuthboolean

smtpServernullable string

senderAddressnullable string

usernamenullable string

Request

JavaScriptCurlPython

const response = await fetch('/api/MailboxSettings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "useTLS": [
    "0 = No",
    "1 = Yes",
    "2 = YesIfAvailable",
    "3 = YesTLS12IfAvailable"
  ],
  "requireAuth": false,
  "smtpServer": "text",
  "senderAddress": "text",
  "username": "text"
}

Update

Modifies Parallels RAS mailbox settings.

PUT/api/MailboxSettings

Body

application/json; api-version=1.0

Modifies the Parallels RAS mailbox configuration settings.

smtpServernullable string

SMTP server name. Example: "mail.yourcompany.com:500"

senderAddressnullable string

Sender email address.

usernamenullable string

SMTP server user name.

passwordnullable string

SMTP server password.

requireAuthnullable boolean

Set whether SMTP server requires authentication.

useTLSMailboxTLS (enum)

Use TLS / SSL (for Mailbox)

0 = No,1 = Yes,2 = YesIfAvailable,3 = YesTLS12IfAvailable

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/MailboxSettings', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}