com.smartsheet.api.models

Class RowEmail.AddRowEmailBuilder

java.lang.Object

com.smartsheet.api.models.RowEmail.AddRowEmailBuilder

Enclosing class:

RowEmail

public static class RowEmail.AddRowEmailBuilder
extends Object

A convenience class to help create a RowEmail object with the appropriate fields.

Constructor Summary

Constructors

Constructor and Description
AddRowEmailBuilder()

Method Summary

Modifier and Type	Method and Description
RowEmail	build() Builds the row email.
Boolean	getCcMe() Gets the carbon copy me flag.
Boolean	getIncludeAttachments() Gets the flag that indicates if attachments should be included in the email.
Boolean	getIncludeDiscussions() Gets the flag that indicates if discussions should be included in the email.
String	getLayout() Gets a string containing the layout.
String	getMessage() Gets the message.
List<Recipient>	getSendTo() Gets the list of recipients to send to
String	getSubject() Gets the subject.
RowEmail.AddRowEmailBuilder	setCcMe(Boolean ccMe) Sets the carbon copy me flag.
RowEmail.AddRowEmailBuilder	setIncludeAttachments(Boolean includeAttachments) Sets the flag that indicates if attachments should be included in the email.
RowEmail.AddRowEmailBuilder	setIncludeDiscussions(Boolean includeDiscussions) Sets the flag that indicates if discussions should be included in the email.
RowEmail.AddRowEmailBuilder	setLayout(String layout) Sets the layout string
RowEmail.AddRowEmailBuilder	setMessage(String message) Sets the message.
RowEmail.AddRowEmailBuilder	setSendTo(List<Recipient> sendTo) Sets the list of recipients to send to
RowEmail.AddRowEmailBuilder	setSubject(String subject) Sets the subject.

Methods inherited from class java.lang.Object

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

Constructor Detail

AddRowEmailBuilder

public AddRowEmailBuilder()

Method Detail

getIncludeAttachments

public Boolean getIncludeAttachments()

Gets the flag that indicates if attachments should be included in the email.

Returns:

the include attachments

setIncludeAttachments

public RowEmail.AddRowEmailBuilder setIncludeAttachments(Boolean includeAttachments)

Sets the flag that indicates if attachments should be included in the email.

Parameters:

includeAttachments - the new include attachments

Returns:

the builder

getIncludeDiscussions

public Boolean getIncludeDiscussions()

Gets the flag that indicates if discussions should be included in the email.

Returns:

the include discussions

setIncludeDiscussions

public RowEmail.AddRowEmailBuilder setIncludeDiscussions(Boolean includeDiscussions)

Sets the flag that indicates if discussions should be included in the email.

Parameters:

includeDiscussions - the new include discussions

Returns:

the builder

getLayout

public String getLayout()

Gets a string containing the layout. Defaults to HORIZONTAL if multiple rows are being setn, and to VERTICAL when a single row is being sent.

Returns:

layout

setLayout

public RowEmail.AddRowEmailBuilder setLayout(String layout)

Sets the layout string

Parameters:

layout - string containing HORIZONTAL or VERTICAL strings

Returns:

the builder

getSendTo

public List<Recipient> getSendTo()

Gets the list of recipients to send to

Returns:

the list of recipients

setSendTo

public RowEmail.AddRowEmailBuilder setSendTo(List<Recipient> sendTo)

Sets the list of recipients to send to

Parameters:

sendTo - list of recipients

Returns:

the builder

getSubject

public String getSubject()

Gets the subject.

Returns:

the subject

setSubject

public RowEmail.AddRowEmailBuilder setSubject(String subject)

Sets the subject.

Parameters:

subject - the new subject

Returns:

the associated builder

getMessage

public String getMessage()

Gets the message.

Returns:

the message

setMessage

public RowEmail.AddRowEmailBuilder setMessage(String message)

Sets the message.

Parameters:

message - the new message

Returns:

the builder

getCcMe

public Boolean getCcMe()

Gets the carbon copy me flag.

Returns:

the cc me

setCcMe

public RowEmail.AddRowEmailBuilder setCcMe(Boolean ccMe)

Sets the carbon copy me flag.

Parameters:

ccMe - the new cc me

Returns:

the builder

build

public RowEmail build()

Builds the row email.

Returns:

the rowemail