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

Module ap_remove_addr

Removes (given) address. See remove_addr() for a description.

API definition:

API = (('aname_or_id', 'ASCII string', 1),
       ('options', 'struct', 0, [('o_force', 'boolean', 0)]))

(c) OrbiTeam Software, 2007-2010, www.bscw.de/copyright.html


Version: $Rev: 20112 $

Functions [hide private]
 
param_def()
return the parameter definition
 
return_def()
return the result definition
 
do_it(request, aname_or_id='', options={})
see above
bool
remove_addr(request, aname_or_id, options={})
Removes (given) address.
Variables [hide private]
  log_api = logging.getLogger('api')
  __package__ = 'bscw.api'
Function Details [hide private]

remove_addr(request, aname_or_id, options={})

 

Removes (given) address. The options dictionary may contain the following key/value parameter(s).

Examples:

>>> s.remove_addr(aname_or_id='info@bscw.de')
>>> s.remove_addr(aname_or_id='1234', options={'o_force': True})
Parameters:
  • aname_or_id (str) - address name or ID of address object to be removed
  • options (dict) - dictionary with the following key/value parameter:
    • o_force (bool) - force destruction of address, even if address is the only allocated (primary) address of an user
Returns: bool
  • True
  • raises fault (10104, 'Bad parameter')