Konfigurerar e-postmeddelande configuring-email-notification

AEM skickar e-postmeddelanden till användare som:

  • Prenumerera på sidhändelser, till exempel ändringar eller replikering. The Inkorgen för meddelanden I beskrivs hur du prenumererar på sådana händelser.

  • Prenumerera på forumevent.

  • Måste utföra ett steg i ett arbetsflöde. The Deltagarsteg I beskrivs hur du utlöser e-postmeddelanden i ett arbetsflöde.

Krav:

  • Användaren/användarna måste ha en giltig e-postadress definierad i profilen.
  • The Dagens CQ-tjänst för e-post måste vara korrekt konfigurerade.

När en användare meddelas får han eller hon ett e-postmeddelande på det språk som definieras i hans profil. Varje språk har en egen mall som kan anpassas. Nya e-postmallar kan läggas till för nya språk.

NOTE
När du arbetar med AEM finns det flera metoder för att hantera konfigurationsinställningarna för sådana tjänster. Se Konfigurerar OSGi om du vill ha mer information och rekommenderade rutiner.

Konfigurera e-posttjänsten configuring-the-mail-service

För AEM kunna skicka e-post Dagens CQ-tjänst för e-post måste vara korrekt konfigurerade. Du kan visa konfigurationen i webbkonsolen. När du arbetar med AEM finns det flera metoder för att hantera konfigurationsinställningarna för sådana tjänster. Se Konfigurerar OSGi om du vill ha mer information och rekommenderade rutiner.

Följande begränsningar gäller:

  • The SMTP-serverport måste vara 25 eller högre.

  • The Värdnamn för SMTP-server får inte vara tomt.

  • The "Från"-adress får inte vara tomt.

Så här felsöker du ett problem med Dagens CQ-tjänst för e-post kan du titta på loggarna för tjänsten:

com.day.cq.mailer.DefaultMailService

Konfigurationen ser ut så här i webbkonsolen:

Konfigurationsfönstret Day CQ Mail Service OSGi

Konfigurera e-postmeddelandekanalen configuring-the-email-notification-channel

När du prenumererar på en sida eller ett forum-event-meddelande anges e-postadressen till no-reply@acme.com som standard. Du kan ändra värdet genom att konfigurera E-postkanal för avisering i webbkonsolen.

Om du vill konfigurera from-email-adressen lägger du till en sling:OsgiConfig till databasen. Använd följande procedur för att lägga till noden direkt med CRXDE Lite:

  1. Lägg till en mapp med namnet i CRXDE Lite config nedanför din programmapp.

  2. Lägg till en nod med namnet:

    com.day.cq.wcm.notification.email.impl.EmailChannel av typen sling:OsgiConfig

  3. Lägg till en String egenskap till noden med namnet email.from. Ange den e-postadress som du vill använda som värde.

  4. Klicka Spara alla.

Använd följande procedur för att definiera noden i innehållspaketets källmappar:

  1. I jcr_root/apps/*app_name*/config folder, skapa en fil med namnet com.day.cq.wcm.notification.email.impl.EmailChannel.xml

  2. Lägg till följande XML för att representera noden:

    <?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. Ersätt värdet för email.from attribute ( name@server.com) med din e-postadress.

  4. Spara filen.

Konfigurera e-postmeddelandetjänsten för arbetsflöde configuring-the-workflow-email-notification-service

När du får e-postmeddelanden om arbetsflöden anges standardvärden för både from-email-adressen och värd-URL-prefixet. Du kan ändra dessa värden genom att konfigurera Day CQ Workflow Email Notification Service i webbkonsolen. Om du gör det bör du behålla ändringen i databasen.

Standardkonfigurationen ser ut så här i webbkonsolen:

Konfigurationsfönstret för CQ Workflow Email Notification Service

E-postmallar för sidmeddelanden email-templates-for-page-notification

E-postmallar för sidmeddelanden finns nedan:

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

Standardmallen för engelska ( en.txt) definieras enligt följande:

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.

Anpassa e-postmallar för sidmeddelanden customizing-email-templates-for-page-notification

Så här anpassar du den engelska e-postmallen för sidmeddelanden:

  1. Öppna filen i CRXDE:

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

  2. Ändra filen efter dina behov.

  3. Spara ändringarna.

Mallen måste ha följande format:

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

Plats <text_x> kan vara en blandning av statisk text och dynamiska strängvariabler. Följande variabler kan användas i e-postmallen för sidmeddelanden:

  • ${time}, händelsens datum och tid.

  • ${userFullName}, det fullständiga namnet på den användare som utlöste händelsen.

  • ${userId}, ID:t för den användare som utlöste händelsen.

  • ${modifications}, beskriver sidhändelsens typ och sidsökvägen i formatet:

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

    Till exempel:

    PageModified => /content/geometrixx/en/products

