Amazon SES - account aanmaken en configuratie voor verzendintegratie

Doel van het document

Dit document beschrijft hoe u een AWS-account en de Amazon SES-service voorbereidt, zodat de verzendintegratie met de modules van dit project kan worden uitgevoerd.

De handleiding omvat:

• het aanmaken van een AWS-account,
• het starten van Amazon SES,
• verificatie van domein en afzender,
• overgang uit de sandbox,
• voorbereiding van credentials,
• twee varianten voor integratie met Magento:
  • via Amazon SES API,
  • via Amazon SES SMTP.

Belangrijke opmerking voor dit project

In de projectcode zijn twee integratiepaden met Amazon SES beschikbaar:

1. SES API in Kowal_EmailTransport met transporttype ses.
2. SES SMTP in Kowal_EmailSmtp met transporttype smtp.

Dit betekent dat het AWS- en SES-account het beste één keer wordt voorbereid, maar dat de uiteindelijke manier van koppeling met Magento afhangt van de gekozen implementatievariant.

Uitgangspunten

Bereid vóór de start het volgende voor:

• het domein van waaruit berichten worden verzonden, bijvoorbeeld example.com,
• toegang tot de DNS van dit domein,
• het afzenderadres, bijvoorbeeld newsletter@example.com,
• een betaalkaart of actieve factureringsmethode in AWS,
• de keuze in welke regio SES gaat werken, bijvoorbeeld eu-central-1 of us-east-1.

1. AWS-account aanmaken

1. Ga naar het AWS-paneel: https://aws.amazon.com/
2. Maak een AWS-account aan.
3. Schakel MFA in voor het root-account.
4. Gebruik geen toegangssleutels van het root-account voor applicatie-integratie.

Bereid voor de Magento-integratie een aparte IAM-gebruiker of aparte SMTP-credentials voor, afhankelijk van de gekozen variant.

2. Amazon SES starten

1. Log in op AWS Console.
2. Open de service Amazon Simple Email Service.
3. Kies de regio waarin u verzending wilt uitvoeren.

Dit is belangrijk, omdat de regio in SES operationele betekenis heeft:

• afzenderidentiteiten worden per regio beheerd,
• de status sandbox/production access geldt per regio,
• de configuratiegegevens van Magento moeten naar dezelfde regio verwijzen,
• SMTP-credentials in SES zijn uniek per regio.

Als de winkel internationaal opereert, is het het beste om meteen de doelregio voor de betreffende markt of de hele organisatie vast te leggen en deze consequent aan te houden.

3. Verificatie van domein of afzenderadres

De best practice voor een winkel is verificatie van het hele domein, niet alleen van één e-mailadres.

Aanbevolen variant

Verifieer het domein, bijvoorbeeld example.com.

Daardoor:

• kunt u verzenden vanaf meerdere adressen van dit domein,
• gaat u makkelijker over naar productiegerichte verzending,
• bent u beter voorbereid op campagnes, transacties en meerdere afzenders,
• kunt u meerdere winkels, talen en merken binnen één ecosysteem makkelijker beheren.

Stappen

1. Ga in SES naar Identities.
2. Kies Create identity.
3. Kies het type Domain.
4. Voer het verzenddomein in.
5. Schakel Easy DKIM in als u geen reden hebt om eigen DKIM-sleutels te gebruiken.
6. Voeg de door AWS aangegeven DNS-records toe aan uw DNS-zone.
7. Wacht op de status Verified.

Minimale DNS-scope

In de praktijk hebt u minimaal nodig:

• SES-verificatierecords,
• DKIM-records,
• optioneel een record voor custom MAIL FROM.

4. Uit de SES-sandbox gaan

Een nieuw SES-account werkt meestal aanvankelijk in de sandbox.

Dit betekent onder meer dat:

• u alleen vanaf geverifieerde identiteiten kunt verzenden,
• ontvangers ook geverifieerd moeten zijn,
• u geen normale productieverzending naar winkelklanten kunt uitvoeren.

Stappen

1. Open in SES Account dashboard of het startscherm van de configuratie.
2. Kies de optie Request production access.
3. Vul het formulier in volgens het doel van het systeem:
   • transactional,
   • marketing,
   • newsletter,
   • e-commerce communications.
