Email (Salesforce Marketing Cloud Java SDK 1.2.1 API)

java.lang.Object
- com.exacttarget.fuelsdk.internal.APIObject
- - com.exacttarget.fuelsdk.internal.Email

public class Email
extends APIObject

Java class for Email complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="Email">
   <complexContent>
     <extension base="{http://exacttarget.com/wsdl/partnerAPI}APIObject">
       <sequence>
         <element name="Name" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Folder" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="CategoryID" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="HTMLBody" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="TextBody" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="ContentAreas" type="{http://exacttarget.com/wsdl/partnerAPI}ContentArea" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Subject" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="IsActive" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="IsHTMLPaste" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="ClonedFromID" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="Status" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="EmailType" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="CharacterSet" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="HasDynamicSubjectLine" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="ContentCheckStatus" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="SyncTextWithHTML" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="PreHeader" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="IsApproved" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected Integer`	`categoryID`
`protected String`	`characterSet`
`protected Integer`	`clonedFromID`
`protected List<ContentArea>`	`contentAreas`
`protected String`	`contentCheckStatus`
`protected String`	`emailType`
`protected String`	`folder`
`protected Boolean`	`hasDynamicSubjectLine`
`protected String`	`htmlBody`
`protected Boolean`	`isActive`
`protected Boolean`	`isApproved`
`protected Boolean`	`isHTMLPaste`
`protected String`	`name`
`protected String`	`preHeader`
`protected String`	`status`
`protected String`	`subject`
`protected Boolean`	`syncTextWithHTML`
`protected String`	`textBody`

Fields inherited from class com.exacttarget.fuelsdk.internal.APIObject
client, correlationID, createdDate, customerKey, id, modifiedDate, objectID, objectState, owner, partnerKey, partnerProperties

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
`Integer`	`getCategoryID()` Gets the value of the categoryID property.
`String`	`getCharacterSet()` Gets the value of the characterSet property.
`Integer`	`getClonedFromID()` Gets the value of the clonedFromID property.
`List<ContentArea>`	`getContentAreas()` Gets the value of the contentAreas property.
`String`	`getContentCheckStatus()` Gets the value of the contentCheckStatus property.
`String`	`getEmailType()` Gets the value of the emailType property.
`String`	`getFolder()` Gets the value of the folder property.
`Boolean`	`getHasDynamicSubjectLine()` Gets the value of the hasDynamicSubjectLine property.
`String`	`getHtmlBody()` Gets the value of the htmlBody property.
`Boolean`	`getIsActive()` Gets the value of the isActive property.
`Boolean`	`getIsApproved()` Gets the value of the isApproved property.
`Boolean`	`getIsHTMLPaste()` Gets the value of the isHTMLPaste property.
`String`	`getName()` Gets the value of the name property.
`String`	`getPreHeader()` Gets the value of the preHeader property.
`String`	`getStatus()` Gets the value of the status property.
`String`	`getSubject()` Gets the value of the subject property.
`Boolean`	`getSyncTextWithHTML()` Gets the value of the syncTextWithHTML property.
`String`	`getTextBody()` Gets the value of the textBody property.
`void`	`setCategoryID(Integer value)` Sets the value of the categoryID property.
`void`	`setCharacterSet(String value)` Sets the value of the characterSet property.
`void`	`setClonedFromID(Integer value)` Sets the value of the clonedFromID property.
`void`	`setContentCheckStatus(String value)` Sets the value of the contentCheckStatus property.
`void`	`setEmailType(String value)` Sets the value of the emailType property.
`void`	`setFolder(String value)` Sets the value of the folder property.
`void`	`setHasDynamicSubjectLine(Boolean value)` Sets the value of the hasDynamicSubjectLine property.
`void`	`setHtmlBody(String value)` Sets the value of the htmlBody property.
`void`	`setIsActive(Boolean value)` Sets the value of the isActive property.
`void`	`setIsApproved(Boolean value)` Sets the value of the isApproved property.
`void`	`setIsHTMLPaste(Boolean value)` Sets the value of the isHTMLPaste property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setPreHeader(String value)` Sets the value of the preHeader property.
`void`	`setStatus(String value)` Sets the value of the status property.
`void`	`setSubject(String value)` Sets the value of the subject property.
`void`	`setSyncTextWithHTML(Boolean value)` Sets the value of the syncTextWithHTML property.
`void`	`setTextBody(String value)` Sets the value of the textBody property.
`String`	`toString()` Generates a String representation of the contents of this type.

Methods inherited from class com.exacttarget.fuelsdk.internal.APIObject
getClient, getCorrelationID, getCreatedDate, getCustomerKey, getId, getModifiedDate, getObjectID, getObjectState, getOwner, getPartnerKey, getPartnerProperties, setClient, setCorrelationID, setCreatedDate, setCustomerKey, setId, setModifiedDate, setObjectID, setObjectState, setOwner, setPartnerKey

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

- Field Detail
  - name
```
protected String name
```
  - folder
```
protected String folder
```
  - categoryID
```
protected Integer categoryID
```
  - htmlBody
```
protected String htmlBody
```
  - textBody
```
protected String textBody
```
  - contentAreas
```
protected List<ContentArea> contentAreas
```
  - subject
```
protected String subject
```
  - isActive
```
protected Boolean isActive
```
  - isHTMLPaste
```
protected Boolean isHTMLPaste
```
  - clonedFromID
```
protected Integer clonedFromID
```
  - status
```
protected String status
```
  - emailType
```
protected String emailType
```
  - characterSet
```
protected String characterSet
```
  - hasDynamicSubjectLine
```
protected Boolean hasDynamicSubjectLine
```
  - contentCheckStatus
```
protected String contentCheckStatus
```
  - syncTextWithHTML
```
protected Boolean syncTextWithHTML
```
  - preHeader
```
protected String preHeader
```
  - isApproved
```
protected Boolean isApproved
```
- Constructor Detail
  - Email
```
public Email()
```
- Method Detail
  - getName
```
public String getName()
```
    Gets the value of the name property.
    
    Returns:
    
    possible object is String
  - setName
```
public void setName(String value)
```
    Sets the value of the name property.
    
    Parameters:
    
    value - allowed object is String
  - getFolder
```
public String getFolder()
```
    Gets the value of the folder property.
    
    Returns:
    
    possible object is String
  - setFolder
```
public void setFolder(String value)
```
    Sets the value of the folder property.
    
    Parameters:
    
    value - allowed object is String
  - getCategoryID
```
public Integer getCategoryID()
```
    Gets the value of the categoryID property.
    
    Returns:
    
    possible object is Integer
  - setCategoryID
```
public void setCategoryID(Integer value)
```
    Sets the value of the categoryID property.
    
    Parameters:
    
    value - allowed object is Integer
  - getHtmlBody
```
public String getHtmlBody()
```
    Gets the value of the htmlBody property.
    
    Returns:
    
    possible object is String
  - setHtmlBody
```
public void setHtmlBody(String value)
```
    Sets the value of the htmlBody property.
    
    Parameters:
    
    value - allowed object is String
  - getTextBody
```
public String getTextBody()
```
    Gets the value of the textBody property.
    
    Returns:
    
    possible object is String
  - setTextBody
```
public void setTextBody(String value)
```
    Sets the value of the textBody property.
    
    Parameters:
    
    value - allowed object is String
  - getContentAreas
```
public List<ContentArea> getContentAreas()
```
    Gets the value of the contentAreas property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the contentAreas property.
    For example, to add a new item, do as follows:
```
    getContentAreas().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list ContentArea
  - getSubject
```
public String getSubject()
```
    Gets the value of the subject property.
    
    Returns:
    
    possible object is String
  - setSubject
```
public void setSubject(String value)
```
    Sets the value of the subject property.
    
    Parameters:
    
    value - allowed object is String
  - getIsActive
```
public Boolean getIsActive()
```
    Gets the value of the isActive property.
    
    Returns:
    
    possible object is Boolean
  - setIsActive
```
public void setIsActive(Boolean value)
```
    Sets the value of the isActive property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getIsHTMLPaste
```
public Boolean getIsHTMLPaste()
```
    Gets the value of the isHTMLPaste property.
    
    Returns:
    
    possible object is Boolean
  - setIsHTMLPaste
```
public void setIsHTMLPaste(Boolean value)
```
    Sets the value of the isHTMLPaste property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getClonedFromID
```
public Integer getClonedFromID()
```
    Gets the value of the clonedFromID property.
    
    Returns:
    
    possible object is Integer
  - setClonedFromID
```
public void setClonedFromID(Integer value)
```
    Sets the value of the clonedFromID property.
    
    Parameters:
    
    value - allowed object is Integer
  - getStatus
```
public String getStatus()
```
    Gets the value of the status property.
    
    Returns:
    
    possible object is String
  - setStatus
```
public void setStatus(String value)
```
    Sets the value of the status property.
    
    Parameters:
    
    value - allowed object is String
  - getEmailType
```
public String getEmailType()
```
    Gets the value of the emailType property.
    
    Returns:
    
    possible object is String
  - setEmailType
```
public void setEmailType(String value)
```
    Sets the value of the emailType property.
    
    Parameters:
    
    value - allowed object is String
  - getCharacterSet
```
public String getCharacterSet()
```
    Gets the value of the characterSet property.
    
    Returns:
    
    possible object is String
  - setCharacterSet
```
public void setCharacterSet(String value)
```
    Sets the value of the characterSet property.
    
    Parameters:
    
    value - allowed object is String
  - getHasDynamicSubjectLine
```
public Boolean getHasDynamicSubjectLine()
```
    Gets the value of the hasDynamicSubjectLine property.
    
    Returns:
    
    possible object is Boolean
  - setHasDynamicSubjectLine
```
public void setHasDynamicSubjectLine(Boolean value)
```
    Sets the value of the hasDynamicSubjectLine property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getContentCheckStatus
```
public String getContentCheckStatus()
```
    Gets the value of the contentCheckStatus property.
    
    Returns:
    
    possible object is String
  - setContentCheckStatus
```
public void setContentCheckStatus(String value)
```
    Sets the value of the contentCheckStatus property.
    
    Parameters:
    
    value - allowed object is String
  - getSyncTextWithHTML
```
public Boolean getSyncTextWithHTML()
```
    Gets the value of the syncTextWithHTML property.
    
    Returns:
    
    possible object is Boolean
  - setSyncTextWithHTML
```
public void setSyncTextWithHTML(Boolean value)
```
    Sets the value of the syncTextWithHTML property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getPreHeader
```
public String getPreHeader()
```
    Gets the value of the preHeader property.
    
    Returns:
    
    possible object is String
  - setPreHeader
```
public void setPreHeader(String value)
```
    Sets the value of the preHeader property.
    
    Parameters:
    
    value - allowed object is String
  - getIsApproved
```
public Boolean getIsApproved()
```
    Gets the value of the isApproved property.
    
    Returns:
    
    possible object is Boolean
  - setIsApproved
```
public void setIsApproved(Boolean value)
```
    Sets the value of the isApproved property.
    
    Parameters:
    
    value - allowed object is Boolean
  - toString
```
public String toString()
```
    Generates a String representation of the contents of this type. This is an extension method, produced by the 'ts' xjc plugin
    
    Overrides:
    
    toString in class APIObject

Class Email

Field Summary

Fields inherited from class com.exacttarget.fuelsdk.internal.APIObject

Constructor Summary

Method Summary

Methods inherited from class com.exacttarget.fuelsdk.internal.APIObject

Methods inherited from class java.lang.Object

Field Detail

name

folder

categoryID

htmlBody

textBody

contentAreas

subject

isActive

isHTMLPaste

clonedFromID

status

emailType

characterSet

hasDynamicSubjectLine

contentCheckStatus

syncTextWithHTML

preHeader

isApproved

Constructor Detail

Email

Method Detail

getName

setName

getFolder

setFolder

getCategoryID

setCategoryID

getHtmlBody

setHtmlBody

getTextBody

setTextBody

getContentAreas

getSubject

setSubject

getIsActive

setIsActive

getIsHTMLPaste

setIsHTMLPaste

getClonedFromID

setClonedFromID

getStatus

setStatus

getEmailType

setEmailType

getCharacterSet

setCharacterSet

getHasDynamicSubjectLine

setHasDynamicSubjectLine

getContentCheckStatus

setContentCheckStatus

getSyncTextWithHTML

setSyncTextWithHTML

getPreHeader

setPreHeader

getIsApproved

setIsApproved

toString