Mailbox | Parallels REST API

Parallels REST API

Products Support Partners Documentation

Get

get

Retrieves Parallels RAS mailbox settings.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/MailboxSettings'

200

401

404

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

Success

Update

put

Modifies Parallels RAS mailbox settings.

Body

smtpServerstring | nullableoptional

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

senderAddressstring | nullableoptional

Sender email address.

usernamestring | nullableoptional

SMTP server user name.

passwordstring | nullableoptional

SMTP server password.

requireAuthboolean | nullableoptional

Set whether SMTP server requires authentication.

useTLSstring · enumoptional

Use TLS / SSL (for Mailbox)

Available options: