Configurazione della notifica e-mail

AEM invia notifiche e-mail agli utenti che:

  • Si è iscritto a eventi di pagina, ad esempio modifiche o replica. La sezione Inbox notifica descrive come effettuare la sottoscrizione a tali eventi.

  • Si sono abbonati agli eventi del forum.

  • Eseguire un passaggio in un flusso di lavoro. La sezione Passaggio partecipante descrive come attivare la notifica tramite e-mail in un flusso di lavoro.

Prerequisiti:

  • Gli utenti devono avere un indirizzo e-mail valido definito nel suo profilo.
  • È necessario configurare correttamente il Day CQ Mail Service .

Quando un utente viene informato, riceve un’e-mail nella lingua definita nel suo profilo. Ogni lingua ha un proprio modello che può essere personalizzato. È possibile aggiungere nuovi modelli e-mail per le nuove lingue.

NOTA

Quando si lavora con AEM esistono diversi metodi per gestire le impostazioni di configurazione di tali servizi; per ulteriori dettagli e pratiche consigliate, consulta Configurazione di OSGi .

Configurazione del servizio di posta

Affinché AEM possa inviare e-mail, è necessario configurare correttamente il Day CQ Mail Service . Puoi visualizzare la configurazione nella console Web. Quando si lavora con AEM esistono diversi metodi per gestire le impostazioni di configurazione di tali servizi; per ulteriori dettagli e pratiche consigliate, consulta Configurazione di OSGi .

Si applicano i seguenti vincoli:

  • La porta server SMTP deve essere uguale o superiore a 25.

  • Il nome host del server SMTP non deve essere vuoto.

  • L'indirizzo "Da" non deve essere vuoto.

Per aiutarti a eseguire il debug di un problema con Day CQ Mail Service, puoi guardare i registri del servizio:

com.day.cq.mailer.DefaultMailService

La configurazione si presenta come segue nella console Web:

chlimage_1-276

Configurazione del canale di notifica e-mail

Quando vi abbonate a notifiche di eventi di pagina o forum, l’indirizzo e-mail da è impostato su no-reply@acme.com per impostazione predefinita. Puoi modificare questo valore configurando il servizio Canale e-mail di notifica nella console Web.

Per configurare l’indirizzo e-mail da, aggiungi un nodo sling:OsgiConfig all’archivio. Segui la procedura seguente per aggiungere il nodo direttamente utilizzando CRXDE Lite:

  1. In CRXDE Lite, aggiungi una cartella denominata config sotto la cartella dell’applicazione.

  2. Nella cartella di configurazione, aggiungi un nodo denominato:

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

  3. Aggiungi una proprietà String al nodo denominato email.from. Per il valore , specifica l’indirizzo e-mail che desideri utilizzare.

  4. Fare clic su Salva tutto.

Utilizza la seguente procedura per definire il nodo nelle cartelle di origine del pacchetto di contenuti:

  1. Crea un file denominato com.day.cq.wcm.notification.email.impl.EmailChannel.xml nel tuo jcr_root/apps/*app_name*/config folder

  2. Aggiungi il seguente XML per rappresentare il nodo:

    <?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. Sostituisci il valore dell'attributo email.from ( name@server.com) con il tuo indirizzo e-mail.

  4. Salva il file.

Configurazione del servizio di notifica e-mail del flusso di lavoro

Quando ricevi notifiche e-mail del flusso di lavoro, sia l’indirizzo e-mail del flusso di lavoro che il prefisso dell’URL dell’host sono impostati sui valori predefiniti. Puoi modificare questi valori configurando il Servizio notifica e-mail flusso di lavoro CQ giornaliero nella console Web. In questo caso, si consiglia di mantenere la modifica nell’archivio.

Nella console Web la configurazione predefinita è la seguente:

chlimage_1-277

Modelli e-mail per notifica pagina

I modelli e-mail per le notifiche di pagina si trovano di seguito:

