Class Mage_Core_Model_Email_Template

Template model

Example:

// Loading of template $emailTemplate = Mage::getModel('core/email_template') ->load(Mage::getStoreConfig('path_to_email_template_id_config')); $variables = array( 'someObject' => Mage::getSingleton('some_model') 'someString' => 'Some string value' ); $emailTemplate->send('some@domain.com', 'Name Of User', $variables);

Varien_Object

Mage_Core_Model_Abstract

Mage_Core_Model_Template

Mage_Core_Model_Email_Template

Direct known subclasses

Mage_Adminhtml_Model_Email_Template, Mage_Sales_Model_Email_Template

Package: Mage\Core
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Core/Model/Email/Template.php

Methods summary
`protected`	# `_construct( )` Initialize email template model Initialize email template model
`protected string`	# `_getLogoUrl( Mage_Core_Model_Store\|integer\|string $store )` Return logo URL for emails Take logo from skin if custom logo is undefined Return logo URL for emails Take logo from skin if custom logo is undefined Parameters `$store` `Mage_Core_Model_Store\|integer\|string` $store Returns `string`
`protected string`	# `_getLogoAlt( Mage_Core_Model_Store\|integer\|string $store )` Return logo alt for emails Return logo alt for emails Parameters `$store` `Mage_Core_Model_Store\|integer\|string` $store Returns `string`
`public Zend_Mail`	# `getMail( )` Retrieve mail object instance Retrieve mail object instance Returns `Zend_Mail`
`public Mage_Core_Model_Email_Template`	# `setTemplateFilter( Varien_Filter_Template $filter )` Declare template processing filter Declare template processing filter Parameters `$filter` `Varien_Filter_Template` $filter Returns `Mage_Core_Model_Email_Template`
`public Mage_Core_Model_Email_Template_Filter`	# `getTemplateFilter( )` Get filter object for template processing logi Get filter object for template processing logi Returns `Mage_Core_Model_Email_Template_Filter`
`public Mage_Core_Model_Email_Template`	# `loadByCode( string $templateCode )` Load template by code Load template by code Parameters `$templateCode` `string` $templateCode Returns `Mage_Core_Model_Email_Template`
`public`	# `loadDefault( string $templateId, string $locale = null )` Load default email template from locale translate Load default email template from locale translate Parameters `$templateId` `string` $templateId `$locale` `string` $locale
`public static array`	# `getDefaultTemplates( )` Retrive default templates from config Retrive default templates from config Returns `array`
`public static array`	# `getDefaultTemplatesAsOptionsArray( )` Retrive default templates as options array Retrive default templates as options array Returns `array`
`public mixed`	# `getId( )` Return template id return int\|null Return template id return int\|null Returns `mixed` Overrides `Mage_Core_Model_Abstract::getId()`
`public Mage_Core_Model_Abstract`	# `setId( integer $value )` Set id of template Set id of template Parameters `$value` `integer` $value Returns `Mage_Core_Model_Abstract` Overrides `Mage_Core_Model_Abstract::setId()`
`public boolean`	# `isValidForSend( )` Return true if this template can be used for sending queue as main template Return true if this template can be used for sending queue as main template Returns `boolean`
`public integer\|string`	# `getType( )` Getter for template type Getter for template type Returns `integer\|string`
`public string`	# `getProcessedTemplate( array $variables = array() )` Process email template code Process email template code Parameters `$variables` `array` $variables Returns `string`
`public string`	# `getPreparedTemplateText( )` Makes additional text preparations for HTML templates Makes additional text preparations for HTML templates Returns `string`
`public string`	# `getInclude( string $template, array $variables )` Get template code for include directive Get template code for include directive Parameters `$template` `string` $template `$variables` `array` $variables Returns `string`
`public boolean`	# `send( array\|string $email, array\|string\|null $name = null, array $variables = array() )` Send mail to recipient Send mail to recipient Parameters `$email` `array\|string` $email E-mail(s) `$name` `array\|string\|null` $name receiver name(s) `$variables` `array` $variables template variables Returns `boolean`
`public Mage_Core_Model_Email_Template`	# `sendTransactional( integer $templateId, string\|array $sender, string $email, string $name, array $vars = array(), integer\|null $storeId = null )` Send transactional email to recipient Send transactional email to recipient Parameters `$templateId` `integer` $templateId `$sender` `string\|array` $sender sneder informatio, can be declared as part of config path `$email` `string` $email recipient email `$name` `string` $name recipient name `$vars` `array` $vars varianles which can be used in template `$storeId` `integer\|null` $storeId Returns `Mage_Core_Model_Email_Template`
`public string`	# `getProcessedTemplateSubject( array $variables )` Process email subject Process email subject Parameters `$variables` `array` $variables Returns `string`
`public`	# `addBcc( mixed $bcc )`
`public Mage_Core_Model_Email_Template`	# `setReturnPath( string $email )` Set Return Path Set Return Path Parameters `$email` `string` $email Returns `Mage_Core_Model_Email_Template`
`public Mage_Core_Model_Email_Template`	# `setReplyTo( string $email )` Add Reply-To header Add Reply-To header Parameters `$email` `string` $email Returns `Mage_Core_Model_Email_Template`
`protected array`	# `_parseVariablesString( string $variablesString )` Parse variables string into array of variables Parse variables string into array of variables Parameters `$variablesString` `string` $variablesString Returns `array`
`public array`	# `getVariablesOptionArray( boolean $withGroup = false )` Retrieve option array of variables Retrieve option array of variables Parameters `$withGroup` `boolean` $withGroup if true wrap variable options in group Returns `array`
`protected Mage_Core_Model_Email_Template`	# `_beforeSave( )` Validate email template code Validate email template code Returns `Mage_Core_Model_Email_Template` Overrides `Mage_Core_Model_Abstract::_beforeSave()`