E-postmallar för arbetsflödesmeddelanden email-templates-for-workflow-notification

E-postmallen för arbetsflödesmeddelanden (engelska) finns på:

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

Den definieras enligt följande:

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.

Anpassa e-postmallar för arbetsflödesmeddelanden customizing-email-templates-for-workflow-notification

Så här anpassar du den engelska e-postmallen för meddelanden om arbetsflödeshändelser:

  1. Öppna filen i CRXDE:

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

  2. Ändra filen efter dina behov.

  3. Spara ändringarna.

Mallen måste ha följande format:

subject=<text_1>
 header=<text_2>
 message=<text_3>
 footer=<text_4>
NOTE
Plats <text_x> kan vara en blandning av statisk text och dynamiska strängvariabler. Varje rad i en <text_x> objektet måste avslutas med ett omvänt snedstreck ( \), förutom för den sista förekomsten, när frånvaron av omvänt snedstreck anger slutet på <text_x> strängvariabel.
Mer information om mallformatet finns i javadocs för Properties.load() -metod.

Metoden ${payload.path.open} visar sökvägen till arbetsobjektets nyttolast. För en sida i Sites händer sedan payload.path.open skulle likna /bin/wcmcommand?cmd=open&path=….; detta är utan servernamnet, vilket är orsaken till att mallen anger detta med ${host.prefix}.

Följande variabler kan användas i e-postmallen:

  • ${event.EventType}, händelsens typ

  • ${event.TimeStamp}, datum och tid för händelsen

  • ${event.User}, den användare som utlöste händelsen

  • ${initiator.home}, initierarnodens sökväg

  • ${initiator.name}, initierarnamnet

  • ${initiator.email}, initierarens e-postadress

  • ${item.id}, arbetsuppgiftens ID

  • ${item.node.id}, ID för noden i arbetsflödesmodellen som är kopplad till det här arbetsobjektet

  • ${item.node.title}, arbetsuppgiftens titel

  • ${participant.email}, deltagarens e-postadress

  • ${participant.name}, deltagarens namn

  • ${participant.familyName}, deltagarens familjenamn

  • ${participant.id}, deltagarens id

  • ${participant.language}, deltagarspråket

  • ${instance.id}, arbetsflödes-ID

  • ${instance.state}, arbetsflödets status

  • ${model.title}, arbetsflödesmodellens titel

  • ${model.id}, arbetsflödesmodellens ID

  • ${model.version}, arbetsflödesmodellens version

  • ${payload.data}, nyttolasten

  • ${payload.type}, nyttolasttypen

  • ${payload.path}, nyttolastens sökväg

  • ${host.prefix}, värdprefix, till exempel: http://localhost:4502

Lägga till en e-postmall för ett nytt språk adding-an-email-template-for-a-new-language

Lägga till en mall för ett nytt språk:

  1. Lägg till en fil i CRXDE <language-code>.txt nedan:

    • /libs/settings/notification-templates/com.day.cq.wcm.core.page : för sidmeddelanden
    • /libs/settings/workflow/notification/email/default : för arbetsflödesmeddelanden
  2. Anpassa filen till språket.

  3. Spara ändringarna.

NOTE
The <language-code> som används som filnamn för e-postmallen måste vara en språkkod med två bokstäver och gemener som känns igen av AEM. För språkkoder använder AEM ISO-639-1.

Konfigurera e-postmeddelanden från AEM Assets assetsconfig

När samlingar i AEM Assets delas eller inte delas kan användare få e-postmeddelanden från AEM. Följ de här stegen för att konfigurera e-postmeddelanden.

  1. Konfigurera e-posttjänsten enligt beskrivningen ovan i Konfigurera e-posttjänsten.
  2. Logga in AEM som administratör. Klicka verktyg > Operationer > Webbkonsol för att öppna Konfiguration av webbkonsol.
  3. Redigera Day CQ DAM Resource Collection Service. Välj skicka e-post. Klicka Spara.

Konfigurera OAuth setting-up-oauth

AEM erbjuder OAuth2-stöd för den integrerade Mailer-tjänsten, så att organisationer kan följa e-postkraven.

Du kan konfigurera OAuth för flera e-postleverantörer enligt instruktionerna nedan.

NOTE
Den här proceduren är ett exempel för en Publish-instans. Om du vill aktivera e-postmeddelanden för en författarinstans måste du följa samma steg i författaren.