/etc/notification/email/default/com.day.cq.wcm.core.page

Il modello inglese predefinito ( en.txt) è definito come segue:

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.

Personalizzazione dei modelli e-mail per la notifica della pagina

Per personalizzare il modello e-mail inglese per la notifica della pagina:

  1. In CRXDE, apri il file:

    /etc/notification/email/default/com.day.cq.wcm.core.page/en.txt

  2. Modifica il file in base alle tue esigenze.

  3. Salva le modifiche.

Il modello deve avere il seguente formato:

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

Dove <text_x> può essere un mix di variabili di testo statiche e di stringhe dinamiche. Le seguenti variabili possono essere utilizzate all’interno del modello e-mail per le notifiche di pagina:

  • ${time}, la data e l’ora dell’evento.

  • ${userFullName}, il nome completo dell’utente che ha attivato l’evento.

  • ${userId}, l'ID dell'utente che ha attivato l'evento.

  • ${modifications}, descrive il tipo di evento pagina e il percorso della pagina nel formato :

    <page event="" type=""> => <page path="">

    Esempio:

    PageModified => /content/geometrixx/en/products

Modelli e-mail per notifica forum

I modelli e-mail per le notifiche dei forum si trovano in:

/etc/notification/email/default/com.day.cq.collab.forum

Il modello inglese predefinito ( en.txt) è definito come segue:

subject=[CQ Forum Notification]

header=-------------------------------------------------------------------------------------\n \
Time: Time: ${time}\n \
Forum Page Path: ${forum.path}\n \
-------------------------------------------------------------------------------------\n\n

message=Page: ${host.prefix}${forum.path}.html\n

footer=\n \
-------------------------------------------------------------------------------------\n \
This is an automatically generated message. Please do not reply.

Personalizzazione dei modelli e-mail per la notifica del forum

Per personalizzare il modello e-mail inglese per la notifica del forum:

  1. In CRXDE, apri il file:

    /etc/notification/email/default/com.day.cq.collab.forum/en.txt

  2. Modifica il file in base alle tue esigenze.

  3. Salva le modifiche.

Il modello deve avere il seguente formato:

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

Dove <text_x> può essere un mix di variabili di testo statiche e di stringhe dinamiche.

Le seguenti variabili possono essere utilizzate all'interno del modello e-mail per le notifiche del forum:

  • ${time}, la data e l’ora dell’evento.

  • ${forum.path}, il percorso della pagina del forum.

Modelli e-mail per notifica flusso di lavoro

Il modello e-mail per le notifiche del flusso di lavoro (inglese) si trova in:

/etc/workflow/notification/email/default/en.txt

È definito come segue:

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.

Personalizzazione dei modelli e-mail per le notifiche dei flussi di lavoro

Per personalizzare il modello e-mail inglese per la notifica dell’evento del flusso di lavoro:

  1. In CRXDE, apri il file:

    /etc/workflow/notification/email/default/en.txt

  2. Modifica il file in base alle tue esigenze.

  3. Salva le modifiche.

Il modello deve avere il seguente formato:

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

Dove <text_x> può essere un mix di variabili di testo statiche e di stringhe dinamiche. È necessario terminare ciascuna riga di un elemento <text_x> con una barra inversa ( \), fatta eccezione per l’ultima istanza, quando l’assenza della barra inversa indica la fine della variabile della stringa <text_x>.

Ulteriori informazioni sul formato del modello sono disponibili in javadocs del metodo Properties.load() .

Il metodo ${payload.path.open} rivela il percorso del payload dell’elemento di lavoro. Ad esempio, per una pagina in Sites allora payload.path.open sarà simile a /bin/wcmcommand?cmd=open&path=….; senza il nome del server, motivo per cui il modello ne esegue la preclusione con ${host.prefix}.

