Package com.smartsheet.api.models

Class RowEmail

  • Direct Known Subclasses:
    MultiRowEmail
    public class RowEmail
extends Email
    Represents RowEmail object.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  RowEmail.AddRowEmailBuilder
      A convenience class to help create a RowEmail object with the appropriate fields.

    • Constructor Summary

      Constructors 
      Constructor Description
      RowEmail()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Boolean getCcMe()
      Gets the carbon copy me flag.
      java.util.List<java.lang.Long> getColumnIds()
      Gets the IDs of the columns to be included.
      java.lang.Boolean getIncludeAttachments()
      Gets the flag that indicates if attachments should be included in the email.
      java.lang.Boolean getIncludeDiscussions()
      Gets the flag that indicates if discussions should be included in the email.
      java.lang.String getLayout()
      Gets a string containing the layout.
      java.lang.String getMessage()
      Gets the message.
      java.util.List<Recipient> getSendTo()
      Gets the list of recipients to send to
      java.lang.String getSubject()
      Gets the subject.
      RowEmail setCcMe​(java.lang.Boolean ccMe)
      Sets the carbon copy me flag.
      RowEmail setColumnIds​(java.util.List<java.lang.Long> columnIds)
      Sets the IDs of the columns to be included.
      RowEmail setIncludeAttachments​(java.lang.Boolean includeAttachments)
      Sets the flag that indicates if attachments should be included in the email.
      RowEmail setIncludeDiscussions​(java.lang.Boolean includeDiscussions)
      Sets the flag that indicates if discussions should be included in the email.
      RowEmail setLayout​(java.lang.String layout)
      Sets the layout string
      RowEmail setMessage​(java.lang.String message)
      Sets the message.
      RowEmail setSendTo​(java.util.List<Recipient> sendTo)
      Sets the list of recipients to send to
      RowEmail setSubject​(java.lang.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

      • RowEmail

        public RowEmail()

    • Method Detail

      • getSendTo

        public java.util.List<Recipient> getSendTo()
        Description copied from class: Email
        Gets the list of recipients to send to
        Overrides:
        getSendTo in class Email
        Returns:
        the list of recipients

      • setSendTo

        public RowEmail setSendTo​(java.util.List<Recipient> sendTo)
        Description copied from class: Email
        Sets the list of recipients to send to
        Overrides:
        setSendTo in class Email
        Parameters:
        sendTo - list of recipients

      • getSubject

        public java.lang.String getSubject()
        Description copied from class: Email
        Gets the subject.
        Overrides:
        getSubject in class Email
        Returns:
        the subject

      • setSubject

        public RowEmail setSubject​(java.lang.String subject)
        Description copied from class: Email
        Sets the subject.
        Overrides:
        setSubject in class Email
        Parameters:
        subject - the new subject

      • getMessage

        public java.lang.String getMessage()
        Description copied from class: Email
        Gets the message.
        Overrides:
        getMessage in class Email
        Returns:
        the message

      • setMessage

        public RowEmail setMessage​(java.lang.String message)
        Description copied from class: Email
        Sets the message.
        Overrides:
        setMessage in class Email
        Parameters:
        message - the new message

      • getCcMe

        public java.lang.Boolean getCcMe()
        Description copied from class: Email
        Gets the carbon copy me flag.
        Overrides:
        getCcMe in class Email
        Returns:
        the cc me

      • setCcMe

        public RowEmail setCcMe​(java.lang.Boolean ccMe)
        Description copied from class: Email
        Sets the carbon copy me flag.
        Overrides:
        setCcMe in class Email
        Parameters:
        ccMe - the new cc me

      • getColumnIds

        public java.util.List<java.lang.Long> getColumnIds()
        Gets the IDs of the columns to be included.
        Returns:
        the colmn ids

      • setColumnIds

        public RowEmail setColumnIds​(java.util.List<java.lang.Long> columnIds)
        Sets the IDs of the columns to be included.
        Parameters:
        columnIds - the column ids

      • getIncludeAttachments

        public java.lang.Boolean getIncludeAttachments()
        Gets the flag that indicates if attachments should be included in the email.
        Returns:
        the include attachments

      • setIncludeAttachments

        public RowEmail setIncludeAttachments​(java.lang.Boolean includeAttachments)
        Sets the flag that indicates if attachments should be included in the email.
        Parameters:
        includeAttachments - the new include attachments

      • getIncludeDiscussions

        public java.lang.Boolean getIncludeDiscussions()
        Gets the flag that indicates if discussions should be included in the email.
        Returns:
        the include discussions

      • setIncludeDiscussions

        public RowEmail setIncludeDiscussions​(java.lang.Boolean includeDiscussions)
        Sets the flag that indicates if discussions should be included in the email.
        Parameters:
        includeDiscussions - the new include discussions

      • getLayout

        public java.lang.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 setLayout​(java.lang.String layout)
        Sets the layout string
        Parameters:
        layout - string containing HORIZONTAL or VERTICAL strings