KyPanelDocs
/

API reference

Mailbox (Mail tools)

Tools a mailbox owner uses from the webmail: password, filters, autoresponder, client settings.

Sign out of the mail tools

POST/api/v1/mailbox/auth/logout

Who
public
API tokens
not needed
Operation
mailboxLogout · ky call mailboxLogout

Responses

  • 204 Done, no content
  • 403 Forbidden: csrf

Mail tools session

GET/api/v1/mailbox/auth/session

Who
public
API tokens
not needed
Operation
mailboxSession · ky call mailboxSession

Responses

  • 200 OK
    Body
    FieldType
    authenticatedboolean
    csrf_tokenstring
    expires_atinteger
    mailboxobject
    FieldType
    addressstring
    domainstring
    idstring
    is_systemboolean
    read_onlyboolean

Redeem a mail tools sign-in link

GET/api/v1/mailbox/auth/sso

Who
public
API tokens
not needed
Operation
mailboxSSO · ky call mailboxSSO

Parameters

NameIn
pagequery
tokenquery

Responses

  • 302 Redirect
  • 500 Internal Server Error: internal

Get your autoresponder

GET/api/v1/mailbox/autoresponders

Who
public; customer
API tokens
account token area: account
Feature
autoresponders
Operation
getMailboxAutoresponders · ky call getMailboxAutoresponders

Responses

  • 200 OK
  • 401 Unauthorized: no session, or an invalid or expired token
  • 403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)

Create your autoresponder

POST/api/v1/mailbox/autoresponders

Who
public; customer
API tokens
account token area: account
Feature
autoresponders
Operation
postMailboxAutoresponders · ky call postMailboxAutoresponders

Responses

  • 200 OK
  • 401 Unauthorized: no session, or an invalid or expired token
  • 403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)

Delete your autoresponder

DELETE/api/v1/mailbox/autoresponders/{aid}

Who
public; customer
API tokens
account token area: account
Feature
autoresponders
Operation
deleteMailboxAutorespondersAid · ky call deleteMailboxAutorespondersAid

Parameters

NameIn
aidpath

Responses

  • 200 OK
  • 401 Unauthorized: no session, or an invalid or expired token
  • 403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)

Update your autoresponder

PUT/api/v1/mailbox/autoresponders/{aid}

Who
public; customer
API tokens
account token area: account
Feature
autoresponders
Operation
putMailboxAutorespondersAid · ky call putMailboxAutorespondersAid

Parameters

NameIn
aidpath

Responses

  • 200 OK
  • 401 Unauthorized: no session, or an invalid or expired token
  • 403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)

Your mail client settings

GET/api/v1/mailbox/client-settings

Who
public; customer
API tokens
account token area: account
Feature
mail_client_config
Operation
getMailboxClientSettings · ky call getMailboxClientSettings

Responses

  • 200 OK
  • 401 Unauthorized: no session, or an invalid or expired token
  • 403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)

List your email filters

GET/api/v1/mailbox/filters

Who
public; customer
API tokens
account token area: account
Feature
email_filters
Operation
getMailboxFilters · ky call getMailboxFilters

Responses

  • 200 OK
  • 401 Unauthorized: no session, or an invalid or expired token
  • 403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)

Create an email filter

POST/api/v1/mailbox/filters

Who
public; customer
API tokens
account token area: account
Feature
email_filters
Operation
postMailboxFilters · ky call postMailboxFilters

Responses

  • 200 OK
  • 401 Unauthorized: no session, or an invalid or expired token
  • 403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)

Reorder your email filters

PUT/api/v1/mailbox/filters-order

Who
public; customer
API tokens
account token area: account
Feature
email_filters
Operation
putMailboxFiltersOrder · ky call putMailboxFiltersOrder

Responses

  • 200 OK
  • 401 Unauthorized: no session, or an invalid or expired token
  • 403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)

Delete an email filter

DELETE/api/v1/mailbox/filters/{fid}

Who
public; customer
API tokens
account token area: account
Feature
email_filters
Operation
deleteMailboxFiltersFid · ky call deleteMailboxFiltersFid

Parameters

NameIn
fidpath

Responses

  • 200 OK
  • 401 Unauthorized: no session, or an invalid or expired token
  • 403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)

Update an email filter

PUT/api/v1/mailbox/filters/{fid}

Who
public; customer
API tokens
account token area: account
Feature
email_filters
Operation
putMailboxFiltersFid · ky call putMailboxFiltersFid

Parameters

NameIn
fidpath

Responses

  • 200 OK
  • 401 Unauthorized: no session, or an invalid or expired token
  • 403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)

Change your mailbox password

PUT/api/v1/mailbox/password

Who
public; customer
API tokens
account token area: account
Operation
putMailboxPassword · ky call putMailboxPassword

Responses

  • 200 OK
  • 401 Unauthorized: no session, or an invalid or expired token
  • 403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)