ETEmail (Salesforce Marketing Cloud Java SDK 1.2.1 API)

java.lang.Object
- com.exacttarget.fuelsdk.ETObject
- - com.exacttarget.fuelsdk.ETApiObject
  - - com.exacttarget.fuelsdk.ETSoapObject
    - - com.exacttarget.fuelsdk.ETEmail

public class ETEmail
extends ETSoapObject

An ETEmail represents an email in the Salesforce Marketing Cloud. Emails are managed in the Marketing Cloud Email app under the "Content" menu:

Via the SDK, you can create, retrieve, update, and delete emails.

To create an email:

ETClient client = new ETClient();
ETEmail email = new ETEmail();
email.setKey("myemail");
email.setName("my email");
email.setSubject("This is my first email");
email.setHtmlBody("<b>This is the HTML body</b>");
email.setTextBody("This is the text body");
ETResponse<ETEmail> response = client.create(email);
for (ETResult<ETEmail> result : response.getResults()) {
    System.out.println(result);
}

To retrieve an email:

ETClient client = new ETClient();
ETResponse<ETEmail> response = client.retrieve(ETEmail.class, "key=myemail");
for (ETResult<ETEmail> result : response.getResults()) {
    System.out.println(result);
}

To retrieve all emails:

ETClient client = new ETClient();
ETResponse<ETEmail> response = client.retrieve(ETEmail.class);
for (ETResult<ETEmail> result : response.getResults()) {
    System.out.println(result);
}

To update an email:

ETClient client = new ETClient();
ETEmail email = client.retrieveObject(ETEmail.class, "key=myemail");
email.setSubject("This is still my first email");
ETResponse<ETEmail> response = client.update(email);
for (ETResult<ETEmail> result : response.getResults()) {
    System.out.println(result);
}

To delete an email:

ETClient client = new ETClient();
ETResponse<ETEmail> response = client.delete(ETEmail.class, "key=myemail");
for (ETResult<ETEmail> result : response.getResults()) {
    System.out.println(result);
}

Note: You can (and should) reuse ETClient instances, as instantiating an instance involves authenticating with the Salesforce Marketing Cloud and is, thus, a heavyweight operation.

See Also:: Objects, Methods, http://help.exacttarget.com/en-US/technical_library/web_service_guide/objects/email/

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ETEmail.Type
Email Types that can be used
- Nested classes/interfaces inherited from class com.exacttarget.fuelsdk.ETSoapObject
  ETSoapObject.DataExtensionRowConverter, ETSoapObject.EnumConverter, ETSoapObject.ExternalObjectConverter, ETSoapObject.InternalObjectConverter

Nested Classes
Modifier and Type	Class and Description
`static class`	`ETEmail.Type` Email Types that can be used

Field Summary
- Fields inherited from class com.exacttarget.fuelsdk.ETSoapObject
  PAGE_SIZE

Constructor Summary

Constructors
Constructor and Description

ETEmail()
Class constructor, Initializes a new instance of the class.

