DocumentaçãoAEM 6.5Guia do usuário

Configuração da notificação por e-mail configuring-email-notification

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:

Criado para:

  • undefined

O AEM envia notificações por email para usuários que:

  • Ter se inscrito em eventos de página, por exemplo, modificação ou replicação. A seção Caixa de Entrada de Notificação descreve como assinar esses eventos.

  • Ter se inscrito nos eventos do fórum.

  • É necessário executar uma etapa em um fluxo de trabalho. A seção Etapa de participante descreve como acionar notificação por email em um fluxo de trabalho.

Pré-requisitos:

  • O(s) usuário(s) precisa(m) ter um endereço de email válido definido em seu perfil.
  • O Day CQ Mail Service precisa ser configurado corretamente.

Quando um usuário é notificado, ele recebe um email no idioma definido em seu perfil. Cada idioma tem seu próprio modelo que pode ser personalizado. Novos modelos de email podem ser adicionados para novos idiomas.

NOTE
Ao trabalhar com AEM, há vários métodos de gerenciamento das definições de configuração desses serviços; consulte Configurar OSGi para obter mais detalhes e as práticas recomendadas.

Configurando o serviço de e-mail configuring-the-mail-service

Para que o AEM possa enviar emails, o Day CQ Mail Service precisa ser configurado corretamente. Você pode exibir a configuração no console da Web. Ao trabalhar com AEM, há vários métodos de gerenciamento das definições de configuração desses serviços; consulte Configurar OSGi para obter mais detalhes e as práticas recomendadas.

As seguintes restrições se aplicam:

  • A porta do servidor SMTP deve ser 25 ou superior.

  • O nome de host do servidor SMTP não deve estar em branco.

  • O endereço "From" não deve estar em branco.

Para ajudar você a depurar um problema com o Day CQ Mail Service, assista aos logs do serviço:

com.day.cq.mailer.DefaultMailService

A configuração tem a seguinte aparência no console da Web:

A janela de configuração OSGi do Day CQ Mail Service

Configuração do canal de notificação por email configuring-the-email-notification-channel

Quando você se inscreve nas notificações de eventos de página ou fórum, o endereço de e-mail do remetente é definido como no-reply@acme.com por padrão. Você pode alterar esse valor configurando o serviço Canal de email de notificação no Console da Web.

Para configurar o endereço de email do remetente, adicione um nó sling:OsgiConfig ao repositório. Use o procedimento a seguir para adicionar o nó diretamente usando o CRXDE Lite:

  1. No CRXDE Lite, adicione uma pasta chamada config abaixo da pasta do aplicativo.

  2. Na pasta de configuração, adicione um nó chamado:

    com.day.cq.wcm.notification.email.impl.EmailChannel do tipo sling:OsgiConfig

  3. Adicione uma propriedade String ao nó chamado email.from. Para o valor, especifique o endereço de email que deseja usar.

  4. Clique em Salvar tudo.

Use o procedimento a seguir para definir o nó nas pastas de origem do pacote de conteúdo:

  1. Em seu jcr_root/apps/*app_name*/config folder, crie um arquivo chamado com.day.cq.wcm.notification.email.impl.EmailChannel.xml

  2. Adicione o seguinte XML para representar o nó:

    <?xml version="1.0" encoding="UTF-8"?> <jcr:root xmlns:sling="https://sling.apache.org/jcr/sling/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0" jcr:primaryType="sling:OsgiConfig" email.from="name@server.com"/>

  3. Substitua o valor do atributo email.from ( name@server.com) pelo seu endereço de email.

  4. Salve o arquivo.

Configurar o serviço de notificação por email do fluxo de trabalho configuring-the-workflow-email-notification-service

Ao receber notificações por email do fluxo de trabalho, o endereço de email do remetente e o prefixo do URL do host são definidos com valores padrão. Você pode alterar esses valores configurando o Serviço de Notificação por Email do Fluxo de Trabalho do CQ no Console da Web. Se você fizer isso, é recomendável manter a alteração no repositório.

