class Sendgrid::API::Newsletter::SenderAddresses::Services

Public Instance Methods

add(sender_address) click to toggle source

Create a new Sender Address.

@see sendgrid.com/docs/API_Reference/Marketing_Emails_API/sender_address.html#-add @param sender_address [Entities::SenderAddress] An Entities::SenderAddress object. @return [Entities::Response] An Entities::Response object.

# File lib/sendgrid/api/newsletter/sender_addresses.rb, line 20
def add(sender_address)
  perform_request(Entities::Response, 'newsletter/identity/add.json', sender_address.as_json)
end
delete(sender_address) click to toggle source

Remove a Sender Address from your account.

@see sendgrid.com/docs/API_Reference/Marketing_Emails_API/sender_address.html#-delete @param sender_address [String, Entities::SenderAddress] An existing sender address identity or Entities::SenderAddress object. @return [Entities::Response] An Entities::Response object.

# File lib/sendgrid/api/newsletter/sender_addresses.rb, line 59
def delete(sender_address)
  params = { :identity => extract_identity(sender_address) }
  perform_request(Entities::Response, 'newsletter/identity/delete.json', params)
end
edit(sender_address, new_identity = nil) click to toggle source

Edit an existing Sender Address.

@see sendgrid.com/docs/API_Reference/Marketing_Emails_API/sender_address.html#-edit @param sender_address [Entities::SenderAddress] An existing Entities::SenderAddress object. @param new_identity [String] A new identity for the existing sender address. Optional. @return [Entities::Response] An Entities::Response object.

# File lib/sendgrid/api/newsletter/sender_addresses.rb, line 30
def edit(sender_address, new_identity = nil)
  params = sender_address.as_json
  params[:newidentity] = new_identity if new_identity
  perform_request(Entities::Response, 'newsletter/identity/edit.json', params)
end
get(sender_address) click to toggle source

Retrieve information associated with a particular Sender Address.

@see sendgrid.com/docs/API_Reference/Marketing_Emails_API/sender_address.html#-get @param sender_address [String, Entities::SenderAddress] An existing sender address identity or Entities::SenderAddress object. @return [Entities::SenderAddress] An Entities::SenderAddress object.

# File lib/sendgrid/api/newsletter/sender_addresses.rb, line 41
def get(sender_address)
  params = { :identity => extract_identity(sender_address) }
  perform_request(Entities::SenderAddress, 'newsletter/identity/get.json', params)
end
list() click to toggle source

List all Sender Addresses on your account.

@see sendgrid.com/docs/API_Reference/Marketing_Emails_API/sender_address.html#-list @return [Array<Entities::SenderAddress>] An array of Entities::SenderAddress objects.

# File lib/sendgrid/api/newsletter/sender_addresses.rb, line 50
def list
  perform_request(Entities::SenderAddress, 'newsletter/identity/list.json')
end

Private Instance Methods

extract_identity(sender_address) click to toggle source
# File lib/sendgrid/api/newsletter/sender_addresses.rb, line 66
def extract_identity(sender_address)
  case sender_address
  when ::String
    sender_address
  when Entities::SenderAddress
    sender_address.identity
  end
end