Package com.inductiveautomation.ignition.gateway.mail

Class EmailMessage.Builder

java.lang.Object

com.inductiveautomation.ignition.gateway.mail.EmailMessage.Builder

Enclosing class:

EmailMessage

public static class EmailMessage.Builder
extends java.lang.Object

Builder which provides a fluent-API style of creating new EmailMessage instances.

Method Summary

Modifier and Type	Method	Description
EmailMessage	build()
EmailMessage.Builder	setAttachData(java.util.List<java.lang.String> attachData)
EmailMessage.Builder	setAttachNames(java.util.List<java.lang.String> attachNames)
EmailMessage.Builder	setBccRecipients(java.util.List<java.lang.String> bccRecipients)
EmailMessage.Builder	setBody(java.lang.String body)
EmailMessage.Builder	setCcRecipients(java.util.List<java.lang.String> ccRecipients)
EmailMessage.Builder	setContentType(java.lang.String contentType)
EmailMessage.Builder	setFrom(java.lang.String from)
EmailMessage.Builder	setPriority(java.lang.String priority)
EmailMessage.Builder	setReplyTo(java.util.List<java.lang.String> replyTo)
EmailMessage.Builder	setRetries(java.lang.Integer retries)
EmailMessage.Builder	setSubject(java.lang.String subject)
EmailMessage.Builder	setTimeout(java.lang.Integer timeout)
EmailMessage.Builder	setToRecipients(java.util.List<java.lang.String> toRecipients)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setFrom

public EmailMessage.Builder setFrom(java.lang.String from)

setSubject

public EmailMessage.Builder setSubject(java.lang.String subject)

setBody

public EmailMessage.Builder setBody(java.lang.String body)

setContentType

public EmailMessage.Builder setContentType(java.lang.String contentType)

setReplyTo

public EmailMessage.Builder setReplyTo(java.util.List<java.lang.String> replyTo)

setToRecipients

public EmailMessage.Builder setToRecipients(java.util.List<java.lang.String> toRecipients)

setCcRecipients

public EmailMessage.Builder setCcRecipients(java.util.List<java.lang.String> ccRecipients)

setBccRecipients

public EmailMessage.Builder setBccRecipients(java.util.List<java.lang.String> bccRecipients)

setAttachNames

public EmailMessage.Builder setAttachNames(java.util.List<java.lang.String> attachNames)

setAttachData

public EmailMessage.Builder setAttachData(java.util.List<java.lang.String> attachData)

setTimeout

public EmailMessage.Builder setTimeout(java.lang.Integer timeout)

setRetries

public EmailMessage.Builder setRetries(java.lang.Integer retries)

setPriority

public EmailMessage.Builder setPriority(java.lang.String priority)

build

public EmailMessage build()

Returns:

a new EmailMessage instance injected with the properties set on this EmailMessage.Builder instance. it is highly recommended to provide values for properties "to", "contentType", and "toRecipients" before building the new email message instance. while it is allowed to build new email messages without these properties, most email profile types will reject any request to send email messages without these properties.