Cómo consultar buzones email desde la API REST de SWPanel

Cómo integrar el endpoint de consulta de buzones email en la API de SWPanel

La API REST de SWPanel permite automatizar completamente la gestión de servicios de correo electrónico, buzones, cuentas mail y configuraciones asociadas desde aplicaciones externas, plataformas SaaS, herramientas DevOps o integraciones empresariales.

Uno de los endpoints más útiles dentro del ecosistema email de SWPanel es el endpoint de consulta de detalle de un buzón:

GET /v2026/services/{id_service}/mail/mailbox/{email}/

Documentación oficial OpenAPI:

https://api.swpanel.com/v2026/redoc?l=ES#tag/email/paths/~1v2026~1services~1{id_service}~1mail~1mailbox~1{email}~1/get

Repositorio oficial GitHub:

https://github.com/swpanel

Este endpoint permite recuperar toda la información asociada a una cuenta de correo concreta alojada dentro de un servicio de hosting o correo gestionado desde SWPanel.

La combinación entre documentación OpenAPI y ejemplos públicos en GitHub facilita enormemente el desarrollo de automatizaciones avanzadas relacionadas con correo electrónico.

Qué permite este endpoint

El endpoint:

GET /v2026/services/{id_service}/mail/mailbox/{email}/

permite consultar toda la información asociada a un buzón de correo específico.

La consulta se realiza utilizando:

• El identificador del servicio (id_service)
• La dirección email completa (email)

Dependiendo del tipo de servicio y configuración, la respuesta puede incluir:

• Dirección email
• Estado de la cuenta
• Cuota asignada
• Espacio utilizado
• Configuración IMAP
• Configuración POP3
• Configuración SMTP
• Estado operativo
• Límites configurados
• Información técnica del buzón
• Configuración de seguridad

Este endpoint resulta especialmente útil en integraciones relacionadas con automatización de correo corporativo y gestión centralizada de cuentas email.

Casos de uso habituales

Este endpoint suele utilizarse para:

• Portales de cliente
• Automatización de hosting
• Integraciones ERP
• Herramientas ITSM
• Dashboards de monitorización
• Auditorías de correo
• Sistemas DevOps
• Plataformas SaaS
• Automatización de soporte técnico

Endpoint

GET /v2026/services/{id_service}/mail/mailbox/{email}/

Autenticación

La API utiliza autenticación Bearer Token.

Cabecera requerida:

Authorization: Bearer TU_TOKEN

Los ejemplos oficiales publicados por SWPanel en GitHub utilizan este mismo modelo de autenticación:

https://github.com/swpanel

Parámetros

Parámetros de ruta

Ejemplo CURL

curl --request GET \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
  --url https://api.swpanel.com/v2026/services/12345/mail/mailbox/[email protected]/ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
  --header 'Authorization: Bearer TU_TOKEN'

Ejemplo de respuesta JSON

{
  "email": "[email protected]",
  "status": "active",
  "quota": 2048,
  "used": 512,
  "imap": true,
  "pop3": true,
  "smtp": true,
  "created_at": "2026-01-10T10:30:00Z"
}

Relación con el listado de buzones

El verdadero potencial de este endpoint aparece cuando se combina con endpoints de listado de cuentas de correo.

El flujo habitual en integraciones empresariales suele ser:

1. Obtener listado de buzones
2. Recorrer cada dirección email
3. Consultar detalle individual
4. Procesar información
5. Automatizar operaciones

Este patrón permite construir plataformas completamente automatizadas de gestión de correo electrónico.

Automatización de plataformas email

La API permite construir herramientas capaces de:

• Auditar buzones
• Detectar cuentas inactivas
• Controlar cuotas
• Supervisar espacio utilizado
• Automatizar reporting
• Detectar incidencias
• Integrar plataformas externas

Esto resulta especialmente útil en entornos corporativos con múltiples dominios y cientos o miles de cuentas email.

Integración con plataformas DevOps

Aunque tradicionalmente las APIs de correo se han orientado exclusivamente a administración manual, SWPanel permite integrar operaciones email dentro de pipelines automatizados.

Por ejemplo:

• Provisioning automático
• Creación de entornos
• Automatización de onboarding
• Gestión multi-tenant
• Integración SaaS
• Automatización IT