A configuração padrão tem a seguinte aparência no Console da Web:

A janela de configuração do Serviço de notificação por email do fluxo de trabalho do Day CQ

Modelos de email para notificação de página email-templates-for-page-notification

Os modelos de email para notificações de página estão localizados abaixo:

/libs/settings/notification-templates/com.day.cq.wcm.core.page

O modelo padrão em inglês ( en.txt) é definido da seguinte maneira:

subject=[CQ Page Event Notification]: Page Event

header=-------------------------------------------------------------------------------------\n \
Time: ${time}\n \
User: ${userFullName} (${userId})\n \
-------------------------------------------------------------------------------------\n\n

message=The following pages were affected by the event: \n \
 \n \
${modifications} \n \
 \n\n
footer=\n \
-------------------------------------------------------------------------------------\n \
This is an automatically generated message. Please do not reply.

Personalização de modelos de e-mail para notificação de página customizing-email-templates-for-page-notification

Para personalizar o modelo de email em inglês para notificação de página:

  1. No CRXDE, abra o arquivo:

    /libs/settings/notification-templates/com.day.cq.wcm.core.page/en.txt

  2. Modifique o arquivo de acordo com suas necessidades.

  3. Salve as alterações.

O template precisa ter o seguinte formato:

 subject=<text_1>
 header=<text_2>
 message=<text_3>
 footer=<text_4>

Onde <text_x> pode ser uma combinação de texto estático e variáveis de sequência dinâmicas. As seguintes variáveis podem ser usadas no modelo de email para notificações de página:

  • ${time}, a data e hora do evento.

  • ${userFullName}, o nome completo do usuário que disparou o evento.

  • ${userId}, a ID do usuário que disparou o evento.

  • ${modifications}, descreve o tipo de evento de página e o caminho da página no formato:

    <tipo de evento da página> => <caminho da página>

    Por exemplo:

    PageModified => /content/geometrixx/en/products

Modelos de email para notificação de fluxo de trabalho email-templates-for-workflow-notification

O modelo de email para notificações de workflow (inglês) está localizado em:

/libs/settings/workflow/notification/email/default/en.txt

Ela é definida da seguinte maneira:

subject=Workflow notification: ${event.EventType}

header=-------------------------------------------------------------------------------------\n \
Time: ${event.TimeStamp}\n \
Step: ${item.node.title}\n \
User: ${participant.name} (${participant.id})\n \
Workflow: ${model.title}\n \
-------------------------------------------------------------------------------------\n\n

message=Content: ${host.prefix}${payload.path.open}\n

footer=\n \
-------------------------------------------------------------------------------------\n \
View the overview in your ${host.prefix}/aem/inbox\n \
-------------------------------------------------------------------------------------\n \
This is an automatically generated message. Please do not reply.

Personalização de modelos de e-mail para notificação de workflow customizing-email-templates-for-workflow-notification

Para personalizar o template de email em inglês para notificação de eventos de workflow:

  1. No CRXDE, abra o arquivo:

    /libs/settings/workflow/notification/email/default/en.txt

  2. Modifique o arquivo de acordo com suas necessidades.

  3. Salve as alterações.

O template precisa ter o seguinte formato:

subject=<text_1>
 header=<text_2>
 message=<text_3>
 footer=<text_4>
NOTE
Onde <text_x> pode ser uma combinação de texto estático e variáveis de cadeia de caracteres dinâmicas. Cada linha de um item <text_x> precisa ser encerrada com uma barra invertida ( \), exceto para a última instância, quando a ausência da barra invertida indica o fim da variável de cadeia de caracteres <text_x>.
Mais informações sobre o formato do modelo podem ser encontradas no javadocs do método Properties.load().

O método ${payload.path.open} revela o caminho para a carga útil do item de trabalho. Por exemplo, para uma página no Sites, então payload.path.open seria semelhante a /bin/wcmcommand?cmd=open&path=….; isso ocorre sem o nome do servidor, razão pela qual o modelo anexa isso com ${host.prefix}.

