Email (docusign-esign-java 2.0.2 API)

java.lang.Object
- com.docusign.esign.model.Email

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2016-07-18T18:11:15.675-07:00")
public class Email
extends Object

Constructor Summary

Constructors
Constructor and Description

Email()

Constructors
Constructor and Description
`Email()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Email`	`anchorCaseSensitive(String anchorCaseSensitive)` When set to true, the anchor string does not consider case when matching strings in the document.
`Email`	`anchorHorizontalAlignment(String anchorHorizontalAlignment)` Specifies the alignment of anchor tabs with anchor strings.
`Email`	`anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)` When set to true, this tab is ignored if anchorString is not found in the document.
`Email`	`anchorMatchWholeWord(String anchorMatchWholeWord)` When set to true, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is true.
`Email`	`anchorString(String anchorString)` Anchor text information for a radio button.
`Email`	`anchorUnits(String anchorUnits)` Specifies units of the X and Y offset.
`Email`	`anchorXOffset(String anchorXOffset)` Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`Email`	`anchorYOffset(String anchorYOffset)` Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`Email`	`bold(String bold)` When set to true, the information in the tab is bold.
`Email`	`concealValueOnDocument(String concealValueOnDocument)` When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
`Email`	`conditionalParentLabel(String conditionalParentLabel)` For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`Email`	`conditionalParentValue(String conditionalParentValue)` For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n
`Email`	`customTabId(String customTabId)` The DocuSign generated custom tab ID for the custom tab to be applied.
`Email`	`disableAutoSize(String disableAutoSize)` When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data.
`Email`	`documentId(String documentId)` Specifies the document ID number that the tab is placed on.
`boolean`	`equals(Object o)`
`Email`	`errorDetails(ErrorDetails errorDetails)`
`Email`	`font(String font)` The font to be used for the tab value.
`Email`	`fontColor(String fontColor)` The font color used for the information in the tab.\n\nPossible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
`Email`	`fontSize(String fontSize)` The font size used for the information in the tab.\n\nPossible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.
`String`	`getAnchorCaseSensitive()`
`String`	`getAnchorHorizontalAlignment()`
`String`	`getAnchorIgnoreIfNotPresent()`
`String`	`getAnchorMatchWholeWord()`
`String`	`getAnchorString()`
`String`	`getAnchorUnits()`
`String`	`getAnchorXOffset()`
`String`	`getAnchorYOffset()`
`String`	`getBold()`
`String`	`getConcealValueOnDocument()`
`String`	`getConditionalParentLabel()`
`String`	`getConditionalParentValue()`
`String`	`getCustomTabId()`
`String`	`getDisableAutoSize()`
`String`	`getDocumentId()`
`ErrorDetails`	`getErrorDetails()`
`String`	`getFont()`
`String`	`getFontColor()`
`String`	`getFontSize()`
`String`	`getItalic()`
`String`	`getLocked()`
`Integer`	`getMaxLength()`
`MergeField`	`getMergeField()`
`String`	`getName()`
`String`	`getOriginalValue()`
`String`	`getPageNumber()`
`String`	`getRecipientId()`
`String`	`getRequireAll()`
`String`	`getRequired()`
`String`	`getRequireInitialOnSharedChange()`
`String`	`getSenderRequired()`
`String`	`getShared()`
`String`	`getStatus()`
`String`	`getTabId()`
`String`	`getTabLabel()`
`String`	`getTabOrder()`
`String`	`getTemplateLocked()`
`String`	`getTemplateRequired()`
`String`	`getUnderline()`
`String`	`getValidationMessage()`
`String`	`getValidationPattern()`
`String`	`getValue()`
`Integer`	`getWidth()`
`String`	`getXPosition()`
`String`	`getYPosition()`
`int`	`hashCode()`
`Email`	`italic(String italic)` When set to true, the information in the tab is italic.
`Email`	`locked(String locked)` When set to true, the signer cannot change the data of the custom tab.
`Email`	`maxLength(Integer maxLength)` An optional value that describes the maximum length of the property when the property is a string.
`Email`	`mergeField(MergeField mergeField)`
`Email`	`name(String name)`
`Email`	`originalValue(String originalValue)` The initial value of the tab when it was sent to the recipient.
`Email`	`pageNumber(String pageNumber)` Specifies the page number on which the tab is located.
`Email`	`recipientId(String recipientId)` Unique for the recipient.
`Email`	`requireAll(String requireAll)` When set to true and shared is true, information must be entered in this field to complete the envelope.
`Email`	`required(String required)` When set to true, the signer is required to fill out this tab
`Email`	`requireInitialOnSharedChange(String requireInitialOnSharedChange)` Optional element for field markup.
`Email`	`senderRequired(String senderRequired)` When set to true, the sender must populate the tab before an envelope can be sent using the template.
`void`	`setAnchorCaseSensitive(String anchorCaseSensitive)`
`void`	`setAnchorHorizontalAlignment(String anchorHorizontalAlignment)`
`void`	`setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)`
`void`	`setAnchorMatchWholeWord(String anchorMatchWholeWord)`
`void`	`setAnchorString(String anchorString)`
`void`	`setAnchorUnits(String anchorUnits)`
`void`	`setAnchorXOffset(String anchorXOffset)`
`void`	`setAnchorYOffset(String anchorYOffset)`
`void`	`setBold(String bold)`
`void`	`setConcealValueOnDocument(String concealValueOnDocument)`
`void`	`setConditionalParentLabel(String conditionalParentLabel)`
`void`	`setConditionalParentValue(String conditionalParentValue)`
`void`	`setCustomTabId(String customTabId)`
`void`	`setDisableAutoSize(String disableAutoSize)`
`void`	`setDocumentId(String documentId)`
`void`	`setErrorDetails(ErrorDetails errorDetails)`
`void`	`setFont(String font)`
`void`	`setFontColor(String fontColor)`
`void`	`setFontSize(String fontSize)`
`void`	`setItalic(String italic)`
`void`	`setLocked(String locked)`
`void`	`setMaxLength(Integer maxLength)`
`void`	`setMergeField(MergeField mergeField)`
`void`	`setName(String name)`
`void`	`setOriginalValue(String originalValue)`
`void`	`setPageNumber(String pageNumber)`
`void`	`setRecipientId(String recipientId)`
`void`	`setRequireAll(String requireAll)`
`void`	`setRequired(String required)`
`void`	`setRequireInitialOnSharedChange(String requireInitialOnSharedChange)`
`void`	`setSenderRequired(String senderRequired)`
`void`	`setShared(String shared)`
`void`	`setStatus(String status)`
`void`	`setTabId(String tabId)`
`void`	`setTabLabel(String tabLabel)`
`void`	`setTabOrder(String tabOrder)`
`void`	`setTemplateLocked(String templateLocked)`
`void`	`setTemplateRequired(String templateRequired)`
`void`	`setUnderline(String underline)`
`void`	`setValidationMessage(String validationMessage)`
`void`	`setValidationPattern(String validationPattern)`
`void`	`setValue(String value)`
`void`	`setWidth(Integer width)`
`void`	`setXPosition(String xPosition)`
`void`	`setYPosition(String yPosition)`
`Email`	`shared(String shared)` When set to true, this custom tab is shared.
`Email`	`status(String status)` Indicates the envelope status.
`Email`	`tabId(String tabId)` The unique identifier for the tab.
`Email`	`tabLabel(String tabLabel)` The label string associated with the tab.
`Email`	`tabOrder(String tabOrder)`
`Email`	`templateLocked(String templateLocked)` When set to true, the sender cannot change any attributes of the recipient.
`Email`	`templateRequired(String templateRequired)` When set to true, the sender may not remove the recipient.
`String`	`toString()`
`Email`	`underline(String underline)` When set to true, the information in the tab is underlined.
`Email`	`validationMessage(String validationMessage)` The message displayed if the custom tab fails input validation (either custom of embedded).
`Email`	`validationPattern(String validationPattern)` A regular expressionn used to validate input for the tab.
`Email`	`value(String value)` Specifies the value of the tab.
`Email`	`width(Integer width)` Width of the tab in pixels.
`Email`	`xPosition(String xPosition)` This indicates the horizontal offset of the object on the page.
`Email`	`yPosition(String yPosition)` This indicates the vertical offset of the object on the page.

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

