com.sforce.soap.partner
Class SingleEmailMessage

java.lang.Object
  com.sforce.soap.partner.Email
      com.sforce.soap.partner.SingleEmailMessage

public class SingleEmailMessage
extends Email

Java class for SingleEmailMessage complex type.

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

 <complexType name="SingleEmailMessage">
   <complexContent>
     <extension base="{urn:partner.soap.sforce.com}Email">
       <sequence>
         <element name="bccAddresses" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="25" minOccurs="0"/>
         <element name="ccAddresses" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="25" minOccurs="0"/>
         <element name="charset" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="documentAttachments" type="{urn:partner.soap.sforce.com}ID" maxOccurs="unbounded" minOccurs="0"/>
         <element name="htmlBody" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="inReplyTo" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="fileAttachments" type="{urn:partner.soap.sforce.com}EmailFileAttachment" maxOccurs="unbounded" minOccurs="0"/>
         <element name="orgWideEmailAddressId" type="{urn:partner.soap.sforce.com}ID" minOccurs="0"/>
         <element name="plainTextBody" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="references" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="targetObjectId" type="{urn:partner.soap.sforce.com}ID"/>
         <element name="templateId" type="{urn:partner.soap.sforce.com}ID"/>
         <element name="toAddresses" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="100" minOccurs="0"/>
         <element name="whatId" type="{urn:partner.soap.sforce.com}ID"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

protected List<String>	bccAddresses
protected List<String>	ccAddresses
protected String	charset
protected List<String>	documentAttachments
protected List<EmailFileAttachment>	fileAttachments
protected String	htmlBody
protected JAXBElement<String>	inReplyTo
protected JAXBElement<String>	orgWideEmailAddressId
protected String	plainTextBody
protected JAXBElement<String>	references
protected String	targetObjectId
protected String	templateId
protected List<String>	toAddresses
protected String	whatId

Fields inherited from class com.sforce.soap.partner.Email

bccSender, emailPriority, replyTo, saveAsActivity, senderDisplayName, subject, useSignature

Constructor Summary

SingleEmailMessage()

Method Summary

List<String>	getBccAddresses() Gets the value of the bccAddresses property.
List<String>	getCcAddresses() Gets the value of the ccAddresses property.
String	getCharset() Gets the value of the charset property.
List<String>	getDocumentAttachments() Gets the value of the documentAttachments property.
List<EmailFileAttachment>	getFileAttachments() Gets the value of the fileAttachments property.
String	getHtmlBody() Gets the value of the htmlBody property.
JAXBElement<String>	getInReplyTo() Gets the value of the inReplyTo property.
JAXBElement<String>	getOrgWideEmailAddressId() Gets the value of the orgWideEmailAddressId property.
String	getPlainTextBody() Gets the value of the plainTextBody property.
JAXBElement<String>	getReferences() Gets the value of the references property.
String	getTargetObjectId() Gets the value of the targetObjectId property.
String	getTemplateId() Gets the value of the templateId property.
List<String>	getToAddresses() Gets the value of the toAddresses property.
String	getWhatId() Gets the value of the whatId property.
void	setCharset(String value) Sets the value of the charset property.
void	setHtmlBody(String value) Sets the value of the htmlBody property.
void	setInReplyTo(JAXBElement<String> value) Sets the value of the inReplyTo property.
void	setOrgWideEmailAddressId(JAXBElement<String> value) Sets the value of the orgWideEmailAddressId property.
void	setPlainTextBody(String value) Sets the value of the plainTextBody property.
void	setReferences(JAXBElement<String> value) Sets the value of the references property.
void	setTargetObjectId(String value) Sets the value of the targetObjectId property.
void	setTemplateId(String value) Sets the value of the templateId property.
void	setWhatId(String value) Sets the value of the whatId property.

Methods inherited from class com.sforce.soap.partner.Email

getEmailPriority, getReplyTo, getSenderDisplayName, getSubject, isBccSender, isSaveAsActivity, isUseSignature, setBccSender, setEmailPriority, setReplyTo, setSaveAsActivity, setSenderDisplayName, setSubject, setUseSignature

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

bccAddresses

protected List<String> bccAddresses

