Anropa mail-systemet via PHP

Målet med guiden

Observera: Denna handledning riktar sig till utvecklare och visar hur det inbyggda mail-systemet i bluetronix CMS kan anropas direkt via PHP.

bluetronix CMS tillhandahåller centrala PHP-funktioner för e-postutskick.

Därmed behöver SMTP-anslutningar, mail-konton och grundläggande utskickfunktioner inte programmeras på nytt för varje eget PHP-skript.

För direkt e-post- och nyhetsbrevsutskick finns följande funktion tillgänglig:

BlueSMTPMail($MailType,$MailAccount,$SMTPType,$From,$To,$NewsletterTo,$Subject,$TextContent,$HTMLContent,$Attachments,$EmbedImages,$MailPlaceholderReplacement,$FormEntry);

För utskick av formulär-e-post finns dessutom följande funktion tillgänglig:

BlueFormSend($SMTPType,$SendMail,$SendSubject,$CopyToCustomer,$TextToCustomer,$FormArchive,$FormID,$SendTo);

BlueSMTPMail()

Med BlueSMTPMail() kan vanliga e-postmeddelanden och nyhetsbrev skickas via det centrala mail-systemet i bluetronix CMS.

Funktionsanropet lyder:

BlueSMTPMail(
   $MailType,
   $MailAccount,
   $SMTPType,
   $From,
   $To,
   $NewsletterTo,
   $Subject,
   $TextContent,
   $HTMLContent,
   $Attachments,
   $EmbedImages,
   $MailPlaceholderReplacement,
   $FormEntry
);

$MailType

Bestämmer vilken typ av e-post som ska skickas.

Möjliga värden:

Mail
Newsletter

Exempel:

$MailType = "Mail";

eller:

$MailType = "Newsletter";

$MailAccount

$MailAccount bestämmer vilket e-postkonto vars SMTP-inställningar ska användas.

Genom detta värde laddas motsvarande SMTP-konfigurationsdata från CMS-databasens tabeller.

Vilken konfiguration som används beror även på $SMTPType.

$SMTPType

Bestämmer om ett internt eller externt e-postkonto används.

Möjliga värden:

Intern
Extern

Internt

Vid:

$SMTPType = "Intern";

ett e-postkonto används som har konfigurerats direkt i bluetronix CMS.

Kontona finns under:

Email → Accounts

Den avsändaradress som används under $From måste finnas som ett konto där.

Externt

Vid:

$SMTPType = "Extern";

externa SMTP-inloggningsuppgifter används.

Dessa hanteras i CMS under:

Email → Server - Extern

.

Den avsändaradress som används under $From måste vara korrekt konfigurerad där.

$From

Innehåller avsändarens e-postadress.

Exempel:

$From = "info@example.com";

E-postadressen måste motsvara den valda SMTP-konfigurationen.

$To

Innehåller mottagarens e-postadress för ett vanligt e-postmeddelande.

Exempel:

$To = "customer@example.com";

Vid vanlig e-postleverans används denna variabel som mottagare.

$NewsletterTo

$NewsletterTo används vid utskick av nyhetsbrev.

Variabeln innehåller flera e-postadresser som text. Varje e-postadress separeras av ett radbryt.

Exempel:

$NewsletterTo = "customer1@example.com\ncustomer2@example.com\ncustomer3@example.com";

$Subject

Innehåller ämnet för e-postmeddelandet.

Exempel:

$Subject = "Welcome to our website";

$TextContent

Innehåller den rena textdelen av e-postmeddelandet.

Denna del kan till exempel användas av e-postprogram som inte visar HTML-e-post.

Exempel:

$TextContent = "Thank you for your request.";

$HTMLContent

Innehåller HTML-delen av e-postmeddelandet.

Exempel:

$HTMLContent = "<h1>Thank you</h1><p>Thank you for your request.</p>";

Detta möjliggör att formaterade e-postmeddelanden med rubriker, texter, länkar, bilder och andra HTML-element kan skickas.

$Attachments

Med $Attachments kan filer bifogas e-postmeddelandet.

Filerna anges via sökvägen inom webbplatsen.

Exempel:

$Attachments = "/bx_doc/Intro.pdf";

Vid flera bifogade filer separeras de individuella filvägarna med ett radbryt.

Exempel:

$Attachments = "/bx_doc/Intro.pdf\n/bx_doc/PriceList.pdf";

$EmbedImages

Med $EmbedImages kan det fastställas om bilder ska bäddas in direkt i e-postmeddelandet.

Exempel:

$EmbedImages = "ja";

Vid aktiverad alternativ kommer bilderna som används inom HTML-e-postmeddelandet att integreras direkt i e-postmeddelandet och inte enbart laddas via externa URL:er.

Därmed kan bilderna vara direkt tillgängliga för mottagaren inom e-postmeddelandet utan att de först måste hämtas separat från webbservern.

$MailPlaceholderReplacement

Med $MailPlaceholderReplacement kan platshållare inom:

$TextContent
$HTMLContent

ersättas med individuella värden.

Principen är följande:

Search
   ↓
Replace

Därmed kan till exempel personligt anpassat innehåll skapas inom ett e-postmeddelande.

Typiska användningsområden är:

• Name des Empfängers
• Kundennummer
• Bestellnummer
• individuelle Links
• weitere dynamische Inhalte

$FormEntry

Med $FormEntry kan det fastställas om utskicket även ska sparas i formulärarkivet.

Vid:

$FormEntry = "JA";

sparas dessutom en post i databastabellen:

00_form