- Constructor Detail
  - Email
```
public Email()
```
- Method Detail
  - validationPattern
```
public Email validationPattern(String validationPattern)
```
    A regular expressionn used to validate input for the tab.
  - getValidationPattern
```
public String getValidationPattern()
```
  - setValidationPattern
```
public void setValidationPattern(String validationPattern)
```
  - validationMessage
```
public Email validationMessage(String validationMessage)
```
    The message displayed if the custom tab fails input validation (either custom of embedded).
  - getValidationMessage
```
public String getValidationMessage()
```
  - setValidationMessage
```
public void setValidationMessage(String validationMessage)
```
  - shared
```
public Email shared(String shared)
```
    When set to **true**, this custom tab is shared.
  - getShared
```
public String getShared()
```
  - setShared
```
public void setShared(String shared)
```
  - requireInitialOnSharedChange
```
public Email requireInitialOnSharedChange(String requireInitialOnSharedChange)
```
    Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.
  - getRequireInitialOnSharedChange
```
public String getRequireInitialOnSharedChange()
```
  - setRequireInitialOnSharedChange
```
public void setRequireInitialOnSharedChange(String requireInitialOnSharedChange)
```
  - senderRequired
```
public Email senderRequired(String senderRequired)
```
    When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.
  - getSenderRequired
