Package com.inductiveautomation.ignition.gateway.mail

Interface EmailProfile

All Known Subinterfaces:

EmailProfile.Lifecycle, EmailProfile.Managed, SmtpEmailProfile

public interface EmailProfile

An EmailProfile exposes methods for sending emails.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EmailProfile.Lifecycle	An EmailProfile which exposes additional methods for the Platform to drive the profile's lifecycle.
static interface	EmailProfile.Managed	An EmailProfile managed by the Platform.

Method Summary

Modifier and Type	Method	Description
default Optional<? extends SmtpEmailProfile>	getAsSmtpEmailProfile()
void	sendEmail(EmailMessage message)	Send a new email using this profile.

Method Details

sendEmail

void sendEmail(EmailMessage message)
        throws Exception

Send a new email using this profile.

Parameters:

message - the EmailMessage to send

Throws:

Exception - if there was a problem sending the email. most profile types will throw an exception if the provided message argument has an empty "from", "contentType", or "toRecipients" field values

getAsSmtpEmailProfile

default Optional<? extends SmtpEmailProfile> getAsSmtpEmailProfile()

Returns:

an Optional containing this EmailProfile as an SmtpEmailProfile if this profile supports SMTP. the returned Optional will be empty if this profile does not support SMTP.