EmailPayload.Builder (Java Client 9.4.2 API)

java.lang.Object
- com.urbanairship.api.push.model.notification.email.EmailPayload.Builder

Enclosing class:: EmailPayload

public static class EmailPayload.Builder
extends Object

EmailPayload Builder.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`EmailPayload.Builder`	`addAttachment(Attachment attachment)` Add an Attachment objects, each containing an id string which represents an email attachment.
`EmailPayload`	`build()`
`EmailPayload.Builder`	`setClickTracking(Boolean clickTracking)` Optional, True by default.
`EmailPayload.Builder`	`setDeviceType(DeviceType deviceType)` Deprecated. This method is not needed since DeviceType.EMAIL is always returned from EmailPayload.
`EmailPayload.Builder`	`setHtmlBody(String htmlBody)` Optional, a string representing the HTML body of the notification.
`EmailPayload.Builder`	`setMessageType(MessageType value)` Optional, an enum representing the possible message types of the notification.
`EmailPayload.Builder`	`setOpenTracking(Boolean openTracking)` Optional, True by default.
`EmailPayload.Builder`	`setPlaintextBody(String plaintextBody)` Optional, a string representing the plaintext body of the notification.
`EmailPayload.Builder`	`setReplyTo(String replyTo)` Optional, a string representing the reply-to address.
`EmailPayload.Builder`	`setSenderAddress(String senderAddress)` Optional, a string representing the sender address.
`EmailPayload.Builder`	`setSenderName(String senderName)` Optional, a string representing the sender name.
`EmailPayload.Builder`	`setSubject(String subject)` Optional, a string representing the subject of the notification.
`EmailPayload.Builder`	`setTemplate(EmailTemplate emailTemplate)` Add an emailTemplate objects.
`EmailPayload.Builder`	`setUaAddress(String uaAddress)` Optional, a string representing the reserved UA email address for Create and Send.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setSubject
```
public EmailPayload.Builder setSubject(String subject)
```
    Optional, a string representing the subject of the notification.
    
    Parameters:
    
    subject - Optional String
    
    Returns:
    
    EmailPayload Builder
  - setHtmlBody
```
public EmailPayload.Builder setHtmlBody(String htmlBody)
```
    Optional, a string representing the HTML body of the notification.
    
    Parameters:
    
    htmlBody - Optional String
    
    Returns:
    
    EmailPayload Builder
  - setPlaintextBody
```
public EmailPayload.Builder setPlaintextBody(String plaintextBody)
```
    Optional, a string representing the plaintext body of the notification.
    
    Parameters:
    
    plaintextBody - Optional String
    
    Returns:
    
    EmailPayload Builder
  - setMessageType
```
public EmailPayload.Builder setMessageType(MessageType value)
```
    Optional, an enum representing the possible message types of the notification.
    
    Parameters:
    
    value - Optional Map of Strings
    
    Returns:
    
    EmailPayload Builder
  - setSenderAddress
```
public EmailPayload.Builder setSenderAddress(String senderAddress)
```
    Optional, a string representing the sender address.
    
    Parameters:
    
    senderAddress - Optional String
    
    Returns:
    
    EmailPayload Builder
  - setUaAddress
```
public EmailPayload.Builder setUaAddress(String uaAddress)
```
    Optional, a string representing the reserved UA email address for Create and Send.
    
    Parameters:
    
    uaAddress - Optional String
    
    Returns:
    
    EmailPayload Builder
  - setReplyTo
```
public EmailPayload.Builder setReplyTo(String replyTo)
```
    Optional, a string representing the reply-to address.
    
    Parameters:
    
    replyTo - Optional String
    
    Returns:
    
    EmailPayload Builder
  - setSenderName
```
public EmailPayload.Builder setSenderName(String senderName)
```
    Optional, a string representing the sender name.
    
    Parameters:
    
    senderName - Optional String Must be set up by Urban Airship before use.
    
    Returns:
    
    EmailPayload Builder
  - setDeviceType
```
@Deprecated
public EmailPayload.Builder setDeviceType(DeviceType deviceType)
```
    Deprecated. This method is not needed since DeviceType.EMAIL is always returned from EmailPayload.
    
    Set the device type for the email channel payload.
    
    Parameters:
    
    deviceType - DeviceType
    
    Returns:
    
    EmailPayload Builder
  - addAttachment
```
public EmailPayload.Builder addAttachment(Attachment attachment)
```
    Add an Attachment objects, each containing an id string which represents an email attachment.
    
    Parameters:
    
    attachment - Attachment
    
    Returns:
    
    EmailPayload Builder
  - setTemplate
```
public EmailPayload.Builder setTemplate(EmailTemplate emailTemplate)
```
    Add an emailTemplate objects.
    
    Parameters:
    
    emailTemplate - EmailTemplate
    
    Returns:
    
    EmailPayload Builder
  - setClickTracking
```
public EmailPayload.Builder setClickTracking(Boolean clickTracking)
```
    Optional, True by default. Set to false to prevent click tracking for GDPR compliance.
    
    Parameters:
    
    clickTracking - Boolean
    
    Returns:
    
    CreateAndSendEmailPayload Builder
  - setOpenTracking
```
public EmailPayload.Builder setOpenTracking(Boolean openTracking)
```
    Optional, True by default. Set to false to prevent “open” tracking for GDPR compliance.
    
    Parameters:
    
    openTracking - Boolean
    
    Returns:
    
    CreateAndSendEmailPayload Builder
  - build
```
public EmailPayload build()
```

Class EmailPayload.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setSubject

setHtmlBody

setPlaintextBody

setMessageType

setSenderAddress

setUaAddress

setReplyTo

setSenderName

setDeviceType

addAttachment

setTemplate

setClickTracking

setOpenTracking

build