Sha256: 5b38dcfe266feae2131ee3510a338aecdb1385c339bd33e9e4785b0580b8543a
Contents?: true
Size: 1.86 KB
Versions: 5
Compression:
Stored size: 1.86 KB
Contents
# SunshineConversationsClient::Mailgun
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **String** | The type of integration. | [optional] [default to 'mailgun']
**api_key** | **String** | The public API key of your Mailgun account. |
**domain** | **String** | The domain used to relay email. This domain must be configured and verified in your Mailgun account. |
**incoming_address** | **String** | Sunshine Conversations will receive all emails sent to this address. It will also be used as the Reply-To address. |
**hide_unsubscribe_link** | **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. | [optional]
**from_address** | **String** | 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. | [optional]
## Code Sample
```ruby
require 'SunshineConversationsClient'
instance = SunshineConversationsClient::Mailgun.new(type: null,
api_key: key-f265hj32f0sd897lqd2j5keb96784043,
domain: sandbox123.mailgun.org,
incoming_address: mytestemail@sandbox123.mailgun.org,
hide_unsubscribe_link: null,
from_address: test@sandbox123.mailgun.org)
```
Version data entries
5 entries across 5 versions & 1 rubygems