As seguintes variáveis podem ser usadas no template de email:

  • ${event.EventType}, tipo de evento

  • ${event.TimeStamp}, data e hora do evento

  • ${event.User}, o usuário que disparou o evento

  • ${initiator.home}, o caminho do nó iniciador

  • ${initiator.name}, o nome do iniciador

  • ${initiator.email}, endereço de email do iniciador

  • ${item.id}, a id do item de trabalho

  • ${item.node.id}, ID do nó no modelo de fluxo de trabalho associado a este item de trabalho

  • ${item.node.title}, título do item de trabalho

  • ${participant.email}, endereço de email do participante

  • ${participant.name}, nome do participante

  • ${participant.familyName}, nome de família do participante

  • ${participant.id}, id do participante

  • ${participant.language}, o idioma do participante

  • ${instance.id}, a ID do fluxo de trabalho

  • ${instance.state}, o estado do fluxo de trabalho

  • ${model.title}, título do modelo de fluxo de trabalho

  • ${model.id}, a id do modelo de fluxo de trabalho

  • ${model.version}, a versão do modelo de fluxo de trabalho

  • ${payload.data}, a carga

  • ${payload.type}, o tipo de conteúdo

  • ${payload.path}, caminho da carga

  • ${host.prefix}, prefixo de host, por exemplo,: http://localhost:4502

Adicionando um modelo de email para um novo idioma adding-an-email-template-for-a-new-language

Para adicionar um modelo para um novo idioma:

  1. No CRXDE, adicione um arquivo <language-code>.txt abaixo:

    • /libs/settings/notification-templates/com.day.cq.wcm.core.page : para notificações de página
    • /libs/settings/workflow/notification/email/default : para notificações de fluxo de trabalho

  2. Adapte o arquivo ao idioma.

  3. Salve as alterações.

NOTE
O <language-code> usado como nome de arquivo para o modelo de email precisa ser um código de idioma de duas letras minúsculas reconhecido pelo AEM. Para códigos de idioma, o AEM depende da ISO-639-1.

Configuração de notificações por email do AEM Assets assetsconfig

Quando as coleções no AEM Assets são compartilhadas ou não, os usuários podem receber notificações por email do AEM. Para configurar notificações por email, siga estas etapas.

  1. Configure o serviço de email, conforme descrito acima em Configurando o Serviço de Email.
  2. Faça logon no AEM como administrador. Clique em Ferramentas > Operações > Console da Web para abrir a Configuração do Console da Web.
  3. Editar o Servlet de coleção de recursos DAM CQ do dia. Selecione enviar email. Clique em Salvar.

Configuração do OAuth setting-up-oauth

A AEM oferece suporte do OAuth2 para seu serviço de email integrado, a fim de permitir que as organizações cumpram com os requisitos de segurança de email.

Você pode configurar o OAuth para vários provedores de email, conforme descrito abaixo.

NOTE
Esse procedimento é um exemplo para uma instância do Publish. Se quiser ativar notificações por email em uma instância de Autor, siga as mesmas etapas no Autor.

Gmail gmail

  1. Crie seu projeto em https://console.developers.google.com/projectcreate

  2. Selecione seu projeto e vá para APIs e serviços - Painel - Credenciais

  3. Configure a Tela de consentimento do OAuth de acordo com suas necessidades

  4. Na tela Atualizar a seguir, adicione estes dois escopos:

    • https://mail.google.com/
    • https://www.googleapis.com//auth/gmail.send

  5. Depois de adicionar os escopos, volte para Credenciais no menu à esquerda e vá para Criar Credenciais - ID de Cliente OAuth - Aplicativo de desktop

  6. Uma nova janela é aberta contendo a ID do cliente e o Segredo do cliente.

  7. Salve essas credenciais.

Configurações do AEM Side

NOTE
Os clientes do Adobe Managed Service podem trabalhar com o engenheiro de atendimento ao cliente para fazer essas alterações nos ambientes de produção.

