Class: Mailgun::List

Inherits:
Object
  • Object
show all
Defined in:
lib/mailgun/list.rb

Defined Under Namespace

Classes: Member

Instance Method Summary collapse

Constructor Details

#initialize(mailgun) ⇒ List

Used internally, called from Mailgun::Base



4
5
6
 
# File 'lib/mailgun/list.rb', line 4

def initialize(mailgun)
  @mailgun = mailgun
end

Instance Method Details

#all ⇒ Object

List all mailing lists



14
15
16
17
18
19
20
 
# File 'lib/mailgun/list.rb', line 14

def all
  response = Mailgun.submit :get, list_url

  if response
    response["items"].collect {|item| item["address"]}
  end
end

#create(address, name = nil, description = nil) ⇒ Object

Create a mailing list with a given address with an optional name and description



29
30
31
32
33
34
 
# File 'lib/mailgun/list.rb', line 29

def create(address, name=nil, description=nil)
	params = {:address => address}
	params[:name] = name if name
	params[:description] = description if description
  Mailgun.submit :post, list_url, params
end

#delete(address) ⇒ Object

Deletes a mailing list with a given address



46
47
48
 
# File 'lib/mailgun/list.rb', line 46

def delete(address)
	Mailgun.submit :delete, list_url(address)
end

#find(address) ⇒ Object

List a single mailing list by a given address



23
24
25
 
# File 'lib/mailgun/list.rb', line 23

def find(address)
  Mailgun.submit :get, list_url(address)
end

#update(address, new_address, name = nil, description = nil) ⇒ Object

Update a mailing list with a given address with an optional new address, name or description



38
39
40
41
42
43
 
# File 'lib/mailgun/list.rb', line 38

def update(address, new_address, name=nil, description=nil)
 	params = {:address => new_address}
	params[:name] = name if name
	params[:description] = description if description
  Mailgun.submit :put, list_url(address), params
end