Volanie e-mailového systému cez PHP

Cieľ tutoriálu

Upozornenie: Tento návod je určený pre vývojárov a ukazuje, ako je možné integrovaný e-mailový systém bluetronix CMS volať priamo pomocou PHP.

bluetronix CMS poskytuje centrálnu PHP funkciu pre odosielanie e-mailov.

Týmto sa vyhnete potrebe znova programovať SMTP pripojenia, e-mailové účty a základné funkcie odosielania pre každý vlastný PHP skript.

Pre priamy odosielanie e-mailov a newsletterov je k dispozícii nasledujúca funkcia:

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

Pre odosielanie formulárových e-mailov je k dispozícii ďalšia funkcia:

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

BlueSMTPMail()

S pomocou BlueSMTPMail() môžete odosielať bežné e-maily a newslettery prostredníctvom centrálného e-mailového systému bluetronix CMS.

Volanie funkcie je:

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

$MailType

Určuje, aký typ e-mailu sa má odoslať.

Možné hodnoty:

Mail
Newsletter

Príklad:

$MailType = "Mail";

alebo:

$MailType = "Newsletter";

$MailAccount

$MailAccount určuje e-mailový účet, ktorého SMTP nastavenia sa použijú.

Pomocou tejto hodnoty sa načítajú príslušné SMTP konfiguračné údaje z databázových tabuliek CMS.

Aká konfigurácia sa použije, závisí aj od $SMTPType.

$SMTPType

Určuje, či sa použije interný alebo externý e-mailový účet.

Možné hodnoty:

Intern
Extern

Interný

Pri:

$SMTPType = "Intern";

sa použije e-mailový účet, ktorý bol priamo nastavený v bluetronix CMS.

Účty sa nachádzajú pod:

Email → Accounts

E-mailová adresa odosielateľa použitá v $From musí byť tam ako účet.

Externý

Pri:

$SMTPType = "Extern";

sa používajú externé SMTP prístupové údaje.

Tieto sú spravované v CMS pod:

Email → Server - Extern

E-mailová adresa odosielateľa použitá v $From musí byť tam správne nastavená.

Odosielateľská adresa použitá v $From musí byť tam nastavená.

$From

Obsahuje e-mailovú adresu odosielateľa.

Príklad:

$From = "info@example.com";

E-mailová adresa musí zodpovedať zvolenej konfigurácii SMTP.

$To

Obsahuje e-mailovú adresu príjemcu bežného e-mailu.

Príklad:

$To = "customer@example.com";

Pri bežnom zasielaní e-mailov sa táto premenná použije ako príjemca.

$NewsletterTo

$NewsletterTo sa používa pri zasielaní newsletterov.

Premenná obsahuje viacero e-mailových adries ako text. Každá e-mailová adresa je oddelená novým riadkom.

Príklad:

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

$Subject

Obsahuje predmet e-mailu.

Príklad:

$Subject = "Welcome to our website";

$TextContent

Obsahuje čistý textový obsah e-mailu.

Táto časť môže byť napríklad použitá e-mailovými programami, ktoré nezobrazujú HTML e-maily.

Príklad:

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

$HTMLContent

Obsahuje HTML časť e-mailu.

Príklad:

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

Pomocou nej je možné posielať formátované e-maily so záhlaviami, textom, odkazmi, obrázkami a ďalšími HTML elementmi.

$Attachments

S $Attachments je možné pripojiť súbory k e-mailu.

Súbory sú uvedené cez ich cestu v rámci webovej stránky.

Príklad:

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

Pri viacerých prílohách sú jednotlivé cesty k súborom oddelené novým riadkom.

Príklad:

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

$EmbedImages

S $EmbedImages sa môže určiť, či sa majú obrázky vložiť priamo do e-mailu.

Príklad:

$EmbedImages = "ja";

Pri aktivovanej možnosti sú obrázky použité v HTML e-maile priamo integrované do e-mailu a nie sú načítané výhradne cez externé URL.

To umožňuje, aby boli obrázky priamo k dispozícii príjemcovi v rámci e-mailu bez potreby ich samostatného načítania z webového servera.

$MailPlaceholderReplacement

S $MailPlaceholderReplacement je možné nahradiť zástupné symboly v:

$TextContent
$HTMLContent

individuálnymi hodnotami.

Princip je:

Search
   ↓
Replace

Týmto spôsobom je možné vytvárať personalizovaný obsah v rámci e-mailu.

Typické možnosti použitia sú:

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

$FormEntry

S $FormEntry sa môže určiť, či má byť zasielanie uložené aj v archíve formulárov.

Pri:

$FormEntry = "JA";

bude tiež pridaný záznam do databázovej tabuľky:

00_form

uložené.

Týmto môže byť odoslanie zároveň zdokumentované ako formulárový alebo archívny záznam.

Príklad: Odoslanie bežného e-mailu

Nasledujúci príklad odosiela bežný HTML a textový e-mail cez interný e-mailový účet.

$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);

Jednoduchý postup je nasledovný:

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

Príklad: Odoslanie newsletteru

Pre newsletter sa nastaví $MailType na:

Newsletter

.

Prijímatelia sa následne predávajú cez $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);

Jednotliví prijímatelia newsletteru sú oddelení novými riadkami v rámci $NewsletterTo.

Použitie externého SMTP pripojenia

Ak sa má použiť externý e-mailový server, nastaví sa:

$SMTPType = "Extern";

.

Prístupové údaje SMTP musia byť najprv nastavené na:

Email → Server - Extern

.

Príklad:

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

BlueFormSend()

Okrem priameho odosielania e-mailov je k dispozícii funkcia:

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

.

Táto funkcia je špeciálne určená na odosielanie e-mailov v súvislosti s formulármi CMS.

Premenné sú už úplne v anglickom písaní.

Parametre funkcie BlueFormSend()

MailCache

Každé volanie BlueSMTPMail() vytvorí ďalší záznam v databázovej tabuľke:

00_MailCache

Pomocou tejto tabuľky môže byť kontrolovaný stav odosielania e-mailov.

Tam môže byť napríklad overené, či bol e-mail úspešne spracovaný alebo odoslaný.

Záznamy MailCache sú pre:

1 Woche

uložené.

Typický priebeh odosielania e-mailu

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

Prehľad parametrov BlueSMTPMail

Zusammenfassung

Centrálny e-mailový systém bluetronix CMS môže byť vyvolaný priamo z vlastného PHP kódu.

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

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

Pre CMS formy je navyše k dispozícii:

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

Die SMTP-Konfiguration kann entweder über:

Intern
→ Email → Účty

alebo:

Extern
→ Email → Server - Extern

erfolgen.

Každé odoslanie e-mailu je navyše sledované cez:

00_MailCache

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

Týmto spôsobom môžu vývojári používať už existujúci e-mailový systém bluetronix CMS priamo zo svojich PHP skriptov, bez nutnosti implementovať kompletnú SMTP logiku.