Le seguenti variabili possono essere utilizzate all’interno del modello e-mail:

  • ${event.EventType}, tipo dell’evento

  • ${event.TimeStamp}, data e ora dell'evento

  • ${event.User}, l’utente che ha attivato l’evento

  • ${initiator.home}, il percorso del nodo iniziatore

  • ${initiator.name}, il nome dell'iniziatore

  • ${initiator.email}, indirizzo e-mail dell'iniziatore

  • ${item.id}, l'id dell'elemento di lavoro

  • ${item.node.id}, id del nodo nel modello di flusso di lavoro associato a questo elemento di lavoro

  • ${item.node.title}, titolo dell'elemento di lavoro

  • ${participant.email}, indirizzo e-mail del partecipante

  • ${participant.name}, nome del partecipante

  • ${participant.familyName}, cognome del partecipante

  • ${participant.id}id del partecipante

  • ${participant.language}, la lingua del partecipante

  • ${instance.id}, l'id del flusso di lavoro

  • ${instance.state}, lo stato del flusso di lavoro

  • ${model.title}, titolo del modello di flusso di lavoro

  • ${model.id}, l’id del modello di flusso di lavoro

  • ${model.version}, la versione del modello di flusso di lavoro

  • ${payload.data}, il payload

  • ${payload.type}, il tipo di payload

  • ${payload.path}, percorso del payload

  • ${host.prefix}, prefisso host, ad esempio: http://localhost:4502

Aggiunta di un modello e-mail per una nuova lingua

Per aggiungere un modello per una nuova lingua:

  1. In CRXDE, aggiungi un file <language-code>.txt qui sotto:

    • /etc/notification/email/default/com.day.cq.wcm.core.page : per le notifiche di pagina
    • /etc/notification/email/default/com.day.cq.collab.forum : per le notifiche sul forum
    • /etc/workflow/notification/email/default : per le notifiche del flusso di lavoro
  2. Adatta il file alla lingua.

  3. Salva le modifiche.

NOTA

Il <language-code> utilizzato come nome del file per il modello e-mail deve essere un codice della lingua minuscola a due lettere riconosciuto da AEM. Per i codici di lingua, AEM si basa su ISO-639-1.

Configurazione delle notifiche e-mail di AEM Assets

Quando le raccolte in AEM Assets vengono condivise o non condivise, gli utenti possono ricevere notifiche e-mail da AEM. Per configurare le notifiche e-mail, segui questi passaggi.

  1. Configura il servizio e-mail come descritto sopra in Configurazione del servizio e-mail.
  2. Accedi a AEM come amministratore. Fare clic su Strumenti > Operazioni > Console web per aprire Configurazione console Web.
  3. Modifica Day CQ DAM Resource Collection Servlet. Seleziona Invia e-mail. Fai clic su Salva.

Configurazione di OAuth

AEM offre il supporto OAuth2 per il suo servizio Mailer integrato, al fine di consentire alle organizzazioni di rispettare i requisiti di sicurezza delle e-mail.

Puoi configurare OAuth per più provider di posta elettronica, come descritto di seguito.

Gmail

  1. Crea il progetto in https://console.developers.google.com/projectcreate
  2. Seleziona il progetto, quindi vai a API e servizi - Dashboard - Credenziali
  3. Configura la schermata di consenso OAuth in base alle tue esigenze
  4. Nella schermata Aggiorna che segue, aggiungi questi due ambiti:
    • https://mail.google.com/
    • https://www.googleapis.com//auth/gmail.send
  5. Dopo aver aggiunto gli ambiti, torna a Credenziali nel menu a sinistra, quindi vai a Crea credenziali - OAuth Client ID - App desktop
  6. Viene aperta una nuova finestra contenente l’ID client e il segreto client.
  7. Salva queste credenziali.

Configurazioni lato AEM

NOTA

I clienti di Adobe Managed Service possono collaborare con il tecnico del servizio clienti per apportare queste modifiche agli ambienti di produzione.

