Module: Dnsimple::Client::DomainsForwards

Included in:
DomainsService
Defined in:
lib/dnsimple/client/domains_forwards.rb

Instance Method Summary collapse

Instance Method Details

#create_email_forward(domain, attributes = {}, options = {}) ⇒ Struct::EmailForward

Creates an email forward for a domain.

Parameters:

  • domain (#to_s) —

    The domain id or domain name.

  • attributes (Hash) (defaults to: {})

Returns:

Raises:

See Also:



31
32
33
34
35
36
37
 
# File 'lib/dnsimple/client/domains_forwards.rb', line 31

def create_email_forward(domain, attributes = {}, options = {})
  Extra.validate_mandatory_attributes(attributes, [:from, :to])
  options  = options.merge({ email_forward: attributes })
  response = client.post(Client.versioned("/domains/#{domain}/email_forwards"), options)

  Struct::EmailForward.new(response["email_forward"])
end

#delete_email_forward(domain, forward, options = {}) ⇒ void

This method returns an undefined value.

Deletes an email forward for a domain.

Parameters:

  • domain (#to_s) —

    The domain id or domain name.

  • forward (Fixnum) —

    The forward id.

Raises:

See Also:



65
66
67
 
# File 'lib/dnsimple/client/domains_forwards.rb', line 65

def delete_email_forward(domain, forward, options = {})
  client.delete(Client.versioned("/domains/#{domain}/email_forwards/#{forward}"), options)
end

#email_forward(domain, forward, options = {}) ⇒ Struct::EmailForward

Gets an email forward for a domain.

Parameters:

  • domain (#to_s) —

    The domain id or domain name.

  • forward (Fixnum) —

    The forward id.

Returns:

Raises:

See Also:



49
50
51
52
53
 
# File 'lib/dnsimple/client/domains_forwards.rb', line 49

def email_forward(domain, forward, options = {})
  response = client.get(Client.versioned("/domains/#{domain}/email_forwards/#{forward}"), options)

  Struct::EmailForward.new(response["email_forward"])
end

#email_forwards(domain, options = {}) ⇒ Array<Struct::EmailForward> Also known as: list_email_forwards

Lists the email forwards for a domain.

Parameters:

  • domain (#to_s) —

    The domain id or domain name.

Returns:

Raises:

See Also:



14
15
16
17
18
 
# File 'lib/dnsimple/client/domains_forwards.rb', line 14

def email_forwards(domain, options = {})
  response = client.get(Client.versioned("/domains/#{domain}/email_forwards"), options)

  response.map { |r| Struct::EmailForward.new(r["email_forward"]) }
end