Docs / SDK / Python / Mail
Python — módulo Mail
🚧 En proceso de liberación Todavía no implementado en el SDK de Python. El contrato completo (entry points, tipos de datos, ejemplos que sí compilan) ya está fijado en el módulo equivalente de Go — úsalo como referencia mientras se completa este port.
Contrato ya fijado (stub)
El módulo mail.py ya existe en el repositorio con los mismos dataclasses que el SDK de Go — send() y status() lanzan NotImplementedError todavía; la capa de transporte HTTP (WaApi en __init__.py) ya está implementada (la usa el módulo DNS, que sí es real), solo falta conectar Mail a ella.
from webability_api.mail import Mail, SendRequest, Address, Recipient, QueueStatus
mail = Mail(api)
result = mail.send(SendRequest(
from_=Address("no-reply@tuempresa.com"),
to=Recipient("cliente@ejemplo.com", vars={"nombre": "Ana"}),
subject="Confirma tu compra",
html="Hola {{nombre}}",
wait_send=True,
))
# result.queue_status: QueueStatus.PENDING | .PROCESSING | .SENT | .ERROR
status = mail.status(result.queue_key)
# O con una plantilla ya registrada, en vez de subject/html/text:
result = mail.send(SendRequest(
from_=Address("no-reply@tuempresa.com"),
to=Recipient("cliente@ejemplo.com", vars={"nombre": "Ana", "codigo": "482913"}),
template="recuperacion",
))
# Con idioma: busca "recuperacion_fr" ya traducida, o auto-traduce/usa el base
result = mail.send(SendRequest(
from_=Address("no-reply@tuempresa.com"),
to=Recipient("cliente@ejemplo.com", vars={"nombre": "Ana", "codigo": "482913"}),
template="recuperacion",
lang="fr",
))
El campo template (str, vacío si no aplica) es el id de una plantilla ya registrada, activa y de tipo email (no un "layout" — se rechaza con ApiError si lo intentas) — el servidor valida esto antes de encolar el correo y responde con error (no un envío fallido en segundo plano) si no. lang (str, vacío si no aplica) es un código BCP-47 ("fr", "en", "de"…): nunca hace fallar el envío, en el peor caso degrada al idioma base. Ver Con plantilla registrada y Plantillas en varios idiomas para el detalle completo.
¿Dónde se crean las plantillas?
Las plantillas no se crean por API en ningún SDK — se agregan y editan desde Consola → Correos → Plantillas. El SDK solo referencia el id que le pongas ahí.
Mientras tanto
- • Módulo Mail en Go — mismos entry points, mismo contrato de datos.
- • /documentacion/mail — referencia completa de la API HTTP.
- • SDK general de Python — instalación y autenticación.