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 java.util.List<java.lang.String>	bccAddresses
protected java.util.List<java.lang.String>	ccAddresses
protected java.lang.String	charset
protected java.util.List<java.lang.String>	documentAttachments
protected java.util.List<EmailFileAttachment>	fileAttachments
protected java.lang.String	htmlBody
protected javax.xml.bind.JAXBElement<java.lang.String>	inReplyTo
protected javax.xml.bind.JAXBElement<java.lang.String>	orgWideEmailAddressId
protected java.lang.String	plainTextBody
protected javax.xml.bind.JAXBElement<java.lang.String>	references
protected java.lang.String	targetObjectId
protected java.lang.String	templateId
protected java.util.List<java.lang.String>	toAddresses
protected java.lang.String	whatId

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

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

Constructor Summary

SingleEmailMessage()

Method Summary

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

ccAddresses

protected java.util.List<java.lang.String> ccAddresses

charset

protected java.lang.String charset

documentAttachments

protected java.util.List<java.lang.String> documentAttachments

htmlBody

protected java.lang.String htmlBody

inReplyTo

protected javax.xml.bind.JAXBElement<java.lang.String> inReplyTo

fileAttachments

protected java.util.List<EmailFileAttachment> fileAttachments

orgWideEmailAddressId

protected javax.xml.bind.JAXBElement<java.lang.String> orgWideEmailAddressId

plainTextBody

protected java.lang.String plainTextBody

references

protected javax.xml.bind.JAXBElement<java.lang.String> references

targetObjectId

protected java.lang.String targetObjectId

templateId

protected java.lang.String templateId

toAddresses

protected java.util.List<java.lang.String> toAddresses

whatId

protected java.lang.String whatId

Constructor Detail

SingleEmailMessage

public SingleEmailMessage()

Method Detail

getBccAddresses

public java.util.List<java.lang.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 java.util.List<java.lang.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 java.lang.String getCharset()

Gets the value of the charset property.

Returns:

possible object is String

setCharset

public void setCharset(java.lang.String value)

Sets the value of the charset property.

Parameters:

value - allowed object is String

getDocumentAttachments

public java.util.List<java.lang.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 java.lang.String getHtmlBody()

Gets the value of the htmlBody property.

Returns:

possible object is String

setHtmlBody

public void setHtmlBody(java.lang.String value)

Sets the value of the htmlBody property.

Parameters:

value - allowed object is String

getInReplyTo

public javax.xml.bind.JAXBElement<java.lang.String> getInReplyTo()

Gets the value of the inReplyTo property.

Returns:

possible object is JAXBElement<String>

setInReplyTo

public void setInReplyTo(javax.xml.bind.JAXBElement<java.lang.String> value)

Sets the value of the inReplyTo property.

Parameters:

value - allowed object is JAXBElement<String>

getFileAttachments

public java.util.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 javax.xml.bind.JAXBElement<java.lang.String> getOrgWideEmailAddressId()

Gets the value of the orgWideEmailAddressId property.

Returns:

possible object is JAXBElement<String>

setOrgWideEmailAddressId

public void setOrgWideEmailAddressId(javax.xml.bind.JAXBElement<java.lang.String> value)

Sets the value of the orgWideEmailAddressId property.

Parameters:

value - allowed object is JAXBElement<String>

getPlainTextBody

public java.lang.String getPlainTextBody()

Gets the value of the plainTextBody property.

Returns:

possible object is String

setPlainTextBody

public void setPlainTextBody(java.lang.String value)

Sets the value of the plainTextBody property.

Parameters:

value - allowed object is String

getReferences

public javax.xml.bind.JAXBElement<java.lang.String> getReferences()

Gets the value of the references property.

Returns:

possible object is JAXBElement<String>

setReferences

public void setReferences(javax.xml.bind.JAXBElement<java.lang.String> value)

Sets the value of the references property.

Parameters:

value - allowed object is JAXBElement<String>

getTargetObjectId

public java.lang.String getTargetObjectId()

Gets the value of the targetObjectId property.

Returns:

possible object is String

setTargetObjectId

public void setTargetObjectId(java.lang.String value)

Sets the value of the targetObjectId property.

Parameters:

value - allowed object is String

getTemplateId

public java.lang.String getTemplateId()

Gets the value of the templateId property.

Returns:

possible object is String

setTemplateId

public void setTemplateId(java.lang.String value)

Sets the value of the templateId property.

Parameters:

value - allowed object is String

getToAddresses

public java.util.List<java.lang.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 java.lang.String getWhatId()

Gets the value of the whatId property.

Returns:

possible object is String

setWhatId

public void setWhatId(java.lang.String value)

Sets the value of the whatId property.

Parameters:

value - allowed object is String