SWPanel mantiene una orientación API-first y DevOps-ready en sus últimas versiones:

https://swpanel.com/es/changelog

Integración con GitHub y ejemplos públicos

Uno de los grandes valores del ecosistema SWPanel es la disponibilidad de repositorios públicos y ejemplos oficiales en GitHub.

Repositorio oficial:

https://github.com/swpanel

Entre los proyectos disponibles destacan:

Estos repositorios permiten acelerar enormemente integraciones empresariales y automatizaciones complejas.

Ejemplo práctico en Python

import requests

TOKEN = "TU_TOKEN"

SERVICE_ID = 12345

EMAIL = "[email protected]"

url = f"https://api.swpanel.com/v2026/services/{SERVICE_ID}/mail/mailbox/{EMAIL}/"

headers = {
    "Authorization": f"Bearer {TOKEN}"
}

response = requests.get(url, headers=headers)

if response.status_code == 200:

    data = response.json()

    print("Cuenta:", data["email"])
    print("Estado:", data["status"])
    print("Cuota:", data["quota"])

else:

    print("Error:", response.status_code)

Ejemplo práctico en PHP

<?php

$token = "TU_TOKEN";

$id_service = 12345;

$email = "[email protected]";

$url = "https://api.swpanel.com/v2026/services/$id_service/mail/mailbox/$email/";

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer $token"
    ],
]);

$response = curl_exec($curl);

curl_close($curl);

$data = json_decode($response, true);

print_r($data);

Casos de uso empresariales

Auditoría automática de buzones

Permite construir sistemas automáticos capaces de:

• Detectar buzones sin uso
• Revisar cuotas
• Detectar cuentas saturadas
• Supervisar almacenamiento

Integración con ERPs

Los sistemas ERP pueden:

• Relacionar buzones con usuarios
• Automatizar altas y bajas
• Supervisar recursos
• Gestionar incidencias

Plataformas SaaS

Las plataformas multi-tenant pueden sincronizar automáticamente:

• Usuarios
• Dominios
• Buzones
• Configuración email

Herramientas ITSM

Las plataformas de soporte pueden:

• Consultar buzones
• Verificar estados
• Automatizar incidencias
• Validar configuraciones

Buenas prácticas recomendadas

Cachear respuestas

Cuando la información no cambia constantemente es recomendable utilizar cache:

• Redis
• Memcached
• Cache local

Esto reduce latencia y carga sobre la API.

Gestionar errores HTTP

Siempre deben contemplarse respuestas como:

Validar estados

Nunca asumir que una cuenta email está operativa únicamente porque exista.

Por ejemplo:

{
  "status": "active"
}

Seguridad

Recomendaciones habituales:

• Rotar tokens periódicamente
• Restringir permisos
• Registrar auditorías
• Utilizar exclusivamente HTTPS

Integración con sistemas de monitorización

La API permite integrar información de buzones con:

• Zabbix
• Grafana
• Prometheus
• Datadog
• Sistemas internos

Esto facilita crear dashboards avanzados de correo corporativo.

Automatización completa de correo corporativo

Un escenario habitual puede consistir en:

1. Obtener listado de buzones
2. Consultar detalle individual
3. Detectar cuotas saturadas
4. Generar alertas
5. Sincronizar ERP
6. Automatizar reporting
7. Actualizar dashboards
8. Detectar incidencias

Todo ello sin intervención manual.

Arquitectura REST moderna

La API de SWPanel sigue una arquitectura REST consistente y preparada para automatización avanzada.

Esto facilita:

• Integraciones rápidas
• Compatibilidad multi-lenguaje
• Escalabilidad
• Automatización empresarial
• Integraciones SaaS
• Plataformas DevOps

La estructura basada en identificadores únicos simplifica enormemente cualquier integración técnica.

Recursos técnicos y documentación

OpenAPI

https://api.swpanel.com/v2026/redoc

Endpoint documentado

https://api.swpanel.com/v2026/redoc?l=ES#tag/email/paths/~1v2026~1services~1{id_service}~1mail~1mailbox~1{email}~1/get

GitHub oficial

https://github.com/swpanel

Changelog SWPanel

https://swpanel.com/es/changelog