com.docusign.esign.model

Class EmailSettings

java.lang.Object

com.docusign.esign.model.EmailSettings

public class EmailSettings
extends Object

A complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. When the emailSettings information is used for an envelope, it only applies to that envelope. **IMPORTANT**: The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings. EmailSettings consists of: * replyEmailAddressOverride - The Reply To email used for the envelope. DocuSign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters. * replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters. * bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option. DocuSign verifies that the email format is correct, but does not verify that the email is active. Using this overrides the BCC for Email Archive information setting for this envelope. Maximum Length: 100 characters. *Example*: if your account has BCC for Email Archive set up for the email address '[email protected]' and you send an envelope using the BCC Email Override to send a BCC email to '[email protected]', then a copy of the envelope is only sent to the '[email protected]' email address.

Constructor Summary

Constructors

Constructor and Description
EmailSettings()

Method Summary

Methods

Modifier and Type	Method and Description
EmailSettings	addBccEmailAddressesItem(BccEmailAddress bccEmailAddressesItem)
EmailSettings	bccEmailAddresses(List<BccEmailAddress> bccEmailAddresses)
boolean	equals(Object o)
List<BccEmailAddress>	getBccEmailAddresses() A list of email addresses that receive a copy of all email communications for an envelope.
String	getReplyEmailAddressOverride()
String	getReplyEmailNameOverride()
int	hashCode()
EmailSettings	replyEmailAddressOverride(String replyEmailAddressOverride)
EmailSettings	replyEmailNameOverride(String replyEmailNameOverride)
void	setBccEmailAddresses(List<BccEmailAddress> bccEmailAddresses)
void	setReplyEmailAddressOverride(String replyEmailAddressOverride)
void	setReplyEmailNameOverride(String replyEmailNameOverride)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EmailSettings

public EmailSettings()

Method Detail

bccEmailAddresses

public EmailSettings bccEmailAddresses(List<BccEmailAddress> bccEmailAddresses)

addBccEmailAddressesItem

public EmailSettings addBccEmailAddressesItem(BccEmailAddress bccEmailAddressesItem)

getBccEmailAddresses

public List<BccEmailAddress> getBccEmailAddresses()

A list of email addresses that receive a copy of all email communications for an envelope. You can use this for archiving purposes.

Returns:

bccEmailAddresses

setBccEmailAddresses

public void setBccEmailAddresses(List<BccEmailAddress> bccEmailAddresses)

replyEmailAddressOverride

public EmailSettings replyEmailAddressOverride(String replyEmailAddressOverride)

getReplyEmailAddressOverride

public String getReplyEmailAddressOverride()

Returns:

replyEmailAddressOverride

setReplyEmailAddressOverride

public void setReplyEmailAddressOverride(String replyEmailAddressOverride)

replyEmailNameOverride

public EmailSettings replyEmailNameOverride(String replyEmailNameOverride)

getReplyEmailNameOverride

public String getReplyEmailNameOverride()

Returns:

replyEmailNameOverride

setReplyEmailNameOverride

public void setReplyEmailNameOverride(String replyEmailNameOverride)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object