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

Class CreateAndSendEmailPayload.Builder

java.lang.Object

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

Enclosing class:

CreateAndSendEmailPayload

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

CreateAndSendEmailPayload Builder.

Method Summary

Modifier and Type	Method and Description
CreateAndSendEmailPayload.Builder	addAttachment(Attachment attachment) Add an Attachment objects, each containing an id string which represents an email attachment.
CreateAndSendEmailPayload	build()
CreateAndSendEmailPayload.Builder	setByPassOptInLevel(java.lang.Boolean byPassOptInLevel) Optional, a boolean you can set this toggle when message_type is set to transactional to send a business critical email.
CreateAndSendEmailPayload.Builder	setClickTracking(java.lang.Boolean clickTracking) Optional, True by default.
CreateAndSendEmailPayload.Builder	setEmailTemplate(EmailTemplate emailTemplate) Provide the ID or inline fields for a template.
CreateAndSendEmailPayload.Builder	setHtmlBody(java.lang.String htmlBody) Optional, a string representing the HTML body of the notification.
CreateAndSendEmailPayload.Builder	setMessageType(MessageType value) Optional, an enum representing the possible message types of the notification.
CreateAndSendEmailPayload.Builder	setOpenTracking(java.lang.Boolean openTracking) Optional, True by default.
CreateAndSendEmailPayload.Builder	setPlaintextBody(java.lang.String plaintextBody) Optional, a string representing the plaintext body of the notification.
CreateAndSendEmailPayload.Builder	setReplyTo(java.lang.String replyTo) Optional, a string representing the reply-to address.
CreateAndSendEmailPayload.Builder	setSenderAddress(java.lang.String senderAddress) Optional, a string representing the sender address.
CreateAndSendEmailPayload.Builder	setSenderName(java.lang.String senderName) Optional, a string representing the sender name.
CreateAndSendEmailPayload.Builder	setSubject(java.lang.String subject) Optional, a string representing the subject of the notification.

Methods inherited from class java.lang.Object

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

Method Detail

setSubject

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

Optional, a string representing the subject of the notification.

Parameters:

subject - Optional String

Returns:

CreateAndSendEmailPayload Builder

setByPassOptInLevel

public CreateAndSendEmailPayload.Builder setByPassOptInLevel(java.lang.Boolean byPassOptInLevel)

Optional, a boolean you can set this toggle 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.

Parameters:

byPassOptInLevel - Boolean

Returns:

CreateAndSendEmailPayload Builder

setHtmlBody

public CreateAndSendEmailPayload.Builder setHtmlBody(java.lang.String htmlBody)

Optional, a string representing the HTML body of the notification.

Parameters:

htmlBody - Optional String

Returns:

CreateAndSendEmailPayload Builder

setPlaintextBody

public CreateAndSendEmailPayload.Builder setPlaintextBody(java.lang.String plaintextBody)

Optional, a string representing the plaintext body of the notification.

Parameters:

plaintextBody - Optional String

Returns:

CreateAndSendEmailPayload Builder

setMessageType

public CreateAndSendEmailPayload.Builder setMessageType(MessageType value)

Optional, an enum representing the possible message types of the notification.

Parameters:

value - Optional Map of Strings

Returns:

CreateAndSendEmailPayload Builder

setSenderAddress

public CreateAndSendEmailPayload.Builder setSenderAddress(java.lang.String senderAddress)

Optional, a string representing the sender address.

Parameters:

senderAddress - Optional String

Returns:

CreateAndSendEmailPayload Builder

setReplyTo

public CreateAndSendEmailPayload.Builder setReplyTo(java.lang.String replyTo)

Optional, a string representing the reply-to address.

Parameters:

replyTo - Optional String

Returns:

CreateAndSendEmailPayload Builder

setSenderName

public CreateAndSendEmailPayload.Builder setSenderName(java.lang.String senderName)

Optional, a string representing the sender name.

Parameters:

senderName - Optional String Must be set up by Urban Airship before use.

Returns:

CreateAndSendEmailPayload Builder

setEmailTemplate

public CreateAndSendEmailPayload.Builder setEmailTemplate(EmailTemplate emailTemplate)

Provide the ID or inline fields for a template. Using a template enables you to provide and populate variables in your notification.

Parameters:

emailTemplate - EmailTemplate

Returns:

CreateAndSendEmailPayload Builder

addAttachment

public CreateAndSendEmailPayload.Builder addAttachment(Attachment attachment)

Add an Attachment objects, each containing an id string which represents an email attachment.

Parameters:

attachment - Attachment

Returns:

CreateAndSendEmailPayload Builder

setClickTracking

public CreateAndSendEmailPayload.Builder setClickTracking(java.lang.Boolean clickTracking)

Optional, True by default. Set to false to prevent click tracking for GDPR compliance.

Parameters:

clickTracking - Boolean

Returns:

CreateAndSendEmailPayload Builder

setOpenTracking

public CreateAndSendEmailPayload.Builder setOpenTracking(java.lang.Boolean openTracking)

Optional, True by default. Set to false to prevent “open” tracking for GDPR compliance.

Parameters:

openTracking - Boolean

Returns:

CreateAndSendEmailPayload Builder

build

public CreateAndSendEmailPayload build()