Jet\Mailing_Email

Třída reprezentuje e-mail, tedy konkrétní zprávu k odeslání. Třídu lze používat samostatně, ale primárně se předpokládá její použití v rámci celého subsystému posílání e-mailů ve spolupráci s šablonami.

Přehled metod

Metoda Význam
public setSenderName(
string $sender_name
) : void		 Nastaví jméno odesílatele.
public getSenderName(
) : string		 Vrátí nastavené jméno odesílatele.
public setSenderEmail(
string $sender_email
) : void		 Nastaví e-mail odesílatele.
public getSenderEmail(
) : string		 Vrátí nastavený e-mail odesílatele.
public setTo(
array|string $to
) : void		 Nastaví příjemce, nebo několik příjemců.
public getTo(
) : array|string		 Vrátí nastavené příjemce.
public setToCopy(
array|string $to_copy
) : void		 Nastaví příjemce v kopii, nebo několik příjemců v kopii.
public getToCopy(
) : array|string		 Vrátí nastavené příjemce v kopii.
public setToHiddenCopy(
array|string $to_hidden_copy
) : void		 Nastaví příjemce ve skryté kopii, nebo několik příjemců ve skryté kopii.
public getToHiddenCopy(
) : array|string		 Vrátí nastavené příjemce ve skryté kopii.
public setSubject(
string $subject
) : void		 Nastaví předmět e-mailu
public getSubject(
) : string		 Vrátí nastavený předmět e-mailu
public setBodyTxt(
string $body_txt
) : void		 Nastaví textový obsah (prostý text) zprávy.
public getBodyTxt(
) : string		 Vrátí nastavený textový obsah (prostý text) zprávy.
public setBodyHtml(
string $body_html,
bool $parse_images=true
) : void		 Nastaví HTML obsah zprávy. Pokud je parametr $parse_images true, pak v HTML najde reference na obrázky a připraví jejich vložení přímo do zprávy.
public getBodyHtml(
) : string		 Vrátí nastavený HTML obsah zprávy.
public addAttachments(
string $file_path,
string $file_name=''
) : void		 Připojí soubor jako přílohu mailu.

Parametry:
  • $file_path
    Úplná cesta k souboru, který se má stát přílohou
  • $file_name
    Název souboru - přílohy. Volitelný parametr - pokud není určeno, tak je automaticky použit původní název souboru.
public addAttachmentsData(
string $file_name,
string $file_mime_type,
string $file_data
) : void		 Připojí přílohu mailu definovanou daty.

Parametry:
  • $file_name
    Název souboru
  • $file_mime_type
    MIME typ přílohy
  • $file_data
    Data přílohy
public getAttachments(
) : Mailing_Email_File[]		 Vrátí seznam příloh.
public addImage(
string $cid,
string $path
) : void		 Přidá obrázek, který bude součástí e-mailu.
Parametry:
  • $cid
    Zástupné ID obrázku tak jak je reprezentován v HTML (src="cid:xxxxxxx").
  • $path
    Úplná cesta k souboru obrázku.
public addImageData(
string $cid,
string $file_name,
string $file_mime_type,
string $file_data
) : void		 Přidá obrázek, který bude součástí e-mailu.
Parametry:
  • $cid
    Zástupné ID obrázku tak jak je reprezentován v HTML (src="cid:xxxxxxx").
  • $file_name
    Název souboru
  • $file_mime_type
    MIME typ přílohy
  • $file_data
    Data přílohy
public getImages(
) : Mailing_Email_File[]		 Vrací seznam obrázků zprávy.
public setCustomHeader(
string $header,
string $value
) : void		 Nastavuje volitelnou SMTP hlavičku zprávu.
Parametry:
  • $header
    Název hlavičky.
  • $value
    Hodnota hlavičky.
public getCustomHeaders(
) : array		 Vrací nastavené volitelné SMTP hlavičky zprávy ve formě asociovaného pole, kde klíčem je název hlavičky a hodnotou její hodnota.
public prepareMessage(
?string &$message,
?string &$header
) : void		 Sestaví samotný e-mail k odeslání. Tedy poskládá jeho tělo a připraví potřebné SMTP hlavičky. Obě hodnoty (tělo zprávy a hlavičku) vrací ve formě referencí.
public send(
) : bool		 Odešle daný e-mail. Ve skutečnosti se jedná o volání: Mailing::sendEmail( $this );
Předchozí kapitola
Jet\Mailing
Další kapitola
Jet\Mailing_Email_Template
GitHub