4. Beschrijf dat de verzending wordt uitgevoerd vanuit uw eigen Magento voor een webwinkel.
5. Verstuur de aanvraag.

Het is goed om vóór het indienen van de aanvraag het domein al geverifieerd te hebben. Dit versnelt doorgaans de acceptatie.

5. Deliverability configureren

Dit is niet het verplichte minimum voor de eerste test, maar wordt sterk aanbevolen vóór productie.

DKIM

Als u Easy DKIM gebruikt, ondertekent SES berichten automatisch na correcte DNS-configuratie.

Custom MAIL FROM

Als u de controle over de technische afzender en deliverability wilt verbeteren:

1. Open het geverifieerde domein in SES.
2. Configureer Custom MAIL FROM domain, bijvoorbeeld mail.example.com.
3. Voeg toe aan DNS:
   • MX-record,
   • SPF/TXT-record voor MAIL FROM.

Dit is vooral zinvol voor winkels die regelmatig e-mailmarketing uitvoeren en problemen met de reputatie van de afzender willen beperken.

6. Variant A - integratie via Amazon SES API

Deze variant gebruikt het transporttype ses dat beschikbaar is in Kowal_EmailTransport.

Wanneer u deze variant kiest

Kies SES API als:

• u Amazon SES rechtstreeks als provider wilt gebruiken,
• u een transportaccount van het type ses wilt onderhouden,
• u berichten via Kowal_EmailTransport wilt routeren.

6.1. IAM-gebruiker voor verzending aanmaken

Gebruik het root-account niet.

Bereid een aparte IAM-gebruiker voor, bijvoorbeeld:

• magento-ses-sender

Koppel vervolgens een policy met minimale verzendrechten aan deze gebruiker.

Voorbeeld van een minimale policy

{ 'Version': '2012-10-17', 'Statement': [ { 'Effect': 'Allow', 'Action': [ 'ses:SendEmail', 'ses:SendRawEmail' ], 'Resource': '*' } ]}

Als u wilt, kunt u deze uitbreiden met het lezen van limieten of statistieken, maar voor verzending zelf is bovenstaande scope het uitgangspunt.

6.2. Access Key en Secret Key aanmaken

1. Open IAM.
2. Ga naar Users.
3. Open de voorbereide gebruiker.
4. Ga naar het tabblad Security credentials.
5. Kies in de sectie Access keys Create access key.
6. Sla op:
   • Access Key ID
   • Secret Access Key

U ziet het geheim slechts één keer. Als u het kwijtraakt, moet u een nieuwe sleutel aanmaken.

6.3. Gegevens die nodig zijn voor Magento voor de API-variant

Bereid voor het transportaccount ses in Magento het volgende voor:

• provider_region, bijvoorbeeld eu-central-1,
• provider_api_key,
• provider_api_secret,
• sender_name,
• sender_email,
• reply_to_email optioneel,
• store_id, als het account alleen voor een specifieke store view moet werken.

6.4. Mapping naar het Magento-paneel

In Kowal / Email Marketing:

1. Voeg een nieuw transportaccount toe.
2. Stel in:
   • Transport Type = Amazon SES,
   • Region = SES-regio,
   • Access Key = IAM-sleutel,
   • Secret Key = IAM-geheim.
3. Sla het account op.
4. Koppel het account aan berichtrouting.
5. Voer een testverzending uit vanuit het transportaccount.

7. Variant B - integratie via Amazon SES SMTP

Deze variant gebruikt Kowal_EmailSmtp.

Wanneer u deze variant kiest

Kies SES SMTP als:

• u Amazon SES als SMTP-bron wilt implementeren,
• u het pakket Advance Email Delivery gebruikt,
• u een eenvoudiger integratiemodel aan Magento-zijde wilt behouden.

7.1. SMTP-credentials in SES aanmaken

1. Open Amazon SES.
2. Ga naar SMTP settings.
3. Kies Create SMTP credentials.
4. AWS begeleidt u door het aanmaken van een IAM-gebruiker voor SMTP.
5. Sla op:
   • SMTP username
   • SMTP password

Dit zijn geen gewone AWS-sleutels. Dit zijn aparte SMTP-credentials voor SES.

7.2. SMTP-endpoint

Gebruik voor SES een host in het formaat:

email-smtp..amazonaws.com

Voorbeeld:

email-smtp.eu-central-1.amazonaws.com