sparas.

Detta gör att leveransen kan dokumenteras som en formulär- eller arkivpost.

Exempel: Skicka vanlig e-post

Följande exempel skickar ett vanligt HTML- och text-e-postmeddelande via ett internt e-postkonto.

$MailType                  = "Mail";
$MailAccount               = "info@example.com";
$SMTPType                  = "Intern";
$From                      = "info@example.com";
$To                        = "customer@example.com";
$NewsletterTo              = "";
$Subject                   = "Your request";
$TextContent               = "Thank you for your request.";
$HTMLContent               = "<h1>Thank you</h1><p>Thank you for your request.</p>";
$Attachments               = "/bx_doc/Intro.pdf";
$EmbedImages               = "ja";
$MailPlaceholderReplacement = "";
$FormEntry                 = "NEIN";

BlueSMTPMail($MailType,$MailAccount,$SMTPType,$From,$To,$NewsletterTo,$Subject,$TextContent,$HTMLContent,$Attachments,$EmbedImages,$MailPlaceholderReplacement,$FormEntry);

Förenklat ser proceduren ut så här:

PHP
   ↓
BlueSMTPMail()
   ↓
internen Mail-Account laden
   ↓
SMTP-Verbindung verwenden
   ↓
E-Mail erzeugen
   ↓
E-Mail versenden
   ↓
MailCache-Eintrag erzeugen

Exempel: Skicka nyhetsbrev

För ett nyhetsbrev ställs $MailType in på:

Newsletter

anges.

Mottagarna överlämnas sedan via $NewsletterTo.

$MailType                  = "Newsletter";
$MailAccount               = "newsletter@example.com";
$SMTPType                  = "Intern";
$From                      = "newsletter@example.com";
$To                        = "";
$NewsletterTo              = "customer1@example.com\ncustomer2@example.com\ncustomer3@example.com";
$Subject                   = "Our latest news";
$TextContent               = "Discover our latest news and products.";
$HTMLContent               = "<h1>Our latest news</h1><p>Discover our latest news and products.</p>";
$Attachments               = "";
$EmbedImages               = "ja";
$MailPlaceholderReplacement = "";
$FormEntry                 = "NEIN";

BlueSMTPMail($MailType,$MailAccount,$SMTPType,$From,$To,$NewsletterTo,$Subject,$TextContent,$HTMLContent,$Attachments,$EmbedImages,$MailPlaceholderReplacement,$FormEntry);

De enskilda nyhetsbrevmottagarna separeras inom $NewsletterTo med radbrytningar.

Använd extern SMTP-anslutning

Om en extern e-postserver ska användas, ställs:

$SMTPType = "Extern";

anges.

SMTP-inloggningsuppgifterna måste tidigare ha konfigurerats under:

Email → Server - Extern

vara inställda.

Exempel:

$SMTPType    = "Extern";
$From        = "mail@external-domain.com";
$MailAccount = "mail@external-domain.com";

BlueFormSend()

Utöver den direkta e-postleveransen finns funktionen:

BlueFormSend($SMTPType,$SendMail,$SendSubject,$CopyToCustomer,$TextToCustomer,$FormArchive,$FormID,$SendTo);

tillgänglig.

Denna funktion är speciellt avsedd för e-postleverans i samband med CMS-formulär.

Variablerna är redan helt skrivna på engelska.

Parametrar för BlueFormSend()

MailCache

Varje anrop av BlueSMTPMail() skapar dessutom en post i databasens tabell:

00_MailCache

Genom denna tabell kan statusen för e-postsändningen kontrolleras.

Där kan man exempelvis kontrollera om en e-post har behandlats eller skickats framgångsrikt.

MailCache-posterna används för:

1 Woche

sparas.

Typisk process för e-postutsändning

PHP-Skript
   ↓
BlueSMTPMail()
   ↓
MailType prüfen
   ↓
MailAccount auswählen
   ↓
SMTPType prüfen
   ↓
SMTP-Konfiguration laden
   ↓
Empfänger bestimmen
   ↓
Text- und HTML-Inhalt erstellen
   ↓
Platzhalter ersetzen
   ↓
Anhänge hinzufügen
   ↓
Bilder gegebenenfalls einbetten
   ↓
E-Mail versenden
   ↓
00_MailCache aktualisieren
   ↓
optional 00_form speichern

Översikt över BlueSMTPMail-parametrar

Zusammenfassung

Det centrala e-postsystemet i bluetronix CMS kan anropas direkt från egen PHP-kod.

Für normalen E-Mail- und Newsletter-Versand wird verwendet:

BlueSMTPMail($MailType,$MailAccount,$SMTPType,$From,$To,$NewsletterTo,$Subject,$TextContent,$HTMLContent,$Attachments,$EmbedImages,$MailPlaceholderReplacement,$FormEntry);

För CMS-formulär finns dessutom tillgängligt:

BlueFormSend($SMTPType,$SendMail,$SendSubject,$CopyToCustomer,$TextToCustomer,$FormArchive,$FormID,$SendTo);

Die SMTP-Konfiguration kann entweder über:

Intern
→ E-post → Konton

eller:

Extern
→ Email → Server - Extern

erfolgen.

Varje e-postutskick registreras dessutom via:

00_MailCache

protokolliert. Die entsprechenden Cache-Einträge bleiben eine Woche erhalten.

Detta gör det möjligt för utvecklare att använda det befintliga e-postsystemet i bluetronix CMS direkt från sina egna PHP-skript, utan att behöva implementera hela SMTP-logiken själva.