Current section
Files
Jump to
Current section
Files
lib/ex_campaign_monitor.ex
defmodule ExCampaignMonitor do
@moduledoc """
A wrapper for the Campaign Monitor JSON API
1. Install the package by adding `ex_campaign_monitor` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:ex_campaign_monitor, "~> 0.2"}
]
end
```
2. Add your Campaign Monitor account API key and a List ID to your application's config:
```elixir
config :ex_campaign_monitor,
:api_key, "YOUR_API_KEY",
:list_id, "YOUR_LIST_ID",
```
3. Call a function on the `ExCampaignMonitor` module, for example:
```elixir
defmodule MyApp.PageController do
use MyAppWeb, :controller
def index(conn, params) do
ExCampaignMonitor.add_subscriber(%{
email: params["email"], # email address of the user you want to subscribe
consent_to_track: "Yes" # https://help.campaignmonitor.com/consent-to-track
})
send_resp(conn, "Subscriber added")
end
end
"""
alias ExCampaignMonitor.{Lists, Subscribers, Transactional}
###
### Subscribers
###
@doc """
Add a new subscriber to your list
```elixir
ExCampaignMonitor.add_subscriber(%{email: "someone@domain.com", consent_to_track: "Yes"})
> {:ok, %Subscriber{email: "someone@domain", consent_to_track: "Yes"}}
```
"""
defdelegate add_subscriber(subscriber), to: Subscribers
@doc """
Update an existing subscriber from your list
```elixir
ExCampaignMonitor.update_subscriber(%{
old_email: "someone@domain.com",
new_email: "person@domain.com",
consent_to_track: "Yes"
})
> {:ok, %Subscriber{email: "person@domain.com", consent_to_track: "Yes"}}
```
"""
defdelegate update_subscriber(subscriber), to: Subscribers
@doc """
Import many subscribers to your list
```elixir
ExCampaignMonitor.import_subscribers([
%{
email: "someone@domain.com",
consent_to_track: "Yes"
},
%{
email: "person@domain.com",
consent_to_track: "No"
}
])
> {:ok, 2}
```
"""
defdelegate import_subscribers(subscribers), to: Subscribers
@doc """
Get a single subscriber by their email address
```elixir
ExCampaignMonitor.get_subscriber_by_email("person@domain.com")
> {:ok, %Subscriber{email: "person@domain.com", consent_to_track: "Yes"}}
```
"""
defdelegate get_subscriber_by_email(email),
to: Subscribers,
as: :get_subscriber
@doc """
Unsubscribe someone who is currently subscribed to your list
```elixir
ExCampaignMonitor.unsubscribe("person@domain.com")
> {:ok, :unsubscribed}
```
"""
defdelegate unsubscribe(subscriber), to: Subscribers
@doc """
Remove (delete) a single subscriber from your list
```elixir
ExCampaignMonitor.remove_subscriber("person@domain.com")
> {:ok, :removed}
```
"""
defdelegate remove_subscriber(subscriber), to: Subscribers
###
### Lists
###
@doc """
Create a new list
```elixir
ExCampaignMonitor.create_list(%{title: "my list"})
> {:ok, %List{title: "my list"}}
```
"""
defdelegate create_list(list), to: Lists
@doc """
Get details for a List by ID
```elixir
ExCampaignMonitor.get_list_by_id("a1a1a1a1")
> {:ok, %List{title: "my list", list_id: "a1a1a1a1"}}
```
"""
defdelegate get_list_by_id(list_id), to: Lists
@doc """
Get active subscribers for a list
```elixir
ExCampaignMonitor.get_active_subscribers("a1a1a1a1")
> {:ok, %List{list_id: "a1a1a1a1"}, subscribers: [%Subscriber{status: "active"}]}
```
"""
defdelegate get_active_subscribers(list_id), to: Lists
@doc """
Create a webhook for a list
```elixir
ExCampaignMonitor.create_webhook("a1a1a1a1", ["Subscribe"], "http://mywebsite.com/subscribe", "json")
> {:ok, "webhook_id-982u981u298u298u2e9u289e"}
```
"""
defdelegate create_webhook(list_id, events, url, payload_format \\ "json"), to: Lists
@doc """
Activate a specific webhook, via the webhook's ID
```elixir
ExCampaignMonitor.activate_webhook("a1a1a1a1", "webhook-b1b1b1b1")
> :ok
```
"""
defdelegate activate_webhook(list_id, webhook_id), to: Lists
@doc """
List all webhooks created for the list ID provided.
```elixir
ExCampaignMonitor.list_webhooks("a1a1a1a1")
> {:ok, [
%{
"WebhookID": "ee1b3864e5ca61618q98su98qsu9q",
"Events": [
"Subscribe"
],
"Url": "http://example.com/subscribe",
"Status": "Active",
"PayloadFormat": "Json"
}
]
}
```
"""
defdelegate list_webhooks(list_id), to: Lists
@doc """
Delete a webhook by webhook_id
```elixir
ExCampaignMonitor.delete_webhook("a1a1a1a1", "webhook_id-982u981u298u298u2e9u289e")
> {:ok, :webhook_deleted}
```
"""
defdelegate delete_webhook(list_id, webhook_id), to: Lists
@doc """
Send a transactional smart email
```elixir
ExCampaignMonitor.send_smart_email("a1a1a1a1", %{
to: ["jack@jackmarchant.com"],
data: %{new_password_url: "https://mywebapp.com/newpwd?uid=jguf45h74gf"}
})
```
"""
defdelegate send_smart_email(smart_email_id, data), to: Transactional
end