Gmail gmail

  1. Skapa ditt projekt på https://console.developers.google.com/projectcreate

  2. Välj ditt projekt och gå sedan till API:er och tjänster - Kontrollpanel - autentiseringsuppgifter

  3. Konfigurera OAuth-godkännandeskärmen enligt dina krav

  4. Lägg till följande två omfång på uppdateringsskärmen:

    • https://mail.google.com/
    • https://www.googleapis.com//auth/gmail.send
  5. När du har lagt till omfattningarna går du tillbaka till Referenser i den vänstra menyn och sedan gå till Skapa autentiseringsuppgifter - OAuth-klient-ID - Skrivbordsapp

  6. Ett nytt fönster öppnas med klient-ID och Klienthemlighet.

  7. Spara dessa autentiseringsuppgifter.

Konfigurationer på AEM

NOTE
Adobe Managed Service-kunder kan samarbeta med sin kundtjänsttekniker för att göra dessa ändringar i produktionsmiljöerna.

Konfigurera först e-posttjänsten:

  1. Öppna AEM webbkonsol genom att gå till http://serveraddress:serverport/system/console/configMgr

  2. Leta efter och klicka sedan på Dagens CQ-tjänst för e-post

  3. Lägg till följande inställningar:

    • Värdnamn för SMTP-server: smtp.gmail.com
    • SMTP-serverport: 25 eller 587, beroende på kraven
    • Markera kryssrutorna för SMPT använder StarTLS och SMTP kräver StarTLS
    • Kontrollera OAuth-flöde och klicka Spara.

Konfigurera sedan SMTP OAuth-providern genom att följa proceduren nedan:

  1. Öppna AEM webbkonsol genom att gå till http://serveraddress:serverport/system/console/configMgr

  2. Leta efter och klicka sedan på CQ Mailer SMTP OAuth2-provider

  3. Fyll i den obligatoriska informationen enligt följande:

    • Autentiserings-URL: https://accounts.google.com/o/oauth2/auth
    • Token-URL: https://accounts.google.com/o/oauth2/token
    • Omfång: https://www.googleapis.com/auth/gmail.send och https://mail.google.com/. Du kan lägga till mer än ett omfång genom att trycka på + till höger om varje konfigurerat scope.
    • Klient-ID och klienthemlighet: konfigurera dessa fält med de värden som du hämtade enligt beskrivningen i stycket ovan.
    • Uppdatera token-URL: https://accounts.google.com/o/oauth2/token
    • Uppdateringstoken förfaller: aldrig
  4. Klicka Spara.

När inställningarna har konfigurerats bör de se ut så här:

Konfigurationsfönstret för CQ Mailer SMTP Oauth2-providern

Aktivera nu OAuth-komponenterna. Du kan göra detta genom att:

  1. Gå till komponentkonsolen genom att gå till den här URL http://serveraddress:serverport/system/console/components

  2. Leta efter följande komponenter

    • com.day.cq.mailer.oauth.servlets.handler.OAuthCodeGenerateServlet
    • com.day.cq.mailer.oauth.servlets.handler.OAuthCodeAccessTokenGenerator
  3. Tryck på ikonen Spela upp till vänster om komponenterna

    Lista över komponenter som visar OAuthCodeGenerateServlet och OAuthCodeAccessTokenGenerator

Bekräfta slutligen konfigurationen genom att:

  1. Gå till adressen för Publish-instansen och logga in som administratör.
  2. Öppna en ny flik i webbläsaren och gå till http://serveraddress:serverport/services/mailer/oauth2/authorize. Detta dirigerar om dig till sidan för din SMTP-leverantör, i det här fallet Gmail.
  3. Logga in och godkänn att ge nödvändiga behörigheter
  4. När du har gett ditt medgivande lagras denna token i databasen. Du kan komma åt den under accessToken genom direktåtkomst till denna URL på din publiceringsinstans: http://serveraddress:serverport/crx/de/index.jsp#/conf/global/settings/mailer/oauth
  5. Upprepa ovanstående för varje publiceringsinstans

