EmailTemplate (sforce-tooling-api 35.0 API)

java.lang.Object
- com.sforce.soap.tooling.metadata.Metadata
- - com.sforce.soap.tooling.metadata.EmailTemplate

public class EmailTemplate
extends Metadata

Java class for EmailTemplate complex type.

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

 <complexType name="EmailTemplate">
   <complexContent>
     <extension base="{urn:metadata.tooling.soap.sforce.com}Metadata">
       <sequence>
         <element name="apiVersion" type="{http://www.w3.org/2001/XMLSchema}double" minOccurs="0"/>
         <element name="attachedDocuments" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
         <element name="attachments" type="{urn:metadata.tooling.soap.sforce.com}Attachment" maxOccurs="unbounded" minOccurs="0"/>
         <element name="available" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="description" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="encodingKey" type="{urn:tooling.soap.sforce.com}Encoding"/>
         <element name="letterhead" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="name" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="packageVersions" type="{urn:metadata.tooling.soap.sforce.com}PackageVersion" maxOccurs="unbounded" minOccurs="0"/>
         <element name="style" type="{urn:tooling.soap.sforce.com}EmailTemplateStyle"/>
         <element name="subject" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="textOnly" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="type" type="{urn:tooling.soap.sforce.com}EmailTemplateType"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected Double`	`apiVersion`
`protected List<String>`	`attachedDocuments`
`protected List<Attachment>`	`attachments`
`protected boolean`	`available`
`protected String`	`description`
`protected Encoding`	`encodingKey`
`protected String`	`letterhead`
`protected String`	`name`
`protected List<PackageVersion>`	`packageVersions`
`protected EmailTemplateStyle`	`style`
`protected String`	`subject`
`protected String`	`textOnly`
`protected EmailTemplateType`	`type`

Constructor Summary

Constructors
Constructor and Description

EmailTemplate()

Constructors
Constructor and Description
`EmailTemplate()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Double`	`getApiVersion()` Gets the value of the apiVersion property.
`List<String>`	`getAttachedDocuments()` Gets the value of the attachedDocuments property.
`List<Attachment>`	`getAttachments()` Gets the value of the attachments property.
`String`	`getDescription()` Gets the value of the description property.
`Encoding`	`getEncodingKey()` Gets the value of the encodingKey property.
`String`	`getLetterhead()` Gets the value of the letterhead property.
`String`	`getName()` Gets the value of the name property.
`List<PackageVersion>`	`getPackageVersions()` Gets the value of the packageVersions property.
`EmailTemplateStyle`	`getStyle()` Gets the value of the style property.
`String`	`getSubject()` Gets the value of the subject property.
`String`	`getTextOnly()` Gets the value of the textOnly property.
`EmailTemplateType`	`getType()` Gets the value of the type property.
`boolean`	`isAvailable()` Gets the value of the available property.
`void`	`setApiVersion(Double value)` Sets the value of the apiVersion property.
`void`	`setAvailable(boolean value)` Sets the value of the available property.
`void`	`setDescription(String value)` Sets the value of the description property.
`void`	`setEncodingKey(Encoding value)` Sets the value of the encodingKey property.
`void`	`setLetterhead(String value)` Sets the value of the letterhead property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setStyle(EmailTemplateStyle value)` Sets the value of the style property.
`void`	`setSubject(String value)` Sets the value of the subject property.
`void`	`setTextOnly(String value)` Sets the value of the textOnly property.
`void`	`setType(EmailTemplateType value)` Sets the value of the type property.

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

- Field Detail
  - apiVersion
```
protected Double apiVersion
```
  - attachedDocuments
```
protected List<String> attachedDocuments
```
  - attachments
```
protected List<Attachment> attachments
```
  - available
```
protected boolean available
```
  - description
```
protected String description
```
  - encodingKey
```
protected Encoding encodingKey
```
  - letterhead
```
protected String letterhead
```
  - name
```
protected String name
```
  - packageVersions
