Class: Axene::Mailer::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/axene/mailer/client.rb

Overview

Axene Mailer API client. Composes the HTTP transport with the resource groups. This is the entry point most code touches.

Examples:

client = Axene::Mailer::Client.new(api_key: ENV.fetch("AXENE_API_KEY"))
client.emails.send(
  from: "hello@yourdomain.com",
  to: "customer@example.com",
  subject: "Your receipt",
  html: "<p>Thanks for your order.</p>"
)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_key:, base_url: Transport::DEFAULT_BASE_URL, max_retries: 3, timeout: 30) ⇒ Client

Returns a new instance of Client.

Parameters:

  • api_key (String) —

    required; starts with “axm_k_”

  • base_url (String) (defaults to: Transport::DEFAULT_BASE_URL) —

    default “mail.axene.io”

  • max_retries (Integer) (defaults to: 3) —

    retries for 429/5xx, default 3

  • timeout (Numeric) (defaults to: 30) —

    per-request timeout in seconds, default 30



42
43
44
45
46
47
48
49
50
 
# File 'lib/axene/mailer/client.rb', line 42

def initialize(api_key:, base_url: Transport::DEFAULT_BASE_URL, max_retries: 3, timeout: 30)
  transport = Transport.new(api_key: api_key, base_url: base_url, max_retries: max_retries, timeout: timeout)
  @emails = Resources::Emails.new(transport)
  @domains = Resources::Domains.new(transport)
  @contacts = Resources::Contacts.new(transport)
  @suppressions = Resources::Suppressions.new(transport)
  @templates = Resources::Templates.new(transport)
  @webhooks = Resources::Webhooks.new(transport)
end

Instance Attribute Details

#contacts ⇒ Axene::Mailer::Resources::Contacts (readonly)

Returns manage lists and bulk sends.

Returns:



30
31
32
 
# File 'lib/axene/mailer/client.rb', line 30

def contacts
  @contacts
end

#domains ⇒ Axene::Mailer::Resources::Domains (readonly)

Returns register, verify, transfer domains.

Returns:



28
29
30
 
# File 'lib/axene/mailer/client.rb', line 28

def domains
  @domains
end

#emails ⇒ Axene::Mailer::Resources::Emails (readonly)

Returns send, search, schedule, inspect emails.

Returns:



26
27
28
 
# File 'lib/axene/mailer/client.rb', line 26

def emails
  @emails
end

#suppressions ⇒ Axene::Mailer::Resources::Suppressions (readonly)

Returns manage the do-not-send list.

Returns:



32
33
34
 
# File 'lib/axene/mailer/client.rb', line 32

def suppressions
  @suppressions
end

#templates ⇒ Axene::Mailer::Resources::Templates (readonly)

Returns manage reusable templates.

Returns:



34
35
36
 
# File 'lib/axene/mailer/client.rb', line 34

def templates
  @templates
end

#webhooks ⇒ Axene::Mailer::Resources::Webhooks (readonly)

Returns manage webhooks, inspect deliveries.

Returns:



36
37
38
 
# File 'lib/axene/mailer/client.rb', line 36

def webhooks
  @webhooks
end