Package com.zendesk.sunshine_conversations_client.model

Class Mailgun

    • Field Detail

      • JSON_PROPERTY_TYPE

        public static final java.lang.String JSON_PROPERTY_TYPE
        See Also:
        Constant Field Values

      • type

        protected java.lang.String type

      • JSON_PROPERTY_API_KEY

        public static final java.lang.String JSON_PROPERTY_API_KEY
        See Also:
        Constant Field Values

      • JSON_PROPERTY_DOMAIN

        public static final java.lang.String JSON_PROPERTY_DOMAIN
        See Also:
        Constant Field Values

      • JSON_PROPERTY_INCOMING_ADDRESS

        public static final java.lang.String JSON_PROPERTY_INCOMING_ADDRESS
        See Also:
        Constant Field Values

      • JSON_PROPERTY_HIDE_UNSUBSCRIBE_LINK

        public static final java.lang.String JSON_PROPERTY_HIDE_UNSUBSCRIBE_LINK
        See Also:
        Constant Field Values

      • JSON_PROPERTY_FROM_ADDRESS

        public static final java.lang.String JSON_PROPERTY_FROM_ADDRESS
        See Also:
        Constant Field Values

      • JSON_PROPERTY_DEFAULT_RESPONDER_ID

        public static final java.lang.String JSON_PROPERTY_DEFAULT_RESPONDER_ID
        See Also:
        Constant Field Values

      • JSON_PROPERTY_DEFAULT_RESPONDER

        public static final java.lang.String JSON_PROPERTY_DEFAULT_RESPONDER
        See Also:
        Constant Field Values

    • Constructor Detail

      • Mailgun

        public Mailgun()

    • Method Detail

      • getType

        @Nullable
public java.lang.String getType()
        To configure a Mailgun integration, visit the API Keys tab in the settings page of the Mailgun dashboard and copy your active API key. Call the Create Integration endpoint with your API Key, a domain you have configured in Mailgun, and the incoming address you would like to use. Must have the same domain as the one specified in the domain parameter.
        Overrides:
        getType in class Integration
        Returns:
        type

      • setType

        public void setType​(java.lang.String type)
        Overrides:
        setType in class Integration

      • apiKey

        public Mailgun apiKey​(java.lang.String apiKey)

      • getApiKey

        public java.lang.String getApiKey()
        The public API key of your Mailgun account.
        Returns:
        apiKey

      • setApiKey

        public void setApiKey​(java.lang.String apiKey)

      • domain

        public Mailgun domain​(java.lang.String domain)

      • getDomain

        public java.lang.String getDomain()
        The domain used to relay email. This domain must be configured and verified in your Mailgun account.
        Returns:
        domain

      • setDomain

        public void setDomain​(java.lang.String domain)

      • incomingAddress

        public Mailgun incomingAddress​(java.lang.String incomingAddress)

      • getIncomingAddress

        public java.lang.String getIncomingAddress()
        Sunshine Conversations will receive all emails sent to this address. It will also be used as the Reply-To address.
        Returns:
        incomingAddress

      • setIncomingAddress

        public void setIncomingAddress​(java.lang.String incomingAddress)

      • hideUnsubscribeLink

        public Mailgun hideUnsubscribeLink​(java.lang.Boolean hideUnsubscribeLink)

      • getHideUnsubscribeLink

        @Nullable
public java.lang.Boolean getHideUnsubscribeLink()
        A boolean value indicating whether the unsubscribe link should be omitted from outgoing emails. When enabled, it is expected that the business is providing the user a way to unsubscribe by some other means. By default, the unsubscribe link will be included in all outgoing emails.
        Returns:
        hideUnsubscribeLink

      • setHideUnsubscribeLink

        public void setHideUnsubscribeLink​(java.lang.Boolean hideUnsubscribeLink)

      • fromAddress

        public Mailgun fromAddress​(java.lang.String fromAddress)

      • getFromAddress

        @Nullable
public java.lang.String getFromAddress()
        Email address to use as the From and Reply-To address if it must be different from incomingAddress. Only use this option if the address that you supply is configured to forward emails to the incomingAddress, otherwise user replies will be lost. You must also make sure that the domain is properly configured as a mail provider so as to not be flagged as spam by the user’s email client. May be unset with null.
        Returns:
        fromAddress

      • getFromAddress_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<java.lang.String> getFromAddress_JsonNullable()

      • setFromAddress_JsonNullable

        public void setFromAddress_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> fromAddress)

      • setFromAddress

        public void setFromAddress​(java.lang.String fromAddress)

      • defaultResponderId

        public Mailgun defaultResponderId​(java.lang.String defaultResponderId)

      • getDefaultResponderId

        @Nullable
public java.lang.String getDefaultResponderId()
        The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to <a href=\"https://docs.smooch.io/guide/switchboard/#per-channel-default-responder\">Per-channel default responder</a> guide.
        Returns:
        defaultResponderId

      • getDefaultResponderId_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<java.lang.String> getDefaultResponderId_JsonNullable()

      • setDefaultResponderId_JsonNullable

        public void setDefaultResponderId_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> defaultResponderId)

      • setDefaultResponderId

        public void setDefaultResponderId​(java.lang.String defaultResponderId)

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class Integration