zendesk-messaging-client
    Preparing search index...

    Type Alias MailgunReadable

    MailgunReadable: IntegrationReadable & { type: "mailgun" } & {
        domain: string;
        fromAddress?: string | null;
        hideUnsubscribeLink?: boolean;
        incomingAddress: string;
        type?: string;
    } & DefaultResponderReadable

    Type declaration

    • type: "mailgun"
    • domain: string

      The domain used to relay email. This domain must be configured and verified in your Mailgun account.

    • OptionalfromAddress?: string | null

      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.

    • OptionalhideUnsubscribeLink?: boolean

      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.

    • incomingAddress: string

      Sunshine Conversations will receive all emails sent to this address. It will also be used as the Reply-To address.

    • Optionaltype?: string

      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.

    Settings

    Member Visibility