Per prima cosa, configura il servizio di posta:

  1. Apri la Console Web AEM andando su http://serveraddress:serverport/system/console/configMgr
  2. Cerca, quindi fai clic su Day CQ Mail Service
  3. Aggiungi le seguenti impostazioni:
    • Nome host del server SMTP: smtp.gmail.com
    • Porta server SMTP: 25 o 587, a seconda dei requisiti
    • Seleziona le caselle di controllo per SMPT utilizza StarTLS e SMTP richiede StarTLS
    • Controlla Flusso OAuth e fai clic su Salva.

Quindi, configura il provider OAuth SMTP seguendo la procedura seguente:

  1. Apri la Console Web AEM andando su http://serveraddress:serverport/system/console/configMgr
  2. Cerca, quindi fai clic su CQ Mailer SMTP OAuth2 Provider
  3. Compila le informazioni richieste come segue:
    • URL autorizzazione: https://accounts.google.com/o/oauth2/auth
    • URL token: https://accounts.google.com/o/oauth2/token
    • Ambiti: https://www.googleapis.com/auth/gmail.send e https://mail.google.com/. È possibile aggiungere più di un ambito premendo il pulsante + a destra di ciascun ambito configurato.
    • ID client e segreto client: configura questi campi con i valori recuperati come descritto nel paragrafo precedente.
    • Aggiorna URL token: https://accounts.google.com/o/oauth2/token
    • Aggiorna scadenza token: mai
  4. Fai clic su Salva.

Una volta configurate, le impostazioni saranno simili al seguente:

oauth smtp provider

Ora attiva i componenti OAuth. Puoi eseguire questa operazione:

  1. Vai alla console Componenti visitando questo URL: http://serveraddress:serverport/system/console/components

  2. Cerca i seguenti componenti

    • com.day.cq.mailer.oauth.servlets.handler.OAuthCodeGenerateServlet
    • com.day.cq.mailer.oauth.servlets.handler.OAuthCodeAccessTokenGenerator
  3. Premere l’icona Riproduci a sinistra dei componenti

    componenti

Infine, conferma la configurazione:

  1. Andando all'indirizzo dell'istanza Publish e accedendo come amministratore.
  2. Apri una nuova scheda nel browser e vai a http://serveraddress:serverport/services/mailer/oauth2/authorize. Questo ti reindirizzerà alla pagina del tuo provider SMTP, in questo caso Gmail.
  3. Accedi e acconsenti a concedere le autorizzazioni richieste
  4. Dopo il consenso, il token verrà memorizzato nell’archivio. Puoi accedervi in accessToken accedendo direttamente a questo URL nella tua istanza di pubblicazione: http://serveraddress:serverport/crx/de/index.jsp#/conf/global/settings/mailer/oauth2
  5. Ripeti quanto sopra per ogni istanza di pubblicazione

Microsoft Outlook

  1. Vai a https://portal.azure.com/ e accedi.

  2. Cerca Azure Active Directory nella barra di ricerca e fai clic sul risultato. In alternativa, è possibile accedere direttamente a https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/Overview

  3. Fai clic su Registrazione app - Nuova registrazione

  4. Compila le informazioni in base alle tue esigenze, quindi fai clic su Registra

  5. Vai alla nuova app creata e seleziona Autorizzazioni API

  6. Vai a Aggiungi autorizzazione - Autorizzazione grafico - Autorizzazioni delegate

  7. Seleziona le seguenti autorizzazioni per la tua app, quindi fai clic su Aggiungi autorizzazione:

    • SMTP.Send
    • Mail.Read
    • Mail.Send
    • openid
    • offline_access
  8. Vai a Autenticazione - Aggiungi una piattaforma - Web e nella sezione URL di reindirizzamento aggiungi il seguente URL per reindirizzare il codice OAuth, quindi premi Configura:

    • http://localhost:4503/services/mailer/oauth2/token
  9. Ripeti quanto sopra per ogni istanza di pubblicazione

  10. Configura le impostazioni in base alle tue esigenze

  11. Quindi, vai a Certificati e segreti, fai clic su Nuovo segreto client e segui i passaggi sullo schermo per creare un segreto. Assicurati di prendere nota di questo segreto per un uso successivo

  12. Premere Panoramica nel riquadro a sinistra e copiare i valori per ID applicazione (client) e ID directory (tenant) per un uso successivo

