MBAPI Element Index
MBAPI Intro → MBAPI Command Index → GetEmailTemplates

GetEmailTemplates

Description

This class is an instantion of the Command class, that executes a command pertaining to fetching email template information, in the default case from the database. This class should only be instantiated by dispatchMBAPI() found in include/mbapi/mbapi.php. Remember when passing in an email body that it should have

Attributes

package
modernbill
subpackage
mbapi
version
0.9
author
Mark Garrett

Example Request

	<mbapi>
		<command><!-- string --></command>
		<showXMLHeader><!-- boolean --></showXMLHeader>
		<params>
			<emailTplID><!-- None --></emailTplID>
			<emailTplName><!-- string --></emailTplName>
			<emailTplSubject><!-- string --></emailTplSubject>
			<emailTplPrimary><!-- int --></emailTplPrimary>
			<emailTplBody><!-- string --></emailTplBody>
			<emailTplTextBody><!-- string --></emailTplTextBody>
			<localeLanguage><!-- string --></localeLanguage>
			<localeRegion><!-- string --></localeRegion>
			<sortDir><!-- None --></sortDir>
			<sortColumn><!-- None --></sortColumn>
			<recordOffset><!-- None --></recordOffset>
			<numRecords><!-- None --></numRecords>
		</params>
	</mbapi>

Example Response

None

Request Elements

mbapi
Type
group
Description

MBAPI request document root.

Children
command
Type
string
Description

Required. The string GetEmailTemplates.

showXMLHeader
Type
boolean
Description

Whether to show an XML header in the results.

params
Type
group
Description

GetEmailTemplates parameters.

Children
emailTplID
Type
None
Description
None
emailTplName
Type
string
Description

The name of the template to fetch. This is searched on using a LIKE clause.

emailTplSubject
Type
string
Description

The subject of the template to fetch. This is searched on using a LIKE clause.

emailTplPrimary
Type
int
Description

Indicates that this template is the default template for the template group. If there are no template matches based on locale, this template is used.

emailTplBody
Type
string
Description

The HTML body of the template to fetch. See note above about the use of HTML in an XML call.

emailTplTextBody
Type
string
Description

The text-only body of the template to fetch.

localeLanguage
Type
string
Description

The langauge of the template to fetch. This can include the optional ISO 15924 script code if applicable.

localeRegion
Type
string
Description

The optional ISO 639 or UN M.49 code for the country or region this template is designed for.

sortDir
Type
None
Description
None
sortColumn
Type
None
Description
None
recordOffset
Type
None
Description
None
numRecords
Type
None
Description
None

Response Elements

None