ccAddresses

protected List<String> ccAddresses

charset

protected String charset

documentAttachments

protected List<String> documentAttachments

htmlBody

protected String htmlBody

inReplyTo

protected JAXBElement<String> inReplyTo

fileAttachments

protected List<EmailFileAttachment> fileAttachments

orgWideEmailAddressId

protected JAXBElement<String> orgWideEmailAddressId

plainTextBody

protected String plainTextBody

references

protected JAXBElement<String> references

targetObjectId

protected String targetObjectId

templateId

protected String templateId

toAddresses

protected List<String> toAddresses

whatId

protected String whatId

Constructor Detail

SingleEmailMessage

public SingleEmailMessage()

Method Detail

getBccAddresses

public List<String> getBccAddresses()

Gets the value of the bccAddresses 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 bccAddresses property.

For example, to add a new item, do as follows:

    getBccAddresses().add(newItem);
 

Objects of the following type(s) are allowed in the list String

getCcAddresses

public List<String> getCcAddresses()

Gets the value of the ccAddresses 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 ccAddresses property.

For example, to add a new item, do as follows:

    getCcAddresses().add(newItem);
 

Objects of the following type(s) are allowed in the list String

getCharset

public String getCharset()

Gets the value of the charset property.

Returns:

possible object is String

setCharset

public void setCharset(String value)

Sets the value of the charset property.

Parameters:

value - allowed object is String

getDocumentAttachments

public List<String> getDocumentAttachments()

Gets the value of the documentAttachments 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 documentAttachments property.

For example, to add a new item, do as follows:

    getDocumentAttachments().add(newItem);
 

Objects of the following type(s) are allowed in the list String

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

getInReplyTo

public JAXBElement<String> getInReplyTo()

Gets the value of the inReplyTo property.

Returns:

possible object is JAXBElement<String>

setInReplyTo

public void setInReplyTo(JAXBElement<String> value)

Sets the value of the inReplyTo property.

Parameters:

value - allowed object is JAXBElement<String>

getFileAttachments

public List<EmailFileAttachment> getFileAttachments()

Gets the value of the fileAttachments 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 fileAttachments property.

For example, to add a new item, do as follows:

    getFileAttachments().add(newItem);
 

Objects of the following type(s) are allowed in the list EmailFileAttachment

getOrgWideEmailAddressId

public JAXBElement<String> getOrgWideEmailAddressId()

Gets the value of the orgWideEmailAddressId property.

Returns:

possible object is JAXBElement<String>

setOrgWideEmailAddressId

public void setOrgWideEmailAddressId(JAXBElement<String> value)

Sets the value of the orgWideEmailAddressId property.

Parameters:

value - allowed object is JAXBElement<String>

getPlainTextBody

public String getPlainTextBody()

Gets the value of the plainTextBody property.

Returns:

possible object is String

setPlainTextBody

public void setPlainTextBody(String value)

Sets the value of the plainTextBody property.

Parameters:

value - allowed object is String

getReferences

public JAXBElement<String> getReferences()

Gets the value of the references property.

Returns:

possible object is JAXBElement<String>

setReferences

public void setReferences(JAXBElement<String> value)

Sets the value of the references property.

Parameters:

value - allowed object is JAXBElement<String>

getTargetObjectId

public String getTargetObjectId()

Gets the value of the targetObjectId property.

Returns:

possible object is String

setTargetObjectId

public void setTargetObjectId(String value)

Sets the value of the targetObjectId property.

Parameters:

value - allowed object is String

getTemplateId

public String getTemplateId()

Gets the value of the templateId property.

Returns:

possible object is String

setTemplateId

public void setTemplateId(String value)

Sets the value of the templateId property.

Parameters:

value - allowed object is String

getToAddresses

public List<String> getToAddresses()

Gets the value of the toAddresses 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 toAddresses property.

For example, to add a new item, do as follows:

    getToAddresses().add(newItem);
 

Objects of the following type(s) are allowed in the list String

getWhatId

public String getWhatId()

Gets the value of the whatId property.

Returns:

possible object is String

setWhatId

public void setWhatId(String value)

Sets the value of the whatId property.

Parameters:

value - allowed object is String