com.urbanairship.api.createandsend.model.notification.email

Class CreateAndSendEmailPayload

java.lang.Object

com.urbanairship.api.common.model.APIModelObject

com.urbanairship.api.push.model.PushModelObject

com.urbanairship.api.createandsend.model.notification.email.CreateAndSendEmailPayload

All Implemented Interfaces:

DevicePayloadOverride

public class CreateAndSendEmailPayload
extends PushModelObject
implements DevicePayloadOverride

Represents the payload to be used for registering or updating an email channel.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateAndSendEmailPayload.Builder CreateAndSendEmailPayload Builder.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.util.Optional<java.lang.String>	getAlert() Optional, override the alert value provided at the top level, if any.
java.util.Optional<<any>>	getAttachments() Optional, Get the Attachment objects, each containing an id string which represents an email attachment.
java.util.Optional<java.lang.Boolean>	getBypassOptInLevel() Optional, a boolean toggle you can set when message_type is set to transactional to send a business critical email.
java.util.Optional<java.lang.Boolean>	getClickTracking() Optional, Get the clickTracking value.
DeviceType	getDeviceType() Returns Devicetype: Email when requested
java.util.Optional<EmailTemplate>	getEmailTemplate() Get the email template, Using a template enables you to provide and populate variables in your notification
java.util.Optional<java.lang.String>	getHtmlBody() Optional, a string value for providing a the HTML body of the notification.
java.util.Optional<MessageType>	getMessageType() Optional, an enum of potential values representing the possible message types.
java.util.Optional<java.lang.Boolean>	getOpenTracking() Optional, Get the openTracking value.
java.util.Optional<java.lang.String>	getPlaintextBody() Optional, a string value for providing a the plaintext Body of the notification.
java.util.Optional<java.lang.String>	getReplyTo() Optional, a string representing the "reply to" address of the notification.
java.util.Optional<java.lang.String>	getSenderAddress() Optional, a string representing the address of the sender.
java.util.Optional<java.lang.String>	getSenderName() Optional, a string representing the name of the sender.
java.util.Optional<java.lang.String>	getSubject() Optional, a string representing the subject of the notification.
int	hashCode()
static CreateAndSendEmailPayload.Builder	newBuilder()
java.lang.String	toString()

Methods inherited from class com.urbanairship.api.push.model.PushModelObject

toJSON

Methods inherited from class com.urbanairship.api.common.model.APIModelObject

toJSON

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public static CreateAndSendEmailPayload.Builder newBuilder()

getDeviceType

public DeviceType getDeviceType()

Returns Devicetype: Email when requested

Specified by:

getDeviceType in interface DevicePayloadOverride

Returns:

String email

getEmailTemplate

public java.util.Optional<EmailTemplate> getEmailTemplate()

Get the email template, Using a template enables you to provide and populate variables in your notification

Returns:

Optional, EmailTemplate

getAlert

public java.util.Optional<java.lang.String> getAlert()

Optional, override the alert value provided at the top level, if any.

Specified by:

getAlert in interface DevicePayloadOverride

Returns:

Optional String alert.

getSubject

public java.util.Optional<java.lang.String> getSubject()

Optional, a string representing the subject of the notification.

Returns:

Optional String subject.

getHtmlBody

public java.util.Optional<java.lang.String> getHtmlBody()

Optional, a string value for providing a the HTML body of the notification.

Returns:

Optional String htmlBody

getPlaintextBody

public java.util.Optional<java.lang.String> getPlaintextBody()

Optional, a string value for providing a the plaintext Body of the notification.

Returns:

Optional String plaintextBody

getMessageType

public java.util.Optional<MessageType> getMessageType()

Optional, an enum of potential values representing the possible message types.

Returns:

Optional enum messageType.

getSenderName

public java.util.Optional<java.lang.String> getSenderName()

Optional, a string representing the name of the sender.

Returns:

Optional String senderName.

getSenderAddress

public java.util.Optional<java.lang.String> getSenderAddress()

Optional, a string representing the address of the sender.

Returns:

Optional String senderAddress.

getReplyTo

public java.util.Optional<java.lang.String> getReplyTo()

Optional, a string representing the "reply to" address of the notification.

Returns:

Optional String replyTo.

getBypassOptInLevel

public java.util.Optional<java.lang.Boolean> getBypassOptInLevel()

Optional, a boolean toggle you can set when message_type is set to transactional to send a business critical email. If true, the message will be sent to your entire audience, ignoring transactional_opted_out status.

Returns:

Optional Boolean bypassOptInLevel

getAttachments

public java.util.Optional<<any>> getAttachments()

Optional, Get the Attachment objects, each containing an id string which represents an email attachment.

Returns:

Optional ImmutableList attachments

getClickTracking

public java.util.Optional<java.lang.Boolean> getClickTracking()

Optional, Get the clickTracking value.

Returns:

Optional Boolean clickTracking

getOpenTracking

public java.util.Optional<java.lang.Boolean> getOpenTracking()

Optional, Get the openTracking value.

Returns:

Optional Boolean openTracking

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object