struct Mailjet::Sender

Overview

Senders objects are used to select the From email address for the emails you are sending. Use the resources below to manage and validate your senders.

https://dev.mailjet.com/email/reference/sender-addresses-and-domains/sender/

Defined in:

mailjet/resources/sender.cr
mailjet/resources/sender/validate.cr

Class Method Summary

Instance methods inherited from struct Mailjet::Resource

initialize initialize

Constructor methods inherited from struct Mailjet::Resource

new new

Class Method Detail

def self.all(query : Hash | NamedTuple = Hash(String, String).new, params : Hash | NamedTuple = Hash(String, String).new, client : Client = Client.new) #

Find all senders

response = Mailjet::Sender.all
senders = response.data
addresses = response.map(&.email)

[View source]
def self.create(payload : Hash | NamedTuple, params : Hash | NamedTuple = Hash(String, String).new, client : Client = Client.new) #

Create a sender

sender = Mailjet::Sender.create({
  email_type:        "transactional",
  is_default_sender: true,
  name:              "Sender1",
  email:             "[email protected]",
})

[View source]
def self.delete(id : ResourceId, client : Client = Client.new) #

Delete a sender

Mailjet::Sender.delete(1324)

[View source]
def self.find(params : Hash | NamedTuple = Hash(String, String).new, query : Hash | NamedTuple = Hash(String, String).new, client : Client = Client.new) #

Find a sender

sender = Mailjet::Sender.find(1324)

[View source]
def self.find(id : ResourceId, query : Hash | NamedTuple = Hash(String, String).new, client : Client = Client.new) #

Find a sender

sender = Mailjet::Sender.find(1324)

[View source]
def self.update(params : Hash | NamedTuple = Hash(String, String).new, payload : Hash | NamedTuple = Hash(String, String).new, client : Client = Client.new) #

Update a sender

sender = Mailjet::Sender.update(1324, {
  email_type:        "transactional",
  is_default_sender: true,
  name:              "Sender1",
  email:             "[email protected]",
})

[View source]
def self.update(id : ResourceId, payload : Hash | NamedTuple = Hash(String, String).new, client : Client = Client.new) #

Update a sender

sender = Mailjet::Sender.update(1324, {
  email_type:        "transactional",
  is_default_sender: true,
  name:              "Sender1",
  email:             "[email protected]",
})

[View source]