Primeiro, configure o Serviço de e-mail:

  1. Abra o Console da Web do AEM acessando http://serveraddress:serverport/system/console/configMgr

  2. Procure e clique em Day CQ Mail Service

  3. Adicione as seguintes configurações:

    • Nome do Host do Servidor SMTP: smtp.gmail.com
    • Porta do Servidor SMTP: 25 ou 587, dependendo dos requisitos
    • Marque as caixas de seleção para SMPT usar StarTLS e SMTP exigir StarTLS
    • Verifique o fluxo do OAuth e clique em Salvar.

Em seguida, configure o provedor SMTP OAuth seguindo o procedimento abaixo:

  1. Abra o Console da Web do AEM acessando http://serveraddress:serverport/system/console/configMgr

  2. Procure e clique em Provedor OAuth2 SMTP do CQ Mailer

  3. Preencha as informações necessárias da seguinte maneira:

    • URL de autorização: https://accounts.google.com/o/oauth2/auth
    • URL do token: https://accounts.google.com/o/oauth2/token
    • Escopos: https://www.googleapis.com/auth/gmail.send e https://mail.google.com/. Você pode adicionar mais de um escopo pressionando o botão + no lado direito de cada escopo configurado.
    • ID do cliente e Segredo do cliente: configure esses campos com os valores que você recuperou, conforme descrito no parágrafo acima.
    • URL do token de atualização: https://accounts.google.com/o/oauth2/token
    • Expiração do token de atualização: nunca

  4. Clique em Salvar.

Depois de definidas, as configurações devem ter esta aparência:

A janela de configuração do Provedor CQ Mailer SMTP Oauth2

Agora, ative os componentes OAuth. Você pode fazer isso ao:

  1. Vá para o Console Componentes visitando esta URL: http://serveraddress:serverport/system/console/components

  2. Procure os seguintes componentes

    • com.day.cq.mailer.oauth.servlets.handler.OAuthCodeGenerateServlet
    • com.day.cq.mailer.oauth.servlets.handler.OAuthCodeAccessTokenGenerator

  3. Pressione o ícone Reproduzir à esquerda dos componentes

    Lista de componentes mostrando OAuthCodeGenerateServlet e OAuthCodeAccessTokenGenerator

Por fim, confirme a configuração ao:

  1. Ir para o endereço da instância do Publish e fazer logon como administrador.
  2. Abra uma nova guia no navegador e vá para http://serveraddress:serverport/services/mailer/oauth2/authorize. Você será redirecionado para a página do seu provedor SMTP, neste caso, o Gmail.
  3. Logon e consentimento para fornecer as permissões necessárias
  4. Após o consentimento, o token será armazenado no repositório. Você pode acessá-la em accessToken acessando diretamente esta URL na sua instância de publicação: http://serveraddress:serverport/crx/de/index.jsp#/conf/global/settings/mailer/oauth
  5. Repita o procedimento acima para cada instância de publicação

Microsoft Outlook microsoft-outlook

  1. Acesse https://portal.azure.com/ e faça logon.

  2. Digite Azure Active Directory na barra de pesquisa e clique no resultado. Como alternativa, você pode navegar diretamente para https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/Overview

  3. Clique em Registro do aplicativo - Novo registro

    O novo botão de registro ao configurar o Microsoft Outlook

  4. Preencha as informações de acordo com suas necessidades e clique em Registrar

  5. Acesse o aplicativo recém-criado e selecione Permissões de API

  6. Vá em Adicionar permissão - Permissão de gráfico - Permissões delegadas

  7. Selecione as permissões abaixo para seu aplicativo e clique em Adicionar permissão:

    • SMTP.Send
    • Mail.Read
    • Mail.Send
    • openid
    • offline_access

  8. Vá para Autenticação - Adicionar uma plataforma - Web e, na seção Redirecionar URLs, adicione a seguinte URL para redirecionar o código OAuth e pressione Configurar:

    • http://localhost:4503/services/mailer/oauth2/token

  9. Repita o procedimento acima para cada instância de publicação

  10. Defina as configurações de acordo com seus requisitos

  11. Em seguida, vá para Certificados e segredos, clique em Novo segredo de cliente e siga as etapas na tela para criar um segredo. Anote este segredo para uso posterior

  12. Pressione Visão geral no painel esquerdo e copie os valores de ID do aplicativo (cliente) e ID do diretório (locatário) para uso posterior

