class Ari::Mailbox

Attributes

name[R]
new_messages[R]
old_messages[R]

Public Class Methods

delete(options = {}) click to toggle source

DELETE /mailboxes/%{mailboxName}

Mailbox state

Parameters:

mailboxName (required) - Name of the mailbox

# File lib/ari/resources/mailbox.rb, line 81
def self.delete(options = {})
  raise ArgumentError.new("Parameter mailboxName must be passed in options hash.") unless options[:mailboxName]
  path = '/mailboxes/%{mailboxName}' % options
  response = client(options).delete(path, options)
rescue Ari::RequestError => e
  raise unless e.code == '404'
end
get(options = {}) click to toggle source

GET /mailboxes/%{mailboxName}

Mailbox state

Parameters:

mailboxName (required) - Name of the mailbox

# File lib/ari/resources/mailbox.rb, line 38
def self.get(options = {})
  raise ArgumentError.new("Parameter mailboxName must be passed in options hash.") unless options[:mailboxName]
  path = '/mailboxes/%{mailboxName}' % options
  response = client(options).get(path, options)
  Mailbox.new(response.merge(client: options[:client]))
end
list(options = {}) click to toggle source

GET /mailboxes

Mailboxes

# File lib/ari/resources/mailbox.rb, line 23
def self.list(options = {})
  path = '/mailboxes'
  response = client(options).get(path, options)
  response.map { |hash| Mailbox.new(hash.merge(client: options[:client])) }
end
update(options = {}) click to toggle source

PUT /mailboxes/%{mailboxName}

Mailbox state

Parameters:

mailboxName (required) - Name of the mailbox oldMessages (required) - Count of old messages in the mailbox newMessages (required) - Count of new messages in the mailbox

# File lib/ari/resources/mailbox.rb, line 60
def self.update(options = {})
  raise ArgumentError.new("Parameter mailboxName must be passed in options hash.") unless options[:mailboxName]
  raise ArgumentError.new("Parameter oldMessages must be passed in options hash.") unless options[:oldMessages]
  raise ArgumentError.new("Parameter newMessages must be passed in options hash.") unless options[:newMessages]
  path = '/mailboxes/%{mailboxName}' % options
  response = client(options).put(path, options)
end

Public Instance Methods

delete(options = {}) click to toggle source
# File lib/ari/resources/mailbox.rb, line 89
def delete(options = {})
  self.class.delete(options.merge(mailboxId: self.id, client: @client))
end
get(options = {}) click to toggle source
# File lib/ari/resources/mailbox.rb, line 45
def get(options = {})
  self.class.get(options.merge(mailboxId: self.id, client: @client))
end
update(options = {}) click to toggle source
# File lib/ari/resources/mailbox.rb, line 68
def update(options = {})
  self.class.update(options.merge(mailboxId: self.id, client: @client))
end