7.3. Poort en versleuteling

Meest gebruikte instellingen:

• poort 587 + STARTTLS,
• of poort 465 + TLS Wrapper / SSL.

In de praktijk is voor Magento het veiligste startpunt:

• host: email-smtp..amazonaws.com
• poort: 587
• security: STARTTLS

7.4. Gegevens die nodig zijn voor Magento voor de SMTP-variant

Bereid voor:

• SMTP-host,
• poort,
• type versleuteling,
• SMTP-login,
• SMTP-wachtwoord,
• afzenderadres dat overeenkomt met verified identity in SES.

7.5. Mapping naar het Magento-paneel

In Kowal / Email Marketing:

1. Stel in de sectie smtp globaal in:
   • enabled = Yes,
   • host = SES-endpoint,
   • port = 587,
   • username = SMTP username,
   • password = SMTP password,
   • connection_security = STARTTLS,
   • test_recipient_email = adres voor de test.
2. Sla de configuratie op.
3. Voer Send Test Email uit.

Als u meerdere accounts of meerdere store views gebruikt, kunt u ook een apart transportaccount van het type smtp configureren met specifieke verbindingsgegevens.

8. Wat kiest u in dit project

Kies SES API als:

• u transportaccounts ses wilt gebruiken,
• u verzending per account en provider wilt routeren,
• u transport wilt ontwikkelen zonder alles op de SMTP-laag te baseren.

Kies SES SMTP als:

• u waarde hecht aan een snellere eerste implementatie,
• u SES als externe SMTP-server wilt behandelen,
• u vooral een delivery-pakket implementeert dat is gebaseerd op Kowal_EmailSmtp.

9. Minimale checklist vóór de verzendtest

Bevestig vóór de eerste test:

1. Het AWS-account bestaat en heeft actieve facturering.
2. De SES-regio is gekozen.
3. Het domein of afzenderadres heeft de status Verified.
4. Het SES-account heeft production access of u test alleen onder sandbox-voorwaarden.
5. DKIM is geconfigureerd.
6. Magento heeft correcte afzendergegevens.
7. De integratievariant is gekozen:
   • API,
   • of SMTP.
8. Credentials zijn veilig opgeslagen.
9. Er is een test verzonden en de aflevering van het bericht is bevestigd.

10. Meest voorkomende fouten

Het account staat nog in de sandbox

Symptoom:

• het bericht wordt niet naar normale ontvangers verzonden.

Oorzaak:

• geen production access.

Het domein is niet geverifieerd

Symptoom:

• afzenderfout of afwijzing van verzending.

Oorzaak:

• geen verified identity voor het domein of afzenderadres.

Verkeerde regio

Symptoom:

• gegevens lijken correct, maar verzending werkt nog steeds niet.

Oorzaak:

• de identiteit is geverifieerd in een andere regio dan de regio die door de integratie wordt gebruikt.

API-sleutels verwarren met SMTP-credentials

Symptoom:

• SMTP-login werkt niet.

Oorzaak:

• IAM-sleutels zijn ingevoerd voor SMTP in plaats van SMTP username en SMTP password.

Gebruik van het root-account

Symptoom:

• geen beveiligingsscheiding en moeilijkere rotatie van credentials.

Oorzaak:

• integratie gebaseerd op root-gegevens in plaats van een aparte IAM-gebruiker of aparte SMTP-credentials.

11. Links naar officiële AWS-documentatie

• Set up your SES account: https://docs.aws.amazon.com/ses/latest/dg/setting-up.html
• Creating and verifying identities: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html
• Verified identities: https://docs.aws.amazon.com/ses/latest/dg/verify-addresses-and-domains.html
• Request production access: https://docs.aws.amazon.com/ses/latest/dg/request-production-access.html
• SMTP credentials: https://docs.aws.amazon.com/ses/latest/dg/smtp-credentials.html
• SMTP endpoint connection: https://docs.aws.amazon.com/ses/latest/dg/smtp-connect.html
• Custom MAIL FROM: https://docs.aws.amazon.com/ses/latest/dg/mail-from.html
• SES regions: https://docs.aws.amazon.com/ses/latest/dg/regions.html
• SES credentials overview: https://docs.aws.amazon.com/ses/latest/dg/send-email-concepts-credentials.html
• IAM access keys: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html

