Outkit.Message (Outkit v0.0.5) View Source

This module lets you render/send or retrieve a message using Outkit’s API.

Example

# Create a message
{:ok, message} = Outkit.Message.create(%{
  type: "email",                   # Message type - 'email' and 'sms' currently supported
  project: "my-project",           # Outkit project identifier (managed through our web UI)
  template: "my-template",         # Template identifier (managed through our web UI)
  subject: "Welcome, Jane!",       # Email subject (optional, can also be set in the template or omitted for SMS messages)
  to: "some.name@example.com",     # Recipient address (and optional name)
  from: "other.name@example.com",  # Sender address (and optional name)
  data: %{
      name: "John Doe",
      # ...
      # Add the values for any variables used in the template here
  },
})

# Retrieve a message
{:ok, message} = Outkit.Message.get("some-id")

Link to this section Summary

Functions

create(message)

Create a message based on a map. The client will be derived from your configuration.

create(client, message)

Create a message based on a map. Uses an Outkit.Client.

get(id)

Retrieve a message using an id. The client will be derived from your configuration.

get(client, id)

Retrieve a message using an Outkit.Client and an id.

new(message)

Creates a new Outkit.Message struct. Mostly used indirectly through the get and create functions.

Link to this section Functions

create(message)

Create a message based on a map. The client will be derived from your configuration.

Examples

create(%{
  type: "email",
  project: "acme-project",
  template: "welcome",
})

create(client, message)

Create a message based on a map. Uses an Outkit.Client.

Examples

client = Outkit.Client.new(key: "my-key", secret: "my-secret", passphrase: "my-passphrase")
create(client, %{
  type: "email",
  project: "acme-project",
  template: "welcome",
})

get(id)

Retrieve a message using an id. The client will be derived from your configuration.

Examples

get("some-id")

get(client, id)

Retrieve a message using an Outkit.Client and an id.

Examples

client = Outkit.Client.new(key: "my-key", secret: "my-secret", passphrase: "my-passphrase")
get(client, "some-id")

new(message)

Creates a new Outkit.Message struct. Mostly used indirectly through the get and create functions.

Examples

new(%{
  type: "email",
  project: "acme-project",
  template: "welcome",
})