Type at least two characters.

↑ ↓ moveEnter openEsc close
View .md

Mailboxes endpoints (Client API: web hosting)

23 FeatherPanel Client API: web hosting endpoints from user/webspaces/mailboxes.php: methods, paths, auth, permissions, rate limits, parameters and responses.

Last synced from FeatherPanel 15b94e9 on .

On this page

Defined in backend/app/routes/user/webspaces/mailboxes.php. Authentication used here: Signed-in user. Read Authentication for how to send credentials and Rate limits and errors for the response envelope.

Paths, methods, permissions and rate limits come from the route file. Summaries, parameters and response codes come from the OpenAPI annotations on the controllers; endpoints without annotations show only what the route file declares.

Endpoints

GET/api/user/webspaces/{uuidShort}/mailboxes

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-mailboxesController: WebSpaceMailboxController::indexroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/mailboxes" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/mailboxes/hosts

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-mailboxes-hostsController: WebSpaceMailboxController::hostsroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/mailboxes/hosts" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/mailboxes/dns

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-mailboxes-dnsController: WebSpaceMailboxController::dnsroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/mailboxes/dns" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/mailboxes/deliverability

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-mailboxes-deliverabilityController: WebSpaceMailboxController::deliverabilityroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/mailboxes/deliverability" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/mailboxes/dns/provision

Auth: Signed-in userDefault rate limit: 20 / minute (user-webspaces)Route name: user-webspaces-mailboxes-dns-provisionController: WebSpaceMailboxController::provisionDnsroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/mailboxes/dns/provision" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/mailboxes

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-mailboxes-createController: WebSpaceMailboxController::createroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/mailboxes" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:mailbox:create

DELETE/api/user/webspaces/{uuidShort}/mailboxes/{mailboxId}

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-mailboxes-deleteController: WebSpaceMailboxController::deleteroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
mailboxIdpath-yes
curl -X DELETE "$PANEL_URL/api/user/webspaces/$UUID_SHORT/mailboxes/$MAILBOX_ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:mailbox:delete

POST/api/user/webspaces/{uuidShort}/mailboxes/{mailboxId}/reset-password

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-mailboxes-reset-passwordController: WebSpaceMailboxController::resetPasswordroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
mailboxIdpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/mailboxes/$MAILBOX_ID/reset-password" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PATCH/api/user/webspaces/{uuidShort}/mailboxes/{mailboxId}/enabled

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-mailboxes-enabledController: WebSpaceMailboxController::setEnabledroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
mailboxIdpath-yes
curl -X PATCH "$PANEL_URL/api/user/webspaces/$UUID_SHORT/mailboxes/$MAILBOX_ID/enabled" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/mailboxes/webmail/check

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-mailboxes-webmail-checkController: WebSpaceMailboxController::checkWebmailInstalledroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/mailboxes/webmail/check" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/mailboxes/{mailboxId}/webmail/token

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-mailboxes-webmail-tokenController: WebSpaceMailboxController::generateWebmailTokenroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
mailboxIdpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/mailboxes/$MAILBOX_ID/webmail/token" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/mailboxes/forwarders

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-mailboxes-forwardersController: WebSpaceMailboxController::listForwardersroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/mailboxes/forwarders" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/mailboxes/forwarders

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-mailboxes-forwarders-createController: WebSpaceMailboxController::createForwarderroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/mailboxes/forwarders" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

DELETE/api/user/webspaces/{uuidShort}/mailboxes/forwarders/{forwarderId}

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-mailboxes-forwarders-deleteController: WebSpaceMailboxController::deleteForwarderroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
forwarderIdpath-yes
curl -X DELETE "$PANEL_URL/api/user/webspaces/$UUID_SHORT/mailboxes/forwarders/$FORWARDER_ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PUT/api/user/webspaces/{uuidShort}/mailboxes/{mailboxId}/autorespond

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-mailboxes-autorespondController: WebSpaceMailboxController::setAutorespondroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
mailboxIdpath-yes
curl -X PUT "$PANEL_URL/api/user/webspaces/$UUID_SHORT/mailboxes/$MAILBOX_ID/autorespond" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PATCH/api/user/webspaces/{uuidShort}/mailboxes/{mailboxId}/autorespond

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-mailboxes-autorespondController: WebSpaceMailboxController::setAutorespondroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
mailboxIdpath-yes
curl -X PATCH "$PANEL_URL/api/user/webspaces/$UUID_SHORT/mailboxes/$MAILBOX_ID/autorespond" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/mailboxes/{mailboxId}/spam-filter

Auth: Signed-in userDefault rate limit: 60 / minute (user-webspaces)Route name: user-webspaces-mailboxes-spam-filter-getController: WebSpaceMailboxController::getSpamFilterroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
mailboxIdpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/mailboxes/$MAILBOX_ID/spam-filter" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PUT/api/user/webspaces/{uuidShort}/mailboxes/{mailboxId}/spam-filter

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-mailboxes-spam-filter-setController: WebSpaceMailboxController::setSpamFilterroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
mailboxIdpath-yes
curl -X PUT "$PANEL_URL/api/user/webspaces/$UUID_SHORT/mailboxes/$MAILBOX_ID/spam-filter" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PATCH/api/user/webspaces/{uuidShort}/mailboxes/{mailboxId}/spam-filter

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-mailboxes-spam-filter-setController: WebSpaceMailboxController::setSpamFilterroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
mailboxIdpath-yes
curl -X PATCH "$PANEL_URL/api/user/webspaces/$UUID_SHORT/mailboxes/$MAILBOX_ID/spam-filter" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/mailboxes/mailing-lists

Auth: Signed-in userDefault rate limit: 60 / minute (user-webspaces)Route name: user-webspaces-mailboxes-mailing-listsController: WebSpaceMailboxController::listMailingListsroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/mailboxes/mailing-lists" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/mailboxes/mailing-lists

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-mailboxes-mailing-lists-createController: WebSpaceMailboxController::createMailingListroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/mailboxes/mailing-lists" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/mailboxes/mailing-lists/delete

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-mailboxes-mailing-lists-deleteController: WebSpaceMailboxController::deleteMailingListroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/mailboxes/mailing-lists/delete" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

DELETE/api/user/webspaces/{uuidShort}/mailboxes/mailing-lists/delete

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-mailboxes-mailing-lists-deleteController: WebSpaceMailboxController::deleteMailingListroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X DELETE "$PANEL_URL/api/user/webspaces/$UUID_SHORT/mailboxes/mailing-lists/delete" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
Written from the source:FeatherPanel/backend/app/routes/user/webspaces/mailboxes.php
View source on GitHubReport a problemLast updated