Documentation

Email extends Base
in package

Table of Contents

Properties

$fd  : mixed

Methods

__construct()  : mixed
attachment()  : mixed
Generates an attachment in the e-mail content
blog()  : mixed
Generates a blog post preview
button()  : mixed
Generates a button in the e-mail template
comment()  : mixed
Generates a blog post preview
content()  : mixed
Generates a standard content with wrapper for e-mails
digestDate()  : mixed
Generates the date string section used in digest email
digestItem()  : mixed
Generates the digest item used in digest email
divider()  : mixed
Generates the divider section of an e-mail
getTemplate()  : mixed
Central method to generate a new theme object so that we can centralize and inject variables into the library
heading()  : mixed
Generates the heading section of an e-mail
logo()  : mixed
Generates the logo section of an e-mail
sectionHeading()  : mixed
Generates a section heading in an e-mail
spacer()  : mixed
Generates the logo section of an e-mail
unsubscribe()  : mixed
Generates the unsubscribe link in email

Properties

$fd

protected mixed $fd = null

Methods

__construct()

public __construct(mixed $fd) : mixed
Parameters
$fd : mixed

attachment()

Generates an attachment in the e-mail content

public attachment(mixed $link, mixed $title) : mixed
Parameters
$link : mixed
$title : mixed
Tags
since
1.1.2
access

public

blog()

Generates a blog post preview

public blog(mixed $title, mixed $content[, mixed $date = '' ][, mixed $authorName = '' ][, mixed $authorLink = '' ][, mixed $authorAvatar = '' ]) : mixed
Parameters
$title : mixed
$content : mixed
$date : mixed = ''
$authorName : mixed = ''
$authorLink : mixed = ''
$authorAvatar : mixed = ''
Tags
since
1.0.0
access

public

button()

Generates a button in the e-mail template

public button(mixed $text, mixed $link[, mixed $style = 'default' ]) : mixed
Parameters
$text : mixed
$link : mixed
$style : mixed = 'default'
Tags
since
1.0.0
access

public

comment()

Generates a blog post preview

public comment(mixed $comment[, mixed $date = '' ][, mixed $authorName = '' ][, mixed $authorLink = 'javascript:void(0)' ]) : mixed
Parameters
$comment : mixed
$date : mixed = ''
$authorName : mixed = ''
$authorLink : mixed = 'javascript:void(0)'
Tags
since
1.1.2
access

public

content()

Generates a standard content with wrapper for e-mails

public content(mixed $content[, mixed $style = 'clear' ][, mixed $options = [] ]) : mixed
Parameters
$content : mixed
$style : mixed = 'clear'
$options : mixed = []
Tags
since
1.0.0
access

public

digestDate()

Generates the date string section used in digest email

public digestDate([mixed $datestr = '' ]) : mixed
Parameters
$datestr : mixed = ''
Tags
since
1.0.0
access

public

digestItem()

Generates the digest item used in digest email

public digestItem(mixed $title[, mixed $content = '' ][, mixed $options = [] ]) : mixed
Parameters
$title : mixed
$content : mixed = ''
$options : mixed = []
Tags
since
1.0.0
access

public

divider()

Generates the divider section of an e-mail

public divider() : mixed
Tags
since
1.0.0
access

public

getTemplate()

Central method to generate a new theme object so that we can centralize and inject variables into the library

public getTemplate() : mixed
Tags
since
1.0.0
access

public

heading()

Generates the heading section of an e-mail

public heading(mixed $title[, mixed $subtitle = '' ]) : mixed
Parameters
$title : mixed
$subtitle : mixed = ''
Tags
since
1.0.0
access

public

Generates the logo section of an e-mail

public logo(mixed $logo) : mixed
Parameters
$logo : mixed
Tags
since
1.0.0
access

public

sectionHeading()

Generates a section heading in an e-mail

public sectionHeading(mixed $title[, mixed $subtitle = '' ]) : mixed
Parameters
$title : mixed
$subtitle : mixed = ''
Tags
since
1.0.0
access

public

spacer()

Generates the logo section of an e-mail

public spacer() : mixed
Tags
since
1.0.0
access

public

unsubscribe()

Generates the unsubscribe link in email

public unsubscribe(mixed $unsubcribeLink[, mixed $linkLabel = null ][, mixed $text = null ]) : mixed
Parameters
$unsubcribeLink : mixed
$linkLabel : mixed = null
$text : mixed = null
Tags
since
1.0.0
access

public


        
On this page

Search results