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

Module ap_rename_addr

Renames (given) address. See rename_addr() for a description.

API definition:

API = (('oaname_or_id', 'ASCII string', 1),
       ('naname', 'ASCII string', 1))

(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, oaname_or_id, naname)
see above
bool
rename_addr(request, oaname_or_id, naname)
Renames (given) address.
Variables [hide private]
  log_api = logging.getLogger('api')
  __package__ = 'bscw.api'
Function Details [hide private]

rename_addr(request, oaname_or_id, naname)

 

Renames (given) address.

Examples:

>>> s.rename_addr(oaname_or_id='old@bscw.de', naname='new@bscw.de')
>>> s.rename_addr(oaname_or_id='1234', naname='new@bscw.de')
Parameters:
  • oaname_or_id (str) - old address name or ID of address object to be renamed
  • naname (str) - new address name
Returns: bool
  • True
  • raises fault (10104, 'Bad parameter')