Package com.sforce.soap.partner

Class SingleEmailMessage

java.lang.Object

com.sforce.soap.partner.Email

com.sforce.soap.partner.SingleEmailMessage

All Implemented Interfaces:

IEmail, ISingleEmailMessage, XMLizable

public class SingleEmailMessage
extends Email
implements ISingleEmailMessage

This is a generated class for the SObject Enterprise API. Do not edit this file, as your changes will be lost.

Constructor Summary

Constructors

Constructor	Description
SingleEmailMessage()	Constructor

Method Summary

Modifier and Type	Method	Description
String[]	getBccAddresses()	element : bccAddresses of type {http://www.w3.org/2001/XMLSchema}string java type: java.lang.String[]
String[]	getCcAddresses()	element : ccAddresses of type {http://www.w3.org/2001/XMLSchema}string java type: java.lang.String[]
String	getCharset()	element : charset of type {http://www.w3.org/2001/XMLSchema}string java type: java.lang.String
String[]	getDocumentAttachments()	element : documentAttachments of type {urn:partner.soap.sforce.com}ID java type: java.lang.String[]
String[]	getEntityAttachments()	element : entityAttachments of type {urn:partner.soap.sforce.com}ID java type: java.lang.String[]
EmailFileAttachment[]	getFileAttachments()	element : fileAttachments of type {urn:partner.soap.sforce.com}EmailFileAttachment java type: com.sforce.soap.partner.EmailFileAttachment[]
String	getHtmlBody()	element : htmlBody of type {http://www.w3.org/2001/XMLSchema}string java type: java.lang.String
String	getInReplyTo()	element : inReplyTo of type {http://www.w3.org/2001/XMLSchema}string java type: java.lang.String
Boolean	getOneClickPost()	element : oneClickPost of type {http://www.w3.org/2001/XMLSchema}boolean java type: java.lang.Boolean
SendEmailOptOutPolicy	getOptOutPolicy()	element : optOutPolicy of type {urn:partner.soap.sforce.com}SendEmailOptOutPolicy java type: com.sforce.soap.partner.SendEmailOptOutPolicy
String	getOrgWideEmailAddressId()	element : orgWideEmailAddressId of type {urn:partner.soap.sforce.com}ID java type: java.lang.String
String	getPlainTextBody()	element : plainTextBody of type {http://www.w3.org/2001/XMLSchema}string java type: java.lang.String
String	getReferences()	element : references of type {http://www.w3.org/2001/XMLSchema}string java type: java.lang.String
String	getTargetObjectId()	element : targetObjectId of type {urn:partner.soap.sforce.com}ID java type: java.lang.String
String	getTemplateId()	element : templateId of type {urn:partner.soap.sforce.com}ID java type: java.lang.String
String	getTemplateName()	element : templateName of type {http://www.w3.org/2001/XMLSchema}string java type: java.lang.String
String[]	getToAddresses()	element : toAddresses of type {http://www.w3.org/2001/XMLSchema}string java type: java.lang.String[]
Boolean	getTreatBodiesAsTemplate()	element : treatBodiesAsTemplate of type {http://www.w3.org/2001/XMLSchema}boolean java type: java.lang.Boolean
Boolean	getTreatTargetObjectAsRecipient()	element : treatTargetObjectAsRecipient of type {http://www.w3.org/2001/XMLSchema}boolean java type: java.lang.Boolean
String	getUnsubscribeComment()	element : unsubscribeComment of type {http://www.w3.org/2001/XMLSchema}string java type: java.lang.String
String[]	getUnsubscribeUrls()	element : unsubscribeUrls of type {http://www.w3.org/2001/XMLSchema}string java type: java.lang.String[]
String	getWhatId()	element : whatId of type {urn:partner.soap.sforce.com}ID java type: java.lang.String
void	load(XmlInputStream __in, TypeMapper __typeMapper)
protected void	loadFields(XmlInputStream __in, TypeMapper __typeMapper)
protected void	setBccAddresses(XmlInputStream __in, TypeMapper __typeMapper)
void	setBccAddresses(String[] bccAddresses)
protected void	setCcAddresses(XmlInputStream __in, TypeMapper __typeMapper)
void	setCcAddresses(String[] ccAddresses)
protected void	setCharset(XmlInputStream __in, TypeMapper __typeMapper)
void	setCharset(String charset)
protected void	setDocumentAttachments(XmlInputStream __in, TypeMapper __typeMapper)
void	setDocumentAttachments(String[] documentAttachments)
protected void	setEntityAttachments(XmlInputStream __in, TypeMapper __typeMapper)
void	setEntityAttachments(String[] entityAttachments)
void	setFileAttachments(IEmailFileAttachment[] fileAttachments)
protected void	setFileAttachments(XmlInputStream __in, TypeMapper __typeMapper)
protected void	setHtmlBody(XmlInputStream __in, TypeMapper __typeMapper)
void	setHtmlBody(String htmlBody)
protected void	setInReplyTo(XmlInputStream __in, TypeMapper __typeMapper)
void	setInReplyTo(String inReplyTo)
protected void	setOneClickPost(XmlInputStream __in, TypeMapper __typeMapper)
void	setOneClickPost(Boolean oneClickPost)
void	setOptOutPolicy(SendEmailOptOutPolicy optOutPolicy)
protected void	setOptOutPolicy(XmlInputStream __in, TypeMapper __typeMapper)
protected void	setOrgWideEmailAddressId(XmlInputStream __in, TypeMapper __typeMapper)
void	setOrgWideEmailAddressId(String orgWideEmailAddressId)
protected void	setPlainTextBody(XmlInputStream __in, TypeMapper __typeMapper)
void	setPlainTextBody(String plainTextBody)
protected void	setReferences(XmlInputStream __in, TypeMapper __typeMapper)
void	setReferences(String references)
protected void	setTargetObjectId(XmlInputStream __in, TypeMapper __typeMapper)
void	setTargetObjectId(String targetObjectId)
protected void	setTemplateId(XmlInputStream __in, TypeMapper __typeMapper)
void	setTemplateId(String templateId)
protected void	setTemplateName(XmlInputStream __in, TypeMapper __typeMapper)
void	setTemplateName(String templateName)
protected void	setToAddresses(XmlInputStream __in, TypeMapper __typeMapper)
void	setToAddresses(String[] toAddresses)
protected void	setTreatBodiesAsTemplate(XmlInputStream __in, TypeMapper __typeMapper)
void	setTreatBodiesAsTemplate(Boolean treatBodiesAsTemplate)
protected void	setTreatTargetObjectAsRecipient(XmlInputStream __in, TypeMapper __typeMapper)
void	setTreatTargetObjectAsRecipient(Boolean treatTargetObjectAsRecipient)
protected void	setUnsubscribeComment(XmlInputStream __in, TypeMapper __typeMapper)
void	setUnsubscribeComment(String unsubscribeComment)
protected void	setUnsubscribeUrls(XmlInputStream __in, TypeMapper __typeMapper)
void	setUnsubscribeUrls(String[] unsubscribeUrls)
protected void	setWhatId(XmlInputStream __in, TypeMapper __typeMapper)
void	setWhatId(String whatId)
String	toString()
void	write(QName __element, XmlOutputStream __out, TypeMapper __typeMapper)
protected void	writeFields(XmlOutputStream __out, TypeMapper __typeMapper)

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

getBccSender, getEmailPriority, getReplyTo, getSaveAsActivity, getSenderDisplayName, getSubject, getUseSignature, setBccSender, setBccSender, setEmailPriority, setEmailPriority, setReplyTo, setReplyTo, setSaveAsActivity, setSaveAsActivity, setSenderDisplayName, setSenderDisplayName, setSubject, setSubject, setUseSignature, setUseSignature

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sforce.soap.partner.IEmail

getBccSender, getEmailPriority, getReplyTo, getSaveAsActivity, getSenderDisplayName, getSubject, getUseSignature, setBccSender, setEmailPriority, setReplyTo, setSaveAsActivity, setSenderDisplayName, setSubject, setUseSignature

Constructor Details

SingleEmailMessage

public SingleEmailMessage()

Constructor

Method Details

getBccAddresses

public String[] getBccAddresses()

Description copied from interface: ISingleEmailMessage

element : bccAddresses of type {http://www.w3.org/2001/XMLSchema}string java type: java.lang.String[]

Specified by:

getBccAddresses in interface ISingleEmailMessage

setBccAddresses

public void setBccAddresses(String[] bccAddresses)

Specified by:

setBccAddresses in interface ISingleEmailMessage

setBccAddresses

protected void setBccAddresses(XmlInputStream __in,
 TypeMapper __typeMapper)
                        throws IOException,
ConnectionException

Throws:

IOException

ConnectionException

getCcAddresses

public String[] getCcAddresses()

Description copied from interface: ISingleEmailMessage

element : ccAddresses of type {http://www.w3.org/2001/XMLSchema}string java type: java.lang.String[]

Specified by:

getCcAddresses in interface ISingleEmailMessage

setCcAddresses

public void setCcAddresses(String[] ccAddresses)

Specified by:

setCcAddresses in interface ISingleEmailMessage

setCcAddresses

protected void setCcAddresses(XmlInputStream __in,
 TypeMapper __typeMapper)
                       throws IOException,
ConnectionException

Throws:

IOException

ConnectionException

getCharset

public String getCharset()

Description copied from interface: ISingleEmailMessage

element : charset of type {http://www.w3.org/2001/XMLSchema}string java type: java.lang.String

Specified by:

getCharset in interface ISingleEmailMessage

setCharset

public void setCharset(String charset)

Specified by:

setCharset in interface ISingleEmailMessage

setCharset

protected void setCharset(XmlInputStream __in,
 TypeMapper __typeMapper)
                   throws IOException,
ConnectionException

Throws:

IOException

ConnectionException

getDocumentAttachments

public String[] getDocumentAttachments()

Description copied from interface: ISingleEmailMessage

element : documentAttachments of type {urn:partner.soap.sforce.com}ID java type: java.lang.String[]

Specified by:

getDocumentAttachments in interface ISingleEmailMessage

setDocumentAttachments

public void setDocumentAttachments(String[] documentAttachments)

Specified by:

setDocumentAttachments in interface ISingleEmailMessage

setDocumentAttachments

protected void setDocumentAttachments(XmlInputStream __in,
 TypeMapper __typeMapper)
                               throws IOException,
ConnectionException

Throws:

IOException

ConnectionException

getEntityAttachments

public String[] getEntityAttachments()

Description copied from interface: ISingleEmailMessage

element : entityAttachments of type {urn:partner.soap.sforce.com}ID java type: java.lang.String[]

Specified by:

getEntityAttachments in interface ISingleEmailMessage

setEntityAttachments

public void setEntityAttachments(String[] entityAttachments)

Specified by:

setEntityAttachments in interface ISingleEmailMessage

setEntityAttachments

protected void setEntityAttachments(XmlInputStream __in,
 TypeMapper __typeMapper)
                             throws IOException,
ConnectionException

Throws:

IOException

ConnectionException

getFileAttachments

public EmailFileAttachment[] getFileAttachments()

Description copied from interface: ISingleEmailMessage

element : fileAttachments of type {urn:partner.soap.sforce.com}EmailFileAttachment java type: com.sforce.soap.partner.EmailFileAttachment[]

Specified by:

getFileAttachments in interface ISingleEmailMessage

setFileAttachments

public void setFileAttachments(IEmailFileAttachment[] fileAttachments)

Specified by:

setFileAttachments in interface ISingleEmailMessage

setFileAttachments

protected void setFileAttachments(XmlInputStream __in,
 TypeMapper __typeMapper)
                           throws IOException,
ConnectionException

Throws:

IOException

ConnectionException

getHtmlBody

public String getHtmlBody()

Description copied from interface: ISingleEmailMessage

element : htmlBody of type {http://www.w3.org/2001/XMLSchema}string java type: java.lang.String

Specified by:

getHtmlBody in interface ISingleEmailMessage

setHtmlBody

public void setHtmlBody(String htmlBody)

Specified by:

setHtmlBody in interface ISingleEmailMessage

setHtmlBody

protected void setHtmlBody(XmlInputStream __in,
 TypeMapper __typeMapper)
                    throws IOException,
ConnectionException

Throws:

IOException

ConnectionException

getInReplyTo

public String getInReplyTo()

Description copied from interface: ISingleEmailMessage

element : inReplyTo of type {http://www.w3.org/2001/XMLSchema}string java type: java.lang.String

Specified by:

getInReplyTo in interface ISingleEmailMessage

setInReplyTo

public void setInReplyTo(String inReplyTo)

Specified by:

setInReplyTo in interface ISingleEmailMessage

setInReplyTo

protected void setInReplyTo(XmlInputStream __in,
 TypeMapper __typeMapper)
                     throws IOException,
ConnectionException

Throws:

IOException

ConnectionException

getOneClickPost

public Boolean getOneClickPost()

Description copied from interface: ISingleEmailMessage

element : oneClickPost of type {http://www.w3.org/2001/XMLSchema}boolean java type: java.lang.Boolean

Specified by:

getOneClickPost in interface ISingleEmailMessage

setOneClickPost

public void setOneClickPost(Boolean oneClickPost)

Specified by:

setOneClickPost in interface ISingleEmailMessage

setOneClickPost

protected void setOneClickPost(XmlInputStream __in,
 TypeMapper __typeMapper)
                        throws IOException,
ConnectionException

Throws:

IOException

ConnectionException

getOptOutPolicy

public SendEmailOptOutPolicy getOptOutPolicy()

Description copied from interface: ISingleEmailMessage

element : optOutPolicy of type {urn:partner.soap.sforce.com}SendEmailOptOutPolicy java type: com.sforce.soap.partner.SendEmailOptOutPolicy

Specified by:

getOptOutPolicy in interface ISingleEmailMessage

setOptOutPolicy

public void setOptOutPolicy(SendEmailOptOutPolicy optOutPolicy)

Specified by:

setOptOutPolicy in interface ISingleEmailMessage

setOptOutPolicy

protected void setOptOutPolicy(XmlInputStream __in,
 TypeMapper __typeMapper)
                        throws IOException,
ConnectionException

Throws:

IOException

ConnectionException

getOrgWideEmailAddressId

public String getOrgWideEmailAddressId()

Description copied from interface: ISingleEmailMessage

element : orgWideEmailAddressId of type {urn:partner.soap.sforce.com}ID java type: java.lang.String

Specified by:

getOrgWideEmailAddressId in interface ISingleEmailMessage

setOrgWideEmailAddressId

public void setOrgWideEmailAddressId(String orgWideEmailAddressId)

Specified by:

setOrgWideEmailAddressId in interface ISingleEmailMessage

setOrgWideEmailAddressId

protected void setOrgWideEmailAddressId(XmlInputStream __in,
 TypeMapper __typeMapper)
                                 throws IOException,
ConnectionException

Throws:

IOException

ConnectionException

getPlainTextBody

public String getPlainTextBody()

Description copied from interface: ISingleEmailMessage

element : plainTextBody of type {http://www.w3.org/2001/XMLSchema}string java type: java.lang.String

Specified by:

getPlainTextBody in interface ISingleEmailMessage

setPlainTextBody

public void setPlainTextBody(String plainTextBody)

Specified by:

setPlainTextBody in interface ISingleEmailMessage

setPlainTextBody

protected void setPlainTextBody(XmlInputStream __in,
 TypeMapper __typeMapper)
                         throws IOException,
ConnectionException

Throws:

IOException

ConnectionException

getReferences

public String getReferences()

Description copied from interface: ISingleEmailMessage

element : references of type {http://www.w3.org/2001/XMLSchema}string java type: java.lang.String

Specified by:

getReferences in interface ISingleEmailMessage

setReferences

public void setReferences(String references)

Specified by:

setReferences in interface ISingleEmailMessage

setReferences

protected void setReferences(XmlInputStream __in,
 TypeMapper __typeMapper)
                      throws IOException,
ConnectionException

Throws:

IOException

ConnectionException

getTargetObjectId

public String getTargetObjectId()

Description copied from interface: ISingleEmailMessage

element : targetObjectId of type {urn:partner.soap.sforce.com}ID java type: java.lang.String

Specified by:

getTargetObjectId in interface ISingleEmailMessage

setTargetObjectId

public void setTargetObjectId(String targetObjectId)

Specified by:

setTargetObjectId in interface ISingleEmailMessage

setTargetObjectId

protected void setTargetObjectId(XmlInputStream __in,
 TypeMapper __typeMapper)
                          throws IOException,
ConnectionException

Throws:

IOException

ConnectionException

getTemplateId

public String getTemplateId()

Description copied from interface: ISingleEmailMessage

element : templateId of type {urn:partner.soap.sforce.com}ID java type: java.lang.String

Specified by:

getTemplateId in interface ISingleEmailMessage

setTemplateId

public void setTemplateId(String templateId)

Specified by:

setTemplateId in interface ISingleEmailMessage

setTemplateId

protected void setTemplateId(XmlInputStream __in,
 TypeMapper __typeMapper)
                      throws IOException,
ConnectionException

Throws:

IOException

ConnectionException

getTemplateName

public String getTemplateName()

Description copied from interface: ISingleEmailMessage

element : templateName of type {http://www.w3.org/2001/XMLSchema}string java type: java.lang.String

Specified by:

getTemplateName in interface ISingleEmailMessage

setTemplateName

public void setTemplateName(String templateName)

Specified by:

setTemplateName in interface ISingleEmailMessage

setTemplateName

protected void setTemplateName(XmlInputStream __in,
 TypeMapper __typeMapper)
                        throws IOException,
ConnectionException

Throws:

IOException

ConnectionException

getToAddresses

public String[] getToAddresses()

Description copied from interface: ISingleEmailMessage

element : toAddresses of type {http://www.w3.org/2001/XMLSchema}string java type: java.lang.String[]

Specified by:

getToAddresses in interface ISingleEmailMessage

setToAddresses

public void setToAddresses(String[] toAddresses)

Specified by:

setToAddresses in interface ISingleEmailMessage

setToAddresses

protected void setToAddresses(XmlInputStream __in,
 TypeMapper __typeMapper)
                       throws IOException,
ConnectionException

Throws:

IOException

ConnectionException

getTreatBodiesAsTemplate

public Boolean getTreatBodiesAsTemplate()

Description copied from interface: ISingleEmailMessage

element : treatBodiesAsTemplate of type {http://www.w3.org/2001/XMLSchema}boolean java type: java.lang.Boolean

Specified by:

getTreatBodiesAsTemplate in interface ISingleEmailMessage

setTreatBodiesAsTemplate

public void setTreatBodiesAsTemplate(Boolean treatBodiesAsTemplate)

Specified by:

setTreatBodiesAsTemplate in interface ISingleEmailMessage

setTreatBodiesAsTemplate

protected void setTreatBodiesAsTemplate(XmlInputStream __in,
 TypeMapper __typeMapper)
                                 throws IOException,
ConnectionException

Throws:

IOException

ConnectionException

getTreatTargetObjectAsRecipient

public Boolean getTreatTargetObjectAsRecipient()

Description copied from interface: ISingleEmailMessage

element : treatTargetObjectAsRecipient of type {http://www.w3.org/2001/XMLSchema}boolean java type: java.lang.Boolean

Specified by:

getTreatTargetObjectAsRecipient in interface ISingleEmailMessage

setTreatTargetObjectAsRecipient

public void setTreatTargetObjectAsRecipient(Boolean treatTargetObjectAsRecipient)

Specified by:

setTreatTargetObjectAsRecipient in interface ISingleEmailMessage

setTreatTargetObjectAsRecipient

protected void setTreatTargetObjectAsRecipient(XmlInputStream __in,
 TypeMapper __typeMapper)
                                        throws IOException,
ConnectionException

Throws:

IOException

ConnectionException

getUnsubscribeComment

public String getUnsubscribeComment()

Description copied from interface: ISingleEmailMessage

element : unsubscribeComment of type {http://www.w3.org/2001/XMLSchema}string java type: java.lang.String

Specified by:

getUnsubscribeComment in interface ISingleEmailMessage

setUnsubscribeComment

public void setUnsubscribeComment(String unsubscribeComment)

Specified by:

setUnsubscribeComment in interface ISingleEmailMessage

setUnsubscribeComment

protected void setUnsubscribeComment(XmlInputStream __in,
 TypeMapper __typeMapper)
                              throws IOException,
ConnectionException

Throws:

IOException

ConnectionException

getUnsubscribeUrls

public String[] getUnsubscribeUrls()

Description copied from interface: ISingleEmailMessage

element : unsubscribeUrls of type {http://www.w3.org/2001/XMLSchema}string java type: java.lang.String[]

Specified by:

getUnsubscribeUrls in interface ISingleEmailMessage

setUnsubscribeUrls

public void setUnsubscribeUrls(String[] unsubscribeUrls)

Specified by:

setUnsubscribeUrls in interface ISingleEmailMessage

setUnsubscribeUrls

protected void setUnsubscribeUrls(XmlInputStream __in,
 TypeMapper __typeMapper)
                           throws IOException,
ConnectionException

Throws:

IOException

ConnectionException

getWhatId

public String getWhatId()

Description copied from interface: ISingleEmailMessage

element : whatId of type {urn:partner.soap.sforce.com}ID java type: java.lang.String

Specified by:

getWhatId in interface ISingleEmailMessage

setWhatId

public void setWhatId(String whatId)

Specified by:

setWhatId in interface ISingleEmailMessage

setWhatId

protected void setWhatId(XmlInputStream __in,
 TypeMapper __typeMapper)
                  throws IOException,
ConnectionException

Throws:

IOException

ConnectionException

write

public void write(QName __element,
 XmlOutputStream __out,
 TypeMapper __typeMapper)
           throws IOException

Specified by:

write in interface XMLizable

Overrides:

write in class Email

Throws:

IOException

writeFields

protected void writeFields(XmlOutputStream __out,
 TypeMapper __typeMapper)
                    throws IOException

Overrides:

writeFields in class Email

Throws:

IOException

load

public void load(XmlInputStream __in,
 TypeMapper __typeMapper)
          throws IOException,
ConnectionException

Specified by:

load in interface XMLizable

Overrides:

load in class Email

Throws:

IOException

ConnectionException

loadFields

protected void loadFields(XmlInputStream __in,
 TypeMapper __typeMapper)
                   throws IOException,
ConnectionException

Overrides:

loadFields in class Email

Throws:

IOException

ConnectionException

toString

public String toString()

Overrides:

toString in class Email