Per ricapitolare, dovrai disporre delle seguenti informazioni per configurare OAuth2 per il servizio Mailer sul lato AEM:

  • L’URL di autenticazione, che verrà costruito con l’ID tenant. Avrà il seguente modulo: https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/authorize
  • L’URL del token, che verrà costruito con l’ID tenant. Avrà il seguente modulo: https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/token
  • L’URL di aggiornamento, che verrà costruito con l’ID tenant. Avrà il seguente modulo: https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/token
  • ID client
  • Segreto client

Configurazioni lato AEM

Quindi, integra le impostazioni OAuth2 con AEM:

  1. Vai alla console Web dell'istanza locale sfogliando http://serveraddress:serverport/system/console/configMgr
  2. Cerca e fai clic su Day CQ Mail Service
  3. Aggiungi le seguenti impostazioni:
    • Nome host del server SMTP: smtp.office365.com
    • Utente SMTP: il tuo nome utente in formato e-mail
    • Indirizzo "Da": Indirizzo e-mail da utilizzare nel campo "Da:" dei messaggi inviati dal mittente
    • Porta server SMTP: 25 o 587 a seconda dei requisiti
    • Seleziona le caselle di controllo per SMPT utilizza StarTLS e SMTP richiede StarTLS
    • Controlla Flusso OAuth e fai clic su Salva.
  4. Cerca, quindi fai clic su CQ Mailer SMTP OAuth2 Provider
  5. Compila le informazioni richieste come segue:
    • Compila l'URL di autorizzazione, l'URL del token e l'URL del token di aggiornamento costruendoli come descritto in fine di questa procedura
    • ID client e segreto client: configura questi campi con i valori recuperati come descritto in precedenza.
    • Aggiungi i seguenti ambiti alla configurazione:
      • openid
      • offline_access
      • https://outlook.office365.com/Mail.Send
      • https://outlook.office365.com/Mail.Read
      • https://outlook.office365.com/SMTP.Send
    • Url di reindirizzamento di AuthCode: http://localhost:4503/services/mailer/oauth2/token
    • Aggiorna URL token: dovrebbe avere lo stesso valore dell’URL del token sopra
  6. Fai clic su Salva.

Una volta configurate, le impostazioni saranno simili al seguente:

Ora attiva i componenti OAuth. Puoi eseguire questa operazione:

  1. Vai alla console Componenti visitando questo URL: http://serveraddress:serverport/system/console/components
  2. Cerca i seguenti componenti
    • com.day.cq.mailer.oauth.servlets.handler.OAuthCodeGenerateServlet
    • com.day.cq.mailer.oauth.servlets.handler.OAuthCodeAccessTokenGenerator
  3. Premere l’icona Riproduci a sinistra dei componenti

Componenti2

Infine, conferma la configurazione:

  1. Andando all'indirizzo dell'istanza Publish e accedendo come amministratore.
  2. Apri una nuova scheda nel browser e vai a http://serveraddress:serverport/services/mailer/oauth2/authorize. Questo ti reindirizzerà alla pagina del tuo provider SMTP, in questo caso Gmail.
  3. Accedi e acconsenti a concedere le autorizzazioni richieste
  4. Dopo il consenso, il token verrà memorizzato nell’archivio. Puoi accedervi in accessToken accedendo direttamente a questo URL nella tua istanza di pubblicazione: http://serveraddress:serverport/crx/de/index.jsp#/conf/global/settings/mailer/oauth2

In questa pagina