Methods inherited from Mage_Core_Model_Template
`_applyDesignConfig(), _cancelDesignConfig(), emulateDesign(), getDesignConfig(), isPlain(), revertDesign(), setDesignConfig()`

Methods inherited from Mage_Core_Model_Abstract
`_afterDelete(), _afterDeleteCommit(), _afterLoad(), _afterSave(), _beforeDelete(), _beforeLoad(), _clearData(), _clearReferences(), _getEventData(), _getResource(), _hasModelChanged(), _init(), _protectFromNonAdmin(), _setResourceModel(), afterCommitCallback(), afterLoad(), cleanModelCache(), clearInstance(), delete(), getCacheIdTags(), getCacheTags(), getCollection(), getEntityId(), getIdFieldName(), getResource(), getResourceCollection(), getResourceName(), isObjectNew(), load(), save()`

Constants summary
`string`	`XML_PATH_TEMPLATE_EMAIL`	`'global/template/email'`	# Configuration path for default email templates Configuration path for default email templates
`string`	`XML_PATH_SENDING_SET_RETURN_PATH`	`'system/smtp/set_return_path'`	#
`string`	`XML_PATH_SENDING_RETURN_PATH_EMAIL`	`'system/smtp/return_path_email'`	#
`string`	`XML_PATH_DESIGN_EMAIL_LOGO`	`'design/email/logo'`	#
`string`	`XML_PATH_DESIGN_EMAIL_LOGO_ALT`	`'design/email/logo_alt'`	#

Constants inherited from Mage_Core_Model_Template
`DEFAULT_DESIGN_AREA, TYPE_HTML, TYPE_TEXT`

Properties summary
`protected mixed`	`$_templateFilter`		#
`protected boolean`	`$_preprocessFlag`	`false`	#
`protected mixed`	`$_mail`		#
`protected static mixed`	`$_defaultTemplates`		#

Properties inherited from Mage_Core_Model_Template
`$_designConfig, $_emulatedDesignConfig, $_initialEnvironmentInfo`

Properties inherited from Mage_Core_Model_Abstract
`$_cacheTag, $_dataSaveAllowed, $_eventObject, $_eventPrefix, $_isObjectNew, $_resource, $_resourceCollectionName, $_resourceName`

Packages

Classes

Exceptions

Functions

Class Mage_Core_Model_Email_Template

Direct known subclasses

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Overrides

Parameters

Returns

Overrides

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Overrides