Package com.inductiveautomation.ignition.gateway.mail

Interface EmailProfileType<S>

All Superinterfaces:

Comparable<ExtensionPoint<S>>, ExtensionPoint<S>

All Known Implementing Classes:

AbstractEmailProfileExtensionPoint

public interface EmailProfileType<S>
extends ExtensionPoint<S>

Represents a type of email profile

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EmailProfileType.FactoryContext	Encapsulates the contextual information required for an email profile type to create new email profile instances.

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.gateway.config.ExtensionPoint

ExtensionPoint.ComponentType

Field Summary

Fields inherited from interface com.inductiveautomation.ignition.gateway.config.ExtensionPoint

PROFILE_KEY, SETTINGS_KEY

Method Summary

Modifier and Type	Method	Description
EmailProfile.Lifecycle	createNewProfile(EmailProfileType.FactoryContext context)	Factory method for creating new EmailProfile instances of this type.

Methods inherited from interface com.inductiveautomation.ignition.gateway.config.ExtensionPoint

canCreate, compareTo, decode, defaultSettings, description, encode, getMenuActions, getReferenceProperties, getSettings, getSettingsValidator, getWebUiComponent, name, resourceType, settingsSchema, settingsType, typeId

Method Details

createNewProfile

EmailProfile.Lifecycle createNewProfile(EmailProfileType.FactoryContext context)
                                 throws Exception

Factory method for creating new EmailProfile instances of this type.

Parameters:

context - a EmailProfileType.FactoryContext instance which exposes the contextual information necessary for any email profile type to be instantiated

Returns:

a new EmailProfile.Lifecycle instance that has not yet been started

Throws:

Exception - if there was an unexpected problem creating a new email profile instance of this type