• 홈
• EmailTemplate

PHP 클래스 EmailTemplate, vanilla

파일 보기 프로젝트 열기: vanilla/vanilla 1 사용 예제들

보호된 프로퍼티들

프로퍼티	타입	설명
$backgroundColor		The hex color code of the background, must include the leading '#'.
$button		An array representing a button with the following keys: 'url' => The href value of the button. 'text' => The button text. 'textColor' => The hex color code of the button text, must include the leading '#'. 'backgroundColor' => The hex color code of the button background, must include the leading '#'.
$containerBackgroundColor		The hex color code of the container background, must include the leading '#'.
$defaultButtonBackgroundColor		The default hex color code of the button background, must include the leading '#'.
$defaultButtonTextColor		The default hex color code of the button text, must include the leading '#'.
$footer		An array representing a footer with the following keys: 'text' => The HTML-formatted footer text. 'textColor' => The hex color code of the footer text, must include the leading '#'. 'backgroundColor' => The hex color code of the footer background, must include the leading '#'.
$image		An array representing an image with the following keys: 'source' => The image source url. 'link' => The href value of the image wrapper. 'alt' => The alt value of the image tag.
$lead		The HTML formatted email lead (sub-title, appears under title).
$message		The HTML formatted email message (the body of the email).
$plaintext		Whether to render in plaintext.
$textColor		The hex color code of the text, must include the leading '#'.
$title		The HTML formatted email title.
$view		The path to the email view.

공개 메소드들

메소드	설명
__construct ( string $message = '', string $title = '', string $lead = '', string $view = 'email-basic' )
getBackgroundColor ( ) : string
getContainerBackgroundColor ( ) : string
getDefaultButtonBackgroundColor ( ) : string
getDefaultButtonTextColor ( ) : string
getDefaultEmailImage ( ) : array	Retrieves default values for the email image.
getFooter ( ) : string
getImage ( ) : array
getLead ( ) : string
getMessage ( ) : string
getTextColor ( ) : string
getTitle ( ) : string
isPlaintext ( ) : boolean
removeButton ( ) : EmailTemplate	Remove the button.
setBackgroundColor ( string $color ) : EmailTemplate
setButton ( string $url, string $text, string $textColor = '', string $backgroundColor = '' ) : EmailTemplate	Set the button property.
setContainerBackgroundColor ( string $color ) : EmailTemplate
setDefaultButtonBackgroundColor ( string $color ) : EmailTemplate	Sets the default color for the button background.
setDefaultButtonTextColor ( string $color ) : EmailTemplate	Sets the default color for the button text.
setFooter ( string $text, string $textColor = '', string $backgroundColor = '' ) : EmailTemplate	Sets the footer. The footer background and text colors default to the button background and text colors.
setImage ( string $sourceUrl = '', string $linkUrl = '', string $alt = '' ) : EmailTemplate	Set the image property.
setImageArray ( $image ) : EmailTemplate	Set the image property using an array with the following keys: 'source' => The image source url.
setLead ( string $lead ) : EmailTemplate
setMessage ( string $message, boolean $convertNewlines = false, boolean $filter = false ) : EmailTemplate
setPlaintext ( boolean $plainText )
setTextColor ( string $color ) : EmailTemplate
setTitle ( string $title ) : EmailTemplate
setView ( string $view, string $controllerName = 'email', string $applicationFolder = 'dashboard' ) : EmailTemplate
toString ( ) : string	Render the email.

보호된 메소드들

메소드	설명
formatContent ( string $html, boolean $convertNewlines = false, boolean $filter = false ) : string	Filters an unsafe HTML string and returns it.
objectToArray ( EmailTemplate $email ) : array	Copies the email object to an array. A simple (array) typecast won't work, since the properties are protected and as such, add unwanted information to the array keys.
plainTextEmail ( ) : string	Renders a plaintext email.
setDefaultEmailImage ( )	Sets the default image for the email template.

메소드 상세

프로퍼티 상세