Constructors
Constructor and Description
`ETEmail()` Class constructor, Initializes a new instance of the class.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Integer`	`getCategoryId()` Deprecated. Use `getFolderId()`.
`Date`	`getCreatedDate()`
`String`	`getCustomerKey()` Deprecated. Use `getKey()`.
`Integer`	`getFolderId()`
`String`	`getHtmlBody()`
`String`	`getId()`
`Boolean`	`getIsHtmlPaste()`
`String`	`getKey()`
`Date`	`getModifiedDate()`
`String`	`getName()`
`String`	`getSubject()`
`String`	`getTextBody()`
`ETEmail.Type`	`getType()`
`void`	`setCategoryId(Integer categoryId)` Deprecated. Use `setFolderId()`.
`void`	`setCreatedDate(Date createdDate)`
`void`	`setCustomerKey(String customerKey)` Deprecated. Use `setKey()`.
`void`	`setFolderId(Integer folderId)`
`void`	`setHtmlBody(String htmlBody)`
`void`	`setId(String id)`
`void`	`setIsHtmlPaste(Boolean isHtmlPaste)`
`void`	`setKey(String key)`
`void`	`setModifiedDate(Date modifiedDate)`
`void`	`setName(String name)`
`void`	`setSubject(String subject)`
`void`	`setTextBody(String textBody)`
`void`	`setType(ETEmail.Type type)`

Methods inherited from class com.exacttarget.fuelsdk.ETSoapObject
create, delete, delete, fromInternal, getInternalProperties, getInternalProperty, retrieve, retrieve, retrieve, retrieve, toFilterPart, toInternal, update

Methods inherited from class com.exacttarget.fuelsdk.ETApiObject
getAllModified, getModified, setModified

Methods inherited from class com.exacttarget.fuelsdk.ETObject
getAllFields, getAllFields, getClient, getField, getField, setClient, toString

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

- Constructor Detail
  - ETEmail
```
public ETEmail()
```
    Class constructor, Initializes a new instance of the class.
- Method Detail
  - getId
```
public String getId()
```
    Specified by:
    
    getId in class ETApiObject
    
    Returns:
    
    The Identifier of the ETEmail object.
  - setId
```
public void setId(String id)
```
    Specified by:
    
    setId in class ETApiObject
    
    Parameters:
    
    id - The Identifier of the ETEmail object.
  - getKey
```
public String getKey()
```
    Returns:
    
    The Customer Key of the ETEmail object.
  - setKey
```
public void setKey(String key)
```
    Parameters:
    
    key - The Customer Key of the ETEmail object.
  - getName
```
public String getName()
```
    Returns:
    
    The name of the ETEmail object.
  - setName
```
public void setName(String name)
```
    Parameters:
    
    name - The name of the ETEmail object.
  - getCreatedDate
```
public Date getCreatedDate()
```
    Returns:
    
    The created date of the ETEmail object.
  - setCreatedDate
```
public void setCreatedDate(Date createdDate)
```
    Parameters:
    
    createdDate - The created date of the ETEmail object.
  - getModifiedDate
```
public Date getModifiedDate()
```
    Returns:
    
    The modified date of the ETEmail object.
  - setModifiedDate
```
public void setModifiedDate(Date modifiedDate)
```
    Parameters:
    
    modifiedDate - The modified date of the ETEmail object.
  - getFolderId
```
public Integer getFolderId()
```
    Returns:
    
    The folder Id(category Id) of the ETEmail object.
  - setFolderId
```
public void setFolderId(Integer folderId)
```
    Parameters:
    
    folderId - The folder Id(category Id) of the ETEmail object.
  - getSubject
```
public String getSubject()
```
    Returns:
    
    The subject of the ETEmail object.
  - setSubject
```
public void setSubject(String subject)
```
    Parameters:
    
    subject - The subject of the ETEmail object.
  - getHtmlBody
```
public String getHtmlBody()
```
    Returns:
    
    The HTML body of the ETEmail object.
  - setHtmlBody
```
public void setHtmlBody(String htmlBody)
```
    Parameters:
    
    htmlBody - The HTML body of the ETEmail object.
  - getTextBody
```
public String getTextBody()
```
    Returns:
    
    The text body of the ETEmail object.
  - setTextBody
```
public void setTextBody(String textBody)
```
    Parameters:
    
    textBody - The text body of the ETEmail object.
  - getIsHtmlPaste
```
public Boolean getIsHtmlPaste()
```
    Returns:
    
    Returns true if it is HTML paste, false otherwise.
  - setIsHtmlPaste
```
public void setIsHtmlPaste(Boolean isHtmlPaste)
```
    Parameters:
    
    isHtmlPaste - Sets if it is HTML paste or not.
  - getType
```
public ETEmail.Type getType()
```
    Returns:
    
    key The type of the ETEmail object.
    
    See Also:
    
    ETEmail.Type
  - setType
```
public void setType(ETEmail.Type type)
```
    Parameters:
    
    type - The type of the ETEmail object.
    
    See Also:
    
    ETEmail.Type
  - getCustomerKey
```
@Deprecated
public String getCustomerKey()
```
    Deprecated. Use getKey().
  - setCustomerKey
```
@Deprecated
public void setCustomerKey(String customerKey)
```
    Deprecated. Use setKey().
  - getCategoryId
```
@Deprecated
public Integer getCategoryId()
```
    Deprecated. Use getFolderId().
  - setCategoryId
```
@Deprecated
public void setCategoryId(Integer categoryId)
```
    Deprecated. Use setFolderId().

Class ETEmail

Nested Class Summary

Nested classes/interfaces inherited from class com.exacttarget.fuelsdk.ETSoapObject

Field Summary

Fields inherited from class com.exacttarget.fuelsdk.ETSoapObject

Constructor Summary

Method Summary

Methods inherited from class com.exacttarget.fuelsdk.ETSoapObject

Methods inherited from class com.exacttarget.fuelsdk.ETApiObject

Methods inherited from class com.exacttarget.fuelsdk.ETObject

Methods inherited from class java.lang.Object

Constructor Detail

ETEmail

Method Detail

getId

setId

getKey

setKey

getName

setName

getCreatedDate

setCreatedDate

getModifiedDate

setModifiedDate

getFolderId

setFolderId

getSubject

setSubject

getHtmlBody

setHtmlBody

getTextBody

setTextBody

getIsHtmlPaste

setIsHtmlPaste

getType

setType

getCustomerKey

setCustomerKey

getCategoryId

setCategoryId