Microsoft Outlook microsoft-outlook

  1. Gå till https://portal.azure.com/ och logga in.

  2. Sök efter Azure Active Directory i sökfältet och klicka på resultatet. Du kan även bläddra direkt till https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/Overview

  3. Klicka på Appregistrering - Ny registrering

    Den nya registreringsknappen när du konfigurerar Microsoft Outlook

  4. Fyll i informationen enligt dina krav och klicka sedan Registrera

  5. Gå till den nya appen och välj API-behörigheter

  6. Gå till Lägg till behörighet - Diagrambehörighet - Delegerade behörigheter

  7. Välj behörigheter nedan för din app och klicka sedan på Lägg till behörighet:

    • SMTP.Send
    • Mail.Read
    • Mail.Send
    • openid
    • offline_access
  8. Gå till Autentisering - Lägg till en plattform - Webb och i Omdirigerings-URL lägger du till följande URL för omdirigering av OAuth-koden och trycker sedan på Konfigurera:

    • http://localhost:4503/services/mailer/oauth2/token
  9. Upprepa ovanstående för varje publiceringsinstans

  10. Konfigurera inställningarna enligt dina krav

  11. Nästa, gå till Certifikat och hemligheter, klicka Ny klienthemlighet och följ stegen på skärmen för att skapa en hemlighet. Observera denna hemlighet för senare bruk

  12. Tryck Ökning i den vänstra rutan och kopiera värdena för Program-ID (klient) och Katalog-ID (klientorganisation) för senare användning

För att kunna göra en sammanfattning måste du ha följande information för att konfigurera OAuth2 för tjänsten Mailer på AEM sida:

  • Autentiserings-URL, som skapas med klientorganisations-ID. Den kommer att ha följande formulär: https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/authorize
  • Token URL, som skapas med klient-ID. Den kommer att ha följande formulär: https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/token
  • Uppdaterings-URL:en som skapas med klient-ID:t. Den kommer att ha följande formulär: https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/token
  • Klient-ID
  • Klienthemlighet

Konfigurationer på AEM

Integrera sedan dina OAuth2-inställningar med AEM:

  1. Gå till webbkonsolen för den lokala instansen genom att gå till http://serveraddress:serverport/system/console/configMgr

  2. Leta efter och klicka Dagens CQ-tjänst för e-post

  3. Lägg till följande inställningar:

    • Värdnamn för SMTP-server: smtp.office365.com
    • SMTP-användare: ditt användarnamn i e-postformat
    • "Från"-adress: Den e-postadress som ska användas i fältet "Från:" i meddelanden som skickas av e-postavsändaren
    • SMTP-serverport: 25 eller 587 beroende på kraven
    • Markera kryssrutorna för SMPT använder StarTLS och SMTP kräver StarTLS
    • Kontrollera OAuth-flöde och klicka Spara.
  4. Leta efter och klicka sedan på CQ Mailer SMTP OAuth2-provider

  5. Fyll i den obligatoriska informationen enligt följande:

    • Fyll i auktoriserings-URL:en, token-URL:en och uppdatera token-URL:en genom att skapa dem enligt beskrivningen på slutet av detta förfarande

    • Klient-ID och klienthemlighet: konfigurera dessa fält med de värden som du hämtade enligt beskrivningen ovan.

    • Lägg till följande scope i konfigurationen:

      • open
      • offline_access
      • https://outlook.office365.com/Mail.Send
      • https://outlook.office365.com/Mail.Read
      • https://outlook.office365.com/SMTP.Send
    • Omdirigerings-URL för AuthCode: http://localhost:4503/services/mailer/oauth2/token

    • Uppdatera token-URL: detta ska ha samma värde som token-URL:en ovan

  6. Klicka Spara.

När inställningarna har konfigurerats bör de se ut så här:

Den färdiga SMTP OAuth2-konfigurationen för CQ Mailer

Aktivera nu OAuth-komponenterna. Du kan göra detta genom att:

  1. Gå till komponentkonsolen genom att gå till den här URL http://serveraddress:serverport/system/console/components

  2. Leta efter följande komponenter

    • com.day.cq.mailer.oauth.servlets.handler.OAuthCodeGenerateServlet
    • com.day.cq.mailer.oauth.servlets.handler.OAuthCodeAccessTokenGenerator
  3. Tryck på ikonen Spela upp till vänster om komponenterna

Ett kodstycke för komponentlistan som innehåller OAuthCodeGenerateServlet och OAuthCodeAccessTokenGenerator

Bekräfta slutligen konfigurationen genom att:

  1. Gå till adressen för Publish-instansen och logga in som administratör.
  2. Öppna en ny flik i webbläsaren och gå till http://serveraddress:serverport/services/mailer/oauth2/authorize. Detta dirigerar om dig till sidan för din SMTP-leverantör, i det här fallet Outlook.
  3. Logga in och godkänn att ge nödvändiga behörigheter
  4. När du har gett ditt medgivande lagras denna token i databasen. Du kan komma åt den under accessToken genom direktåtkomst till denna URL på din publiceringsinstans: http://serveraddress:serverport/crx/de/index.jsp#/conf/global/settings/mailer/oauth
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2