Documentación Referencia
Ajustes del editor
Configura la creación de emails y conecta el guardado, la personalización y el envío con tu aplicación.
En esta página
Documentación
En el panel, abre los ajustes de un editor. El botón de información de cada ajuste muestra su ayuda. Guarda el editor para aplicar los cambios.
Condiciones de visualización
Ofrece reglas con nombre para mostrar una sección o un diseño completo de columnas a determinados destinatarios. Define las reglas aquí, selecciona un diseño en el editor y elige Mostrar si en sus opciones.
Introduce la sintaxis de apertura y cierre que entiende tu plataforma de envío. El ejemplo usa Liquid; adáptalo a tu plataforma. Weavour conserva esas cadenas sin evaluarlas.
- El ID es un identificador estable, como free_account. El nombre aparece en el selector; la categoría y la descripción son opcionales.
- Añade hasta 100 definiciones. Ambos campos de sintaxis son obligatorios. Usa directivas de plantilla en lugar de etiquetas HTML.
- Los diseños anidados requieren que se cumplan todas las reglas superiores. Los escenarios de vista previa usan resultados de ejemplo y no cambian las exportaciones habituales.
- Antes del envío, evalúa la sintaxis exportada en tu plataforma o llama al renderizado del documento guardado con conditionValues booleanos por ID. Proporciona un resultado para cada regla alcanzable.
- Conserva el objeto completo de onDocumentChange y ábrelo con emailDocument. Los documentos condicionales requieren schemaVersion: 2, el SDK 0.1.6 y un editor alojado compatible.
editor.updateConfig({
displayConditions: [{
id: 'free_account', label: 'Free accounts', category: 'Account',
before: "{% if account.plan == 'free' %}", after: '{% endif %}',
}],
});
const output = await editor.exportHTML();
// Evaluate the host syntax before delivering HTML and plain text.
console.log(output.displayConditions, output.displayConditionIssues);
// Persist onDocumentChange envelopes; reopen with emailDocument.Etiquetas de personalización
Define marcadores de texto y enlaces para cada destinatario, como su nombre o la URL de su cuenta. Los autores los insertan por nombre sin escribir la sintaxis de tu plataforma.
- Asigna un ID estable, un nombre claro y el token exacto que espera tu sistema de envío.
- Elige Texto para contenido o URL para un destino. La descripción y el valor de ejemplo ayudan a elegir y comprobar la vista previa.
- Las definiciones guardadas y las del SDK se combinan por ID. Las etiquetas insertadas conservan su sintaxis al guardar y exportar.
- Resuelve los tokens en tu flujo de envío o proporciona mergeValues al renderizado del documento guardado.
// Run on your mounted editor instance.
editor.updateConfig({
mergeTags: [
{ id: 'first_name', label: 'First name', token: '{{first_name}}', kind: 'text', sampleValue: 'Alex' },
{ id: 'account_url', label: 'Account URL', token: '{{account_url}}', kind: 'url', sampleValue: 'https://example.com/account' },
],
});
const output = await editor.exportHTML();
console.log(output.mergeTags, output.mergeTagIssues);
// Exports retain literal tokens. Resolve recipient values before delivery.Guardado automático y borradores
Activa el guardado alojado para conservar borradores e historial en Weavour. Si lo desactivas, tu aplicación debe guardar el documento completo con su versión.
- Guarda el draftId en el registro de tu aplicación. Ábrelo con la misma clave de editor y el mismo ámbito de userId y organizationId.
- Para reanudar, pasa draftId sin contenido inicial ni emailDocument.
- Espera a flushAutosave() y gestiona los errores antes de salir; después llama a destroy(). Un evento de cambio o una exportación HTML no confirma el guardado.
- El historial conserva 30 días de versiones. Restaurar crea una versión nueva.
Bloques de organización
Permite guardar un diseño completo como bloque reutilizable para la organización, con diseños anidados, imágenes y condiciones.
- Proporciona userId y organizationId al montar para usar la biblioteca de bloques.
- Los ID de organización pertenecen a tu espacio de cliente. Reutiliza el mismo ID en los editores de una misma organización.
- Los bloques insertados son copias independientes. Cambiar la biblioteca no modifica los emails existentes.
- Los administradores gestionan los bloques desde Bloques de organización en el panel.
Plantillas
Activa el selector para empezar con las plantillas incluidas, del espacio de cliente o de usuarios disponibles en el ámbito actual.
- Los administradores gestionan las plantillas y las publican para todas las organizaciones o para una selección.
- Las plantillas de usuario son privadas para la pareja organización/usuario, o para el usuario en un contexto personal. Compartir es una decisión explícita.
- Crear un email desde una plantilla genera una copia independiente. Editar el original requiere permiso y la acción Guardar plantilla.
- Ocultar el selector conserva el email actual y las plantillas guardadas.
Auditoría de emails
Muestra una valoración del contenido y problemas concretos debajo del lienzo. Los autores pueden abrir el informe y navegar hasta lo que deben corregir.
- Las comprobaciones cubren contenido, accesibilidad, imágenes, enlaces y riesgos habituales de visualización.
- La auditoría funciona sin IA. Sus controles y su valoración no aparecen en el email exportado.
- Desactivarla detiene las comprobaciones y oculta los controles sin cambiar el email.
- Prueba el email final personalizado en los clientes de correo de destino antes de enviarlo.
Bloques disponibles
Elige los contenidos y diseños que pueden insertar los autores. Adapta la paleta al flujo de tu aplicación.
- La selección filtra la paleta de inserción. Desmarcar todo oculta todas sus entradas.
- Cambiar la lista no elimina bloques de los emails guardados.
- Una preferencia SDK allowedBlocks explícita sustituye la selección guardada. Omítela para usar los ajustes del panel.
Apariencia e idioma
Adapta los controles del editor a tu aplicación con el tema, los colores, la fuente, la densidad y el radio de las esquinas. Comprueba el resultado en la vista previa.
- Empieza con modo claro u oscuro y ajusta los colores. Mantén legibles los textos, controles e indicadores de foco.
- El idioma se aplica a la interfaz. Los autores pueden escribir el email en otro idioma.
- Los cambios conservan el borrador y su diseño. Los valores del tema del SDK tienen prioridad y se pueden actualizar en vivo.