Package com.inductiveautomation.ignition.gateway.mail

Interface EmailProfileManager

All Superinterfaces:

ExtensionPointManager

public interface EmailProfileManager
extends ExtensionPointManager

Manages the configured EmailProfiles.

Method Summary

Modifier and Type	Method	Description
void	addProfileType(EmailProfileType profileType)	Add a new EmailProfileType to the system
EmailProfileType	getExtensionPoint(java.lang.String typeId)
java.util.List<? extends EmailProfileType>	getExtensionPoints()
java.util.Optional<? extends EmailProfile.Managed>	getProfile(java.lang.String name)	Get the managed email profile associated with a name
java.util.Collection<? extends EmailProfile.Managed>	getProfiles()
void	removeProfileType(java.lang.String id)	Remove an existing EmailProfileType from the system

Method Detail

getExtensionPoint

@Nullable
EmailProfileType getExtensionPoint(java.lang.String typeId)

Specified by:

getExtensionPoint in interface ExtensionPointManager

Returns:

the ExtensionPointType identified by typeId, or null if none exists for that name.

See Also:

ExtensionPointType.getTypeId()

getExtensionPoints

java.util.List<? extends EmailProfileType> getExtensionPoints()

Specified by:

getExtensionPoints in interface ExtensionPointManager

Returns:

all ExtensionPointTypes managed by this ExtensionPointManager.

addProfileType

void addProfileType(EmailProfileType profileType)
             throws java.lang.Exception

Add a new EmailProfileType to the system

Parameters:

profileType - the EmailProfileType to add

Throws:

java.lang.IllegalArgumentException - if an EmailProfileType already exists with the same ID

java.lang.Exception - if there was any other unexpected problem adding the new EmailProfileType

removeProfileType

void removeProfileType(java.lang.String id)

Remove an existing EmailProfileType from the system

Parameters:

id - the ID of an existing EmailProfileType to remove

Throws:

java.lang.IllegalArgumentException - if an EmailProfileType does not exist with the given ID, or if the ID is associated with a built-in EmailProfileType

getProfiles

java.util.Collection<? extends EmailProfile.Managed> getProfiles()

Returns:

all the email profiles managed by this manager

getProfile

java.util.Optional<? extends EmailProfile.Managed> getProfile(java.lang.String name)

Get the managed email profile associated with a name

Parameters:

name - the name of the email profile to get

Returns:

an Optional containing the managed email profile associated with the given name, or an empty Optional if no email profile is managed under the given name