Para recapitular, você deve ter as seguintes informações para configurar o OAuth2 para o serviço Mailer no lado do AEM:

  • O URL de autenticação, que será construído com a ID do locatário. Ele terá este formato: https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/authorize
  • O URL do token, que será construído com a ID do locatário. Ele terá este formato: https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/token
  • O URL de atualização, que será construído com a ID do locatário. Ele terá este formato: https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/token
  • A ID do cliente
  • O segredo do cliente

Configurações do AEM Side

Em seguida, integre suas configurações do OAuth2 com o AEM:

  1. Vá para o Console da Web da sua instância local navegando até http://serveraddress:serverport/system/console/configMgr

  2. Procure e clique em Day CQ Mail Service

  3. Adicione as seguintes configurações:

    • Nome do Host do Servidor SMTP: smtp.office365.com
    • Usuário SMTP: seu nome de usuário no formato de email
    • Endereço "De": o endereço de email a ser usado no campo "De:" das mensagens enviadas pelo correio
    • Porta do Servidor SMTP: 25 ou 587 dependendo dos requisitos
    • Marque as caixas de seleção para SMPT usar StarTLS e SMTP exigir StarTLS
    • Verifique o fluxo do OAuth e clique em Salvar.

  4. Procure e clique em Provedor OAuth2 SMTP do CQ Mailer

  5. Preencha as informações necessárias da seguinte maneira:

    • Preencha o URL de Autorização, URL do Token e URL do Token de Atualização construindo-os conforme descrito em o fim deste procedimento

    • ID do cliente e Segredo do cliente: configure esses campos com os valores que você recuperou, conforme descrito acima.

    • Adicione os seguintes escopos à configuração:

      • openid
      • offline_access
      • https://outlook.office365.com/Mail.Send
      • https://outlook.office365.com/Mail.Read
      • https://outlook.office365.com/SMTP.Send

    • URL de Redirecionamento AuthCode: http://localhost:4503/services/mailer/oauth2/token

    • URL do token de atualização: deve ter o mesmo valor que o URL do token acima

  6. Clique em Salvar.

Depois de definidas, as configurações devem ter esta aparência:

A configuração OAuth2 de SMTP do CQ Mailer concluída

Agora, ative os componentes OAuth. Você pode fazer isso ao:

  1. Vá para o Console Componentes visitando esta URL: http://serveraddress:serverport/system/console/components

  2. Procure os seguintes componentes

    • com.day.cq.mailer.oauth.servlets.handler.OAuthCodeGenerateServlet
    • com.day.cq.mailer.oauth.servlets.handler.OAuthCodeAccessTokenGenerator

  3. Pressione o ícone Reproduzir à esquerda dos componentes

Um trecho da lista de componentes que contém OAuthCodeGenerateServlet e OAuthCodeAccessTokenGenerator

Por fim, confirme a configuração ao:

  1. Ir para o endereço da instância do Publish e fazer logon como administrador.
  2. Abra uma nova guia no navegador e vá para http://serveraddress:serverport/services/mailer/oauth2/authorize. Você será redirecionado para a página do provedor SMTP, neste caso, para o Outlook.
  3. Logon e consentimento para fornecer as permissões necessárias
  4. Após o consentimento, o token será armazenado no repositório. Você pode acessá-la em accessToken acessando diretamente esta URL na sua instância de publicação: http://serveraddress:serverport/crx/de/index.jsp#/conf/global/settings/mailer/oauth
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2