Package com.docusign.esign.model

Class 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 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address..

    • Constructor Detail

      • EmailSettings

        public EmailSettings()

    • Method Detail

      • addBccEmailAddressesItem

        public EmailSettings addBccEmailAddressesItem​(BccEmailAddress bccEmailAddressesItem)
        addBccEmailAddressesItem.
        Returns:
        EmailSettings

      • 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)
        setBccEmailAddresses.

      • replyEmailAddressOverride

        public EmailSettings replyEmailAddressOverride​(String replyEmailAddressOverride)
        replyEmailAddressOverride.
        Returns:
        EmailSettings

      • getReplyEmailAddressOverride

        public String getReplyEmailAddressOverride()
        .
        Returns:
        replyEmailAddressOverride

      • setReplyEmailAddressOverride

        public void setReplyEmailAddressOverride​(String replyEmailAddressOverride)
        setReplyEmailAddressOverride.

      • replyEmailNameOverride

        public EmailSettings replyEmailNameOverride​(String replyEmailNameOverride)
        replyEmailNameOverride.
        Returns:
        EmailSettings

      • getReplyEmailNameOverride

        public String getReplyEmailNameOverride()
        .
        Returns:
        replyEmailNameOverride

      • setReplyEmailNameOverride

        public void setReplyEmailNameOverride​(String replyEmailNameOverride)
        setReplyEmailNameOverride.

      • equals

        public boolean equals​(Object o)
        Compares objects.
        Overrides:
        equals in class Object
        Returns:
        true or false depending on comparison result.

      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class Object

      • toString

        public String toString()
        Converts the given object to string.
        Overrides:
        toString in class Object