```
public String getSenderRequired()
```
  - setSenderRequired
```
public void setSenderRequired(String senderRequired)
```
  - requireAll
```
public Email requireAll(String requireAll)
```
    When set to **true** and shared is true, information must be entered in this field to complete the envelope.
  - getRequireAll
```
public String getRequireAll()
```
  - setRequireAll
```
public void setRequireAll(String requireAll)
```
  - name
```
public Email name(String name)
```
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
  - value
```
public Email value(String value)
```
    Specifies the value of the tab.
  - getValue
```
public String getValue()
```
  - setValue
```
public void setValue(String value)
```
  - originalValue
```
public Email originalValue(String originalValue)
```
    The initial value of the tab when it was sent to the recipient.
  - getOriginalValue
```
public String getOriginalValue()
```
  - setOriginalValue
```
public void setOriginalValue(String originalValue)
```
  - width
```
public Email width(Integer width)
```
    Width of the tab in pixels.
  - getWidth
```
public Integer getWidth()
```
  - setWidth
```
public void setWidth(Integer width)
```
  - required
```
public Email required(String required)
```
    When set to **true**, the signer is required to fill out this tab
  - getRequired
```
public String getRequired()
```
  - setRequired
```
public void setRequired(String required)
```
  - locked
```
public Email locked(String locked)
```
    When set to **true**, the signer cannot change the data of the custom tab.
  - getLocked
```
public String getLocked()
```
  - setLocked
```
public void setLocked(String locked)
```
  - concealValueOnDocument
```
public Email concealValueOnDocument(String concealValueOnDocument)
```
    When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
  - getConcealValueOnDocument
```
public String getConcealValueOnDocument()
```
  - setConcealValueOnDocument
```
public void setConcealValueOnDocument(String concealValueOnDocument)
```
  - disableAutoSize
```
public Email disableAutoSize(String disableAutoSize)
```
    When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.
  - getDisableAutoSize
```
public String getDisableAutoSize()
```
  - setDisableAutoSize
```
public void setDisableAutoSize(String disableAutoSize)
```
  - maxLength
```
public Email maxLength(Integer maxLength)
```
    An optional value that describes the maximum length of the property when the property is a string.
  - getMaxLength
```
public Integer getMaxLength()
```
  - setMaxLength
```
public void setMaxLength(Integer maxLength)
```
  - tabLabel
```
public Email tabLabel(String tabLabel)
```
    The label string associated with the tab.
  - getTabLabel
```
public String getTabLabel()
```
  - setTabLabel
