MBAPI Element Index
MBAPI Intro → MBAPI Command Index → GetEmailTemplateGroups

GetEmailTemplateGroups

Description

This class will get the email template groups with the associated options. Tempalte groups are groups of localized email templates that will be used for the same purpose as indicated by the emailActionID. An example of this would be a group that contains localized versions of the admin daily summary email. Options include the action it is associated with. Many actions, such as Package Info, can have several groups associated with them.

Attributes

Example Request

	<mbapi>
		<command><!-- string --></command>
		<subCommand><!-- string --></subCommand>
		<showXMLHeader><!-- boolean --></showXMLHeader>
		<params>
			<emailTplGroupID><!-- int --></emailTplGroupID>
			<emailTplGroupName><!-- string --></emailTplGroupName>
			<emailActionID><!-- int --></emailActionID>
			<emailTplGroupFromName><!-- string --></emailTplGroupFromName>
			<emailTplGroupFromAddress><!-- string --></emailTplGroupFromAddress>
			<emailTplGroupReplyName><!-- string --></emailTplGroupReplyName>
			<emailTplGroupReplyAddress><!-- string --></emailTplGroupReplyAddress>
			<emailTplCCAddress><!-- string --></emailTplCCAddress>
			<emailTplBCCAddress><!-- string --></emailTplBCCAddress>
			<getEmailTemplates><!-- int --></getEmailTemplates>
		</params>
	</mbapi>

Example Response

None

Request Elements

mbapi
Type
None
Description
None
Children
command
Type
string
Description

Required. The string SetEmailTemplateGroups.

subCommand
Type
string
Description

Required. insert update or delete.

showXMLHeader
Type
boolean
Description

Whether to show an XML header in the results.

params
Type
group
Description

SetEmailTemplateGroups parameters.

Children
emailTplGroupID
Type
int
Description

Email tempalte group ID

emailTplGroupName
Type
string
Description

The name of the template group. This is used to select amoung the differnet groups in parts of the system, so they should be unique.

emailActionID
Type
int
Description

Email action ID. This is the action that the group is associated with. The list of actions is maintained in include/config/internal/emailactions.php

emailTplGroupFromName
Type
string
Description

The name associated with the From: address.

emailTplGroupFromAddress
Type
string
Description

The From: address that will be used for sending out emails based on templates from this group.

emailTplGroupReplyName
Type
string
Description

The name associated with the Reply-To: address.

emailTplGroupReplyAddress
Type
string
Description

The Reply-To: address that will be used for sending out emails based on templates from this group.

emailTplCCAddress
Type
string
Description

The CC: address that will be used for sending out emails based on templates from this group. This can be a comma-seperated list of addresses.

emailTplBCCAddress
Type
string
Description

The BCC: address that will be used for sending out emails based on templates from this group. This can be a comma-seperated list of addresses.

getEmailTemplates
Type
int
Description

Return the email templates associated with the template group.

  • 1: Return only the locale info

Response Elements

None