Package bscw :: Package api :: Module ap_list_addr
[hide private]

Module ap_list_addr

List (given) address(es). See list_addr() method for a description.

API definition:

API = (('options', 'struct', 0, [('o_search', 'ASCII string', 0),
       ('o_allocated', 'boolean', 0),
       ('o_bounced', 'boolean', 0),
       ('o_pending', 'boolean', 0),
       ('o_lastmod', 'dateTime.iso8601', 0),
       ('o_flags', 'ASCII string', 0),
       ('o_attrs', 'array', 0, [('attr', 'ASCII string', 1)])]),
       ('addr_or_id_list', 'array', 0, [('addr_or_id', 'ASCII string', 1)]))

(c) OrbiTeam Software, 2007-2008


Version: $Rev: 20668 $

Functions [hide private]
 
param_def()
return the parameter definition
 
return_def()
return the result definition
 
do_it(request, options={}, addr_or_id_list=[])
see above
list
list_addr(request, options={}, addr_or_id_list=[])
List (given) address(es).
 
addr_fltr(addr, options)
 
invited(addrs, flags='n')
 
is_pending(maddr)
 
is_bounced(maddr)
 
is_allocated(maddr)
Variables [hide private]
  log_api = logging.getLogger('api')
  __package__ = 'bscw.api'
Function Details [hide private]

list_addr(request, options={}, addr_or_id_list=[])

 

List (given) address(es). The returned address list can be altered by using the options dictionary with the following key/value parameter(s) or the addr_or_id_list parameter.

Examples:

>>> s.list_addr()
>>> s.list_addr(options={'o_search': 'm_.*orbiteam.de'})
>>> s.list_addr(
        options={'o_attrs': ['name']},
        addr_or_id_list=['pajo@orbiteam.de', '12345'])
Parameters:
  • options (dict) - dictionary with the following key/value parameter(s):
    • o_search (str) - address search expression, 'm_.*' if omitted
    • param o_attrs (list) - list of returned address attributes, e.g. ['__id__', 'ctime', 'atime', 'user' ...] (see get_attributes() for details)
    • o_allocated (bool) - consider allocated addresses
    • o_bounced (bool) - consider bounces addresses
    • o_pending (bool) - consider pending addresses
    • o_flags (str) - consider addresses with flags <f> ::= {n|f|a}+ (if omitted, n is default)
      • n: address w/o invitation (default)
      • f: address w/ invitation to a workspace
      • a: address w/ invitation to an appointment
    • o_lastmod (dateTime) - consider adresses altered after time
  • addr_or_id_list (list) - list of address(es) or ID(s) of address objects, if omitted all addresses are considered
Returns: list
  • list of address attribute dictionaries
  • raises fault (10104, 'Bad parameter')