Configurações do editor — Documentação

Documentação

No painel, abra as configurações de um editor. Use o botão de informações ao lado de uma configuração para obter ajuda. Salve o editor para aplicar as alterações.

Ofereça regras nomeadas para exibir uma seção ou um layout completo de colunas apenas para determinados destinatários. Defina as regras aqui, selecione um layout no editor e escolha Exibir quando nas opções.

Informe a sintaxe de abertura e fechamento que seu sistema de envio entende. O exemplo usa Liquid: adapte à sua plataforma. A Weavour preserva essas strings sem interpretá-las.

O ID é estável, por exemplo free_account. O nome aparece no seletor; categoria e descrição são opcionais.
Adicione até 100 definições. Os dois campos de sintaxe são obrigatórios. Use diretivas de modelo, não tags HTML.
Layouts aninhados exigem que todas as regras superiores sejam verdadeiras. Prévias de cenários são exemplos e não alteram exportações normais.
Antes de enviar, avalie a sintaxe exportada na sua plataforma ou renderize o documento salvo com conditionValues booleanos, por ID. Informe um resultado para cada regra alcançável.
Salve o envelope completo de onDocumentChange e reabra com emailDocument. Documentos condicionais exigem schemaVersion: 2, SDK 0.1.6 e editor hospedado compatível.

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.

Variáveis de personalização

Defina variáveis de texto e links por destinatário, como nome ou URL da conta. Os autores as inserem pelo nome sem digitar sua sintaxe.

Use um ID estável, um nome legível e o token exato que sua plataforma espera.
Escolha Texto para conteúdo ou URL para um destino. Descrição e valor de exemplo ajudam na escolha e na prévia.
Definições salvas e do SDK são mescladas por ID. Variáveis já inseridas mantêm a sintaxe no salvamento e na exportação.
Substitua os tokens no seu fluxo de envio ou informe mergeValues ao renderizar o documento salvo.

// 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.

Salvamento automático e rascunhos

Ative o salvamento hospedado para manter rascunhos e histórico na Weavour. Se desativar, sua aplicação deve salvar o documento versionado completo.

Guarde draftId no registro da sua aplicação. Reabra com a mesma chave e o mesmo escopo de userId e organizationId.
Para retomar, informe apenas draftId, sem conteúdo inicial nem emailDocument.
Aguarde flushAutosave() e trate falhas antes de sair; depois chame destroy(). Alteração de conteúdo ou exportação HTML não confirma salvamento.
O histórico mantém 30 dias de versões. Restaurar cria uma nova versão e mantém as posteriores.
Desativar oculta rascunhos e histórico e impede novas gravações hospedadas. Os rascunhos existentes são mantidos.

Blocos da organização

Permita salvar layouts e seu conteúdo como blocos reutilizáveis da organização. Eles ficam disponíveis aos usuários e editores da mesma organização no espaço do cliente.

Informe userId e organizationId. Um contexto pessoal não tem biblioteca de blocos da organização.
Salve um layout pelas ações do layout. Blocos da organização aparecem após os blocos padrão e personalizados na mesma grade.
Inserir cria uma cópia independente; edições ou exclusões posteriores não alteram e-mails existentes.
O criador pode excluir seus blocos. Proprietários e administradores gerenciam os blocos pelo painel, preservando a autoria.
Desativar oculta salvamento e reutilização, mas mantém os blocos salvos e o conteúdo existente.

Modelos

Permita escolher modelos incluídos, do espaço de trabalho ou dos usuários disponíveis no respectivo escopo.

Administradores gerenciam modelos e os publicam para todas as organizações ou apenas as selecionadas.
Modelos de usuários começam privados ao par organização/usuário ou ao usuário no contexto pessoal. Compartilhar com a organização é uma escolha explícita.
Criar um e-mail a partir de um modelo gera cópia independente. Editar a origem exige permissão e a ação Salvar modelo.
Desativar o seletor preserva o e-mail atual e os modelos salvos.

Verificação de e-mails

Mostre uma avaliação de conteúdo e resultados acionáveis abaixo da área de edição. Autores podem abrir o relatório e navegar até os problemas enquanto editam.

As verificações cobrem conteúdo, acessibilidade, imagens, links e riscos comuns de renderização.
A verificação funciona sem IA. Seus controles e sua avaliação ficam fora do e-mail exportado.
Desativar interrompe as verificações e oculta os controles sem alterar o e-mail.
Teste o e-mail final personalizado nos clientes de destino antes de enviar.

Blocos disponíveis

Escolha as ferramentas de conteúdo e layout que os autores podem inserir. Mantenha a paleta focada no fluxo da sua aplicação.

A seleção filtra a paleta. Desmarcar todos os blocos oculta todas as opções.
Alterar a lista não exclui blocos existentes nos e-mails salvos.
Preferências explícitas de allowedBlocks no SDK prevalecem sobre a seleção salva. Omita para usar os padrões do painel.

Aparência e idioma

Combine os controles do editor com sua aplicação usando tema, cores, fonte, densidade e raio dos cantos. Confira o resultado na prévia em tempo real.

Comece pelo modo claro ou escuro e personalize as cores. Mantenha textos, controles e indicadores de foco legíveis.
O idioma controla a interface. Os autores podem escrever o e-mail em outro idioma.
Alterar a aparência preserva rascunho e design. Substituições de tema do SDK prevalecem e podem ser atualizadas em tempo real.