Skip to content
Docs
Select language:English

/api/v1/locations/{id}/mailbox (PUT)

PUT
/api/v1/locations/{id}/mailbox
curl --request PUT \
  --url https://example.com/api/v1/locations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/mailbox \
  --header 'Content-Type: application/json' \
  --data '{ "host": "example", "port": 1, "security": "tls", "username": "example", "password": "example", "folder": "example", "allowedSenders": [] }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
host
required
string
port
integer
>= 1 <= 65535
security
required
string
Allowed values: tls starttls
username
required
string
>= 1 characters <= 254 characters
password
string
>= 1 characters <= 500 characters
folder
required
string
>= 1 characters <= 200 characters
allowedSenders
Array<string>
default: <= 20 items

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
host
required
string
port
required
integer
>= -9007199254740991 <= 9007199254740991
security
required
string
Allowed values: tls starttls
username
required
string
folder
required
string
allowedSenders
required
Array<string>
active
required
boolean
disabledReason
required
Any of:
string
Allowed values: creator_left auth_failed
lastPolledAt
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
lastError
required
string | null
createdBy
required
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
displayName
required
string
Example
{
  "security": "tls",
  "disabledReason": "creator_left"
}