```
public void setTabLabel(String tabLabel)
```
  - font
```
public Email font(String font)
```
    The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.
  - getFont
```
public String getFont()
```
  - setFont
```
public void setFont(String font)
```
  - bold
```
public Email bold(String bold)
```
    When set to **true**, the information in the tab is bold.
  - getBold
```
public String getBold()
```
  - setBold
```
public void setBold(String bold)
```
  - italic
```
public Email italic(String italic)
```
    When set to **true**, the information in the tab is italic.
  - getItalic
```
public String getItalic()
```
  - setItalic
```
public void setItalic(String italic)
```
  - underline
```
public Email underline(String underline)
```
    When set to **true**, the information in the tab is underlined.
  - getUnderline
```
public String getUnderline()
```
  - setUnderline
```
public void setUnderline(String underline)
```
  - fontColor
```
public Email fontColor(String fontColor)
```
    The font color used for the information in the tab.\n\nPossible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
  - getFontColor
```
public String getFontColor()
```
  - setFontColor
```
public void setFontColor(String fontColor)
```
  - fontSize
```
public Email fontSize(String fontSize)
```
    The font size used for the information in the tab.\n\nPossible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.
  - getFontSize
```
public String getFontSize()
```
  - setFontSize
```
public void setFontSize(String fontSize)
```
  - documentId
```
public Email documentId(String documentId)
```
    Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
  - getDocumentId
```
public String getDocumentId()
```
  - setDocumentId
```
public void setDocumentId(String documentId)
```
  - recipientId
```
public Email recipientId(String recipientId)
```
    Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
  - getRecipientId
```
public String getRecipientId()
```
  - setRecipientId
```
public void setRecipientId(String recipientId)
```
  - pageNumber
```
public Email pageNumber(String pageNumber)
```
    Specifies the page number on which the tab is located.
  - getPageNumber
```
public String getPageNumber()
```
  - setPageNumber
```
public void setPageNumber(String pageNumber)
```
  - xPosition
```
public Email xPosition(String xPosition)
```
    This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
  - getXPosition
```
public String getXPosition()
```
  - setXPosition
```
public void setXPosition(String xPosition)
```
  - yPosition
```
public Email yPosition(String yPosition)
```
    This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
  - getYPosition
```
public String getYPosition()
```
  - setYPosition
```
public void setYPosition(String yPosition)
```
  - anchorString
```
public Email anchorString(String anchorString)
```
    Anchor text information for a radio button.
  - getAnchorString
```
public String getAnchorString()
```
  - setAnchorString
```
public void setAnchorString(String anchorString)
```
  - anchorXOffset
```
public Email anchorXOffset(String anchorXOffset)
```
    Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
  - getAnchorXOffset
```
public String getAnchorXOffset()
```
  - setAnchorXOffset
```
public void setAnchorXOffset(String anchorXOffset)
```
  - anchorYOffset
```
public Email anchorYOffset(String anchorYOffset)
```
    Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
  - getAnchorYOffset
```
public String getAnchorYOffset()
```
  - setAnchorYOffset
```
public void setAnchorYOffset(String anchorYOffset)
```
  - anchorUnits
```
public Email anchorUnits(String anchorUnits)
```
    Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
  - getAnchorUnits
```
public String getAnchorUnits()
```
  - setAnchorUnits
```
public void setAnchorUnits(String anchorUnits)
```
  - anchorIgnoreIfNotPresent
```
public Email anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
```
    When set to **true**, this tab is ignored if anchorString is not found in the document.
  - getAnchorIgnoreIfNotPresent
```
public String getAnchorIgnoreIfNotPresent()
```
  - setAnchorIgnoreIfNotPresent
```
public void setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
```
  - anchorCaseSensitive
```
public Email anchorCaseSensitive(String anchorCaseSensitive)
```
    When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.
  - getAnchorCaseSensitive
```
public String getAnchorCaseSensitive()
```
  - setAnchorCaseSensitive
```
public void setAnchorCaseSensitive(String anchorCaseSensitive)
```
  - anchorMatchWholeWord
