com.smartsheet.api.models

Class SheetEmail

java.lang.Object

com.smartsheet.api.models.Email

com.smartsheet.api.models.SheetEmail

public class SheetEmail
extends Email

Represents Sheet Email object used for sending a sheet by email.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SheetEmail.AddSheetEmailBuilder A convenience class to help create a SheetEmail object with the appropriate fields.

Constructor Summary

Constructors

Constructor and Description
SheetEmail()

Method Summary

Modifier and Type	Method and Description
SheetEmailFormat	getFormat() Gets the sheet email format (PDF or Excel).
FormatDetails	getFormatDetails() Gets the format details (paper dimensions).
SheetEmail	setFormat(SheetEmailFormat format) Sets the sheet email format (PDF or Excel).
SheetEmail	setFormatDetails(FormatDetails formatDetails) Sets the format details (paper dimensions).

Methods inherited from class com.smartsheet.api.models.Email

getCcMe, getMessage, getSendTo, getSubject, setCcMe, setMessage, setSendTo, setSubject

Methods inherited from class java.lang.Object

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

Constructor Detail

SheetEmail

public SheetEmail()

Method Detail

getFormat

public SheetEmailFormat getFormat()

Gets the sheet email format (PDF or Excel).

Returns:

the format

setFormat

public SheetEmail setFormat(SheetEmailFormat format)

Sets the sheet email format (PDF or Excel).

Parameters:

format - the new format

getFormatDetails

public FormatDetails getFormatDetails()

Gets the format details (paper dimensions).

Returns:

the format details

setFormatDetails

public SheetEmail setFormatDetails(FormatDetails formatDetails)

Sets the format details (paper dimensions).

Parameters:

formatDetails - the new format details