12. Gegevens die voor de implementatie moeten worden doorgegeven

Aan het einde moet de persoon die SES aanmaakt precies deze set doorgeven voor de implementatie:

Voor de SES API-variant

• SES-regio,
• verified domain,
• access key,
• secret key,
• afzenderadres,
• reply-to, als dit anders moet zijn,
• informatie of het account globaal of per store view moet werken.

Voor de SES SMTP-variant

• SES-regio,
• SMTP-host,
• poort,
• security mode,
• SMTP username,
• SMTP password,
• afzenderadres,
• testadres voor verificatie.

Advanced Newsletter Suite voor Magento 2 - installatie- en configuratiehandleiding

Doel van het document

Dit document beschrijft de installatie en configuratie van het pakket magento-2-package-advanced-newsletter-suite. Het is een volledig nieuwsbrief- en e-mailmarketingpakket voor Magento 2, dat ontvangers, capture, campagnes, content, verzending, tracking, een operationeel paneel en frontend-inschrijvingspunten omvat.

Vereisten

Bereid vóór de implementatie het volgende voor:

• Magento Open Source 2.4.x,
• Composer,
• CLI-toegang tot bin/magento,
• een Magento-beheerdersaccount,
• SMTP-toegangsgegevens,
• geconfigureerde Magento-cron,
• gereedheid om queue consumers te starten,
• een testomgeving om inschrijving, campagnes en verzendingen te controleren.

Wat het pakket installeert

Het pakket omvat:

• Kowal_MarketingCore,
• Kowal_EmailTransport,
• Kowal_EmailSmtp,
• Kowal_EmailEvents,
• Kowal_EmailTemplateStudio,
• Kowal_NewsletterAudience,
• Kowal_NewsletterCapture,
• Kowal_NewsletterCampaigns,
• Kowal_NewsletterConsole,
• Kowal_NewsletterFrontend.

Dit is het hoogste aggregatieniveau binnen het ecosysteem van e-mailmarketingmodules voor Magento.

Installatie

1. Installatie van het Composer-pakket

De toegangsgegevens voor de Composer-repository, het e-mailadres van de klant en de licentietoken, ontvangt u per e-mail na aankoop. Ze zijn ook beschikbaar in het klantenpaneel nadat u bent ingelogd op kowal.store. Vervang TWOJ_EMAIL_KLIENTA door het e-mailadres van uw account en TWOJ_TOKEN door de ontvangen token. Voer de opdrachten uit in de hoofdmap van Magento.

composer config repositories.kowal composer https://repo.kowal.storecomposer config http-basic.repo.kowal.store 'TWOJ_EMAIL_KLIENTA' 'TWOJ_TOKEN'composer require kowal/package-advanced-newsletter-suite

2. Activering van modules in Magento

bin/magento module:enable \ Kowal_MarketingCore \ Kowal_EmailTransport \ Kowal_EmailSmtp \ Kowal_EmailEvents \ Kowal_EmailTemplateStudio \ Kowal_NewsletterAudience \ Kowal_NewsletterCapture \ Kowal_NewsletterCampaigns \ Kowal_NewsletterConsole \ Kowal_NewsletterFrontendbin/magento setup:upgradebin/magento cache:flush

Voer in productiemodus aanvullend uit:

bin/magento setup:di:compilebin/magento setup:static-content:deploy -f

Configuratie

1. Beheersectie

De basisconfiguratie zou beschikbaar moeten zijn in:

Kowal / Email Marketing

Volgens de specificatie zijn de verwachte instellingengroepen:

• general,
• transport,
• smtp,
• campaigns,
• double_opt_in,
• events.

2. Verzendconfiguratie

Configureer eerst de basis voor delivery:

• activiteit van de module,
• standaard transporttype,
• logging van verzendingen,
• SMTP-account of -accounts,
• berichtrouting,
• fallback voor reserveaccounts, indien gebruikt.

De implementatie van het volledige pakket vereist nog steeds een werkende SMTP- en transportlaag.

3. Configuratie van ontvangers en inschrijvingen

Bevestig vervolgens de configuratie van de ontvangerslaag:

• integratie met newsletter_subscriber,
• mailinglijsten,
• segmenten,
• abonnementsstatussen,
• aanvullende metadata van de abonnee,
• wervingsbronnen,
• marketingtoestemmingen.