```
public Email anchorMatchWholeWord(String anchorMatchWholeWord)
```
    When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.
  - getAnchorMatchWholeWord
```
public String getAnchorMatchWholeWord()
```
  - setAnchorMatchWholeWord
```
public void setAnchorMatchWholeWord(String anchorMatchWholeWord)
```
  - anchorHorizontalAlignment
```
public Email anchorHorizontalAlignment(String anchorHorizontalAlignment)
```
    Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.
  - getAnchorHorizontalAlignment
```
public String getAnchorHorizontalAlignment()
```
  - setAnchorHorizontalAlignment
```
public void setAnchorHorizontalAlignment(String anchorHorizontalAlignment)
```
  - tabId
```
public Email tabId(String tabId)
```
    The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. \n\n \n
  - getTabId
```
public String getTabId()
```
  - setTabId
```
public void setTabId(String tabId)
```
  - templateLocked
```
public Email templateLocked(String templateLocked)
```
    When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
  - getTemplateLocked
```
public String getTemplateLocked()
```
  - setTemplateLocked
```
public void setTemplateLocked(String templateLocked)
```
  - templateRequired
```
public Email templateRequired(String templateRequired)
```
    When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
  - getTemplateRequired
```
public String getTemplateRequired()
```
  - setTemplateRequired
```
public void setTemplateRequired(String templateRequired)
```
  - conditionalParentLabel
```
public Email conditionalParentLabel(String conditionalParentLabel)
```
    For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
  - getConditionalParentLabel
```
public String getConditionalParentLabel()
```
  - setConditionalParentLabel
```
public void setConditionalParentLabel(String conditionalParentLabel)
```
  - conditionalParentValue
```
public Email conditionalParentValue(String conditionalParentValue)
```
    For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n
  - getConditionalParentValue
```
public String getConditionalParentValue()
```
  - setConditionalParentValue
```
public void setConditionalParentValue(String conditionalParentValue)
```
  - customTabId
```
public Email customTabId(String customTabId)
```
    The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
  - getCustomTabId
```
public String getCustomTabId()
```
  - setCustomTabId
```
public void setCustomTabId(String customTabId)
```
  - mergeField
```
public Email mergeField(MergeField mergeField)
```
  - getMergeField
```
public MergeField getMergeField()
```
  - setMergeField
```
public void setMergeField(MergeField mergeField)
```
  - status
```
public Email status(String status)
```
    Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.
  - getStatus
```
public String getStatus()
```
  - setStatus
```
public void setStatus(String status)
```
  - errorDetails
```
public Email errorDetails(ErrorDetails errorDetails)
```
  - getErrorDetails
```
public ErrorDetails getErrorDetails()
```
  - setErrorDetails
```
public void setErrorDetails(ErrorDetails errorDetails)
```
  - tabOrder
```
public Email tabOrder(String tabOrder)
```
  - getTabOrder
```
public String getTabOrder()
```
  - setTabOrder
```
public void setTabOrder(String tabOrder)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Email

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Email

Method Detail

validationPattern

getValidationPattern

setValidationPattern

validationMessage

getValidationMessage

setValidationMessage

shared

getShared

setShared

requireInitialOnSharedChange

getRequireInitialOnSharedChange

setRequireInitialOnSharedChange

senderRequired

getSenderRequired

setSenderRequired

requireAll

getRequireAll

setRequireAll

name

getName

setName

value

getValue

setValue

originalValue

getOriginalValue

setOriginalValue

width

getWidth

setWidth

required

getRequired

setRequired

locked

getLocked

setLocked

concealValueOnDocument

getConcealValueOnDocument

setConcealValueOnDocument

disableAutoSize

getDisableAutoSize

setDisableAutoSize

maxLength

getMaxLength

setMaxLength

tabLabel

getTabLabel

setTabLabel

font

getFont

setFont

bold

getBold

setBold

italic

getItalic

setItalic

underline

getUnderline

setUnderline

fontColor

getFontColor

setFontColor

fontSize

getFontSize

setFontSize

documentId

getDocumentId

setDocumentId

recipientId

getRecipientId

setRecipientId

pageNumber