Module: ZimbraRestApi

Defined in:
lib/models/cos.rb,
lib/helpers.rb,
lib/models/domain.rb,
lib/models/account.rb,
lib/zimbra_rest_api.rb,
lib/models/zimbra_base.rb,
lib/zimbra_rest_api/errors.rb,
lib/zimbra_rest_api/version.rb,
lib/models/distribution_list.rb,
lib/zimbra_rest_api/zimbra_object.rb,
lib/zimbra_rest_api/app.rb

Overview

Doc placeholder

Defined Under Namespace

Modules: Helpers, ZimbraObject Classes: Account, App, Cos, DistributionList, Domain, NotFound, TO_MANY_RESULTS, ZimbraBase

Constant Summary collapse

VERSION =
'0.1.9'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.api_idObject

Returns the value of attribute api_id.



22
23
24
# File 'lib/zimbra_rest_api.rb', line 22

def api_id
  @api_id
end

.zimbra_admin_passwordObject

Returns the value of attribute zimbra_admin_password.



21
22
23
# File 'lib/zimbra_rest_api.rb', line 21

def zimbra_admin_password
  @zimbra_admin_password
end

.zimbra_admin_userObject

Returns the value of attribute zimbra_admin_user.



21
22
23
# File 'lib/zimbra_rest_api.rb', line 21

def zimbra_admin_user
  @zimbra_admin_user
end

.zimbra_max_resultsObject



31
32
33
# File 'lib/zimbra_rest_api.rb', line 31

def zimbra_max_results
  @zimbra_max_results ||= 200
end

.zimbra_soap_urlObject

Returns the value of attribute zimbra_soap_url.



24
25
26
# File 'lib/zimbra_rest_api.rb', line 24

def zimbra_soap_url
  @zimbra_soap_url
end

Class Method Details

.authenticate!Object



26
27
28
29
# File 'lib/zimbra_rest_api.rb', line 26

def authenticate!
  Zimbra.admin_api_url = zimbra_soap_url
  Zimbra.(zimbra_admin_user, zimbra_admin_password)
end