Configureer ook het inschrijfproces:

• formulieren en inschrijvingspunten,
• double opt-in,
• template voor het bevestigingsbericht,
• geldigheidsduur van de bevestigingstoken.

4. Campagneconfiguratie

Stel in de sectie campaigns het volgende in:

• batch_size,
• max_retry_count,
• send_rate_limit_per_run,
• watchdog_timeout_minutes.

Het pakket ondersteunt:

• campagnedefinitie,
• planning,
• ontvangerswachtrij,
• batchverwerking van verzending,
• uitvoeringsgeschiedenis van campagnes,
• testverzendingen.

5. Configuratie van Template Studio

Als de implementatie werken met nieuwsbriefcontent omvat, configureer dan EmailTemplateStudio volgens de MVP-scope:

• werken op native nieuwsbriefsjablonen van Magento,
• selectie van productlayouts,
• opslaan van de gegenereerde sectie in een native template,
• import van kant-en-klare content naar de campagne.

6. Configuratie van e-mailevents

Configureer in de sectie events:

• eventverwerking,
• retentie van payloads,
• beleid voor het accepteren van dubbele events van providers.

De laag EmailEvents is verantwoordelijk voor de observeerbaarheid van het afleverproces en het koppelen van events aan transportlogs en campagnes.

7. Configuratie van het beheerpaneel en de frontend

Het volledige pakket omvat:

• Kowal_NewsletterConsole als operationeel paneel,
• Kowal_NewsletterFrontend als laag voor frontend-inschrijfformulieren en widgets.

Controleer na installatie:

• beschikbaarheid van het dashboard,
• snelkoppelingen naar configuratie en operationele modules,
• weergave van recente fouten en verzendingen,
• aanwezigheid van inschrijfformulieren op de frontend van de winkel.

Cron en queue consumers

Het volledige pakket vereist werkende asynchrone verwerking.

1. Magento-cron

bin/magento cron:install

Cron moet verantwoordelijk zijn voor:

• campagneplanning,
• herstel van taken,
• operationele watchdog.

2. Queue consumers

Queue consumers moeten verantwoordelijk zijn voor de daadwerkelijke verwerking van verzendbatches. De namen van consumers moeten worden opgehaald uit de actuele bestanden etc/queue_consumer.xml van de geïmplementeerde modules.

Zorg in de productieomgeving voor:

• het op de achtergrond uitvoeren van consumers,
• autostart na herstart van de server,
• monitoring van storingen,
• logging van fouten.

Stappen na installatie

Voer na de implementatie de volledige checklist uit:

1. Configureer en test het SMTP-account.
2. Controleer de berichtrouting.
3. Controleer de inschrijving van abonnees en double opt-in.
4. Bevestig de compatibiliteit met de native Magento-nieuwsbrief.
5. Maak een testlijst of testsegment aan.
6. Bereid een testcampagne voor.
7. Voer een test send uit.
8. Controleer campagneplanning via cron.
9. Controleer de verwerking van de wachtrij door consumers.
10. Bevestig het opslaan van logs en e-mailevents.
11. Controleer het beheerdashboard.
12. Controleer frontend-formulieren en inschrijvingswidgets.

Acceptatietest na implementatie

Het pakket is correct geïmplementeerd als:

• de modules correct worden geïnstalleerd in Magento 2.4.x,
• SMTP-verzending werkt vanuit accounts en routing,
• inschrijving van abonnees compatibel blijft met de native Magento-nieuwsbrief,
• de campagne wordt gepland door cron en verwerkt door queue consumer,
• afleverstatussen logs en e-mailevents bijwerken,
• het beheerpaneel basis operationele gegevens toont,
• frontend-inschrijvingspunten correct werken,
• na het uitschakelen van de modules het basismechanisme Magento_Newsletter nog steeds kan werken.

Implementatieopmerkingen

• Het volledige pakket is het beste te implementeren samen met een gecontroleerde SMTP- en trackingconfiguratie.
• Uitbreidende gegevens moeten in eigen tabellen worden opgeslagen, zonder de native tabel newsletter_subscriber te dupliceren.
• De operationele documentatie van de implementatie moet daarnaast een procedure bevatten voor het afhandelen van wachtrijen, webhooks en regressietests van de beheerconfiguratie.