```
protected List<PackageVersion> packageVersions
```
  - style
```
protected EmailTemplateStyle style
```
  - subject
```
protected String subject
```
  - textOnly
```
protected String textOnly
```
  - type
```
protected EmailTemplateType type
```
- Constructor Detail
  - EmailTemplate
```
public EmailTemplate()
```
- Method Detail
  - getApiVersion
```
public Double getApiVersion()
```
    Gets the value of the apiVersion property.
    
    Returns:
    
    possible object is Double
  - setApiVersion
```
public void setApiVersion(Double value)
```
    Sets the value of the apiVersion property.
    
    Parameters:
    
    value - allowed object is Double
  - getAttachedDocuments
```
public List<String> getAttachedDocuments()
```
    Gets the value of the attachedDocuments 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 attachedDocuments property.
    For example, to add a new item, do as follows:
```
    getAttachedDocuments().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String
  - getAttachments
```
public List<Attachment> getAttachments()
```
    Gets the value of the attachments 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 attachments property.
    For example, to add a new item, do as follows:
```
    getAttachments().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Attachment
  - isAvailable
```
public boolean isAvailable()
```
    Gets the value of the available property.
  - setAvailable
```
public void setAvailable(boolean value)
```
    Sets the value of the available property.
  - getDescription
```
public String getDescription()
```
    Gets the value of the description property.
    
    Returns:
    
    possible object is String
  - setDescription
```
public void setDescription(String value)
```
    Sets the value of the description property.
    
    Parameters:
    
    value - allowed object is String
  - getEncodingKey
```
public Encoding getEncodingKey()
```
    Gets the value of the encodingKey property.
    
    Returns:
    
    possible object is Encoding
  - setEncodingKey
```
public void setEncodingKey(Encoding value)
```
    Sets the value of the encodingKey property.
    
    Parameters:
    
    value - allowed object is Encoding
  - getLetterhead
```
public String getLetterhead()
```
    Gets the value of the letterhead property.
    
    Returns:
    
    possible object is String
  - setLetterhead
```
public void setLetterhead(String value)
```
    Sets the value of the letterhead property.
    
    Parameters:
    
    value - allowed object is String
  - 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
  - getPackageVersions
```
public List<PackageVersion> getPackageVersions()
```
    Gets the value of the packageVersions 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 packageVersions property.
    For example, to add a new item, do as follows:
```
    getPackageVersions().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list PackageVersion
  - getStyle
```
public EmailTemplateStyle getStyle()
```
    Gets the value of the style property.
    
    Returns:
    
    possible object is EmailTemplateStyle
  - setStyle
```
public void setStyle(EmailTemplateStyle value)
```
    Sets the value of the style property.
    
    Parameters:
    
    value - allowed object is EmailTemplateStyle
  - 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
  - getTextOnly
```
public String getTextOnly()
```
    Gets the value of the textOnly property.
    
    Returns:
    
    possible object is String
  - setTextOnly
```
public void setTextOnly(String value)
```
    Sets the value of the textOnly property.
    
    Parameters:
    
    value - allowed object is String
  - getType
```
public EmailTemplateType getType()
```
    Gets the value of the type property.
    
    Returns:
    
    possible object is EmailTemplateType
  - setType
```
public void setType(EmailTemplateType value)
```
    Sets the value of the type property.
    
    Parameters:
    
    value - allowed object is EmailTemplateType

Class EmailTemplate

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

apiVersion

attachedDocuments

attachments

available

description

encodingKey

letterhead

name

packageVersions

style

subject

textOnly

type

Constructor Detail

EmailTemplate

Method Detail

getApiVersion

setApiVersion

getAttachedDocuments

getAttachments

isAvailable

setAvailable

getDescription

setDescription

getEncodingKey

setEncodingKey

getLetterhead

setLetterhead

getName

setName

getPackageVersions

getStyle

setStyle

getSubject

setSubject

getTextOnly

setTextOnly

getType

setType