ilMailTemplateServiceInterface Interface Reference

Inheritance diagram for ilMailTemplateServiceInterface:

Collaboration diagram for ilMailTemplateServiceInterface:

Public Member Functions
	createNewTemplate (string $context_id, string $title, string $subject, string $message, string $language)
	modifyExistingTemplate (int $template_id, string $context_id, string $title, string $subject, string $message, string $language)
	loadTemplateForId (int $template_id)
	loadTemplatesForContextId (string $context_id)
	deleteTemplatesByIds (array $template_ids)
	listAllTemplatesAsArray ()
	unsetAsContextDefault (ilMailTemplate $template)
	setAsContextDefault (ilMailTemplate $template)

Detailed Description

Definition at line 24 of file interface.ilMailTemplateServiceInterface.php.

Member Function Documentation

createNewTemplate()

ilMailTemplateServiceInterface::createNewTemplate	(	string	$context_id,
		string	$title,
		string	$subject,
		string	$message,
		string	$language
	)

Implemented in ilMailTemplateService.

deleteTemplatesByIds()

ilMailTemplateServiceInterface::deleteTemplatesByIds

(

array

$template_ids

)

Parameters

list<int>

$template_ids

Implemented in ilMailTemplateService.

listAllTemplatesAsArray()

ilMailTemplateServiceInterface::listAllTemplatesAsArray

(

)

Returns

list<array<string, mixed>>

Implemented in ilMailTemplateService.

loadTemplateForId()

ilMailTemplateServiceInterface::loadTemplateForId

(

int

$template_id

)

Implemented in ilMailTemplateService.

loadTemplatesForContextId()

ilMailTemplateServiceInterface::loadTemplatesForContextId

(

string

$context_id

)

Returns

list<ilMailTemplate>

Implemented in ilMailTemplateService.

modifyExistingTemplate()

ilMailTemplateServiceInterface::modifyExistingTemplate	(	int	$template_id,
		string	$context_id,
		string	$title,
		string	$subject,
		string	$message,
		string	$language
	)

Exceptions

TemplateSubjectSyntaxException|TemplateMessageSyntaxException

Implemented in ilMailTemplateService.

setAsContextDefault()

ilMailTemplateServiceInterface::setAsContextDefault

(

ilMailTemplate

$template

)

Implemented in ilMailTemplateService.

unsetAsContextDefault()

ilMailTemplateServiceInterface::unsetAsContextDefault

(

ilMailTemplate

$template

)

Implemented in ilMailTemplateService.

---

The documentation for this interface was generated from the following file:

• components/ILIAS/Mail/interfaces/interface.ilMailTemplateServiceInterface.php