Service: zimbraAccount

Command: ModifyWhiteBlackList
Namespace: urn:zimbraAccount
Description: Modify the anti-spam WhiteList and BlackList addresses
Note: If no <addr> is present in a list, it means to remove all addresses in the list.
e.g. remove all addresses in the white list
        <ModifyWhiteBlackListRequest>
            <whiteList/>
        </ModifyWhiteBlackListRequest>
 

{op} = + | -

if not present, replace the entire list with provided values.
Note, can't mix +/- with non-present op)

e.g.
  1. replace the entire white list with "foo", "bar".
                 <whiteList>
                     <addr>foo</addr>
                     <addr>bar</addr>
                 </whiteList>
     
  2. add values "foo" and "bar" to white list
                 <whiteList>
                     <addr op="+">foo</addr>
                     <addr op="+">bar</addr>
                 </whiteList>
     
  3. remove values "foo" and "bar" from white list
                 <whiteList>
                     <addr op="-">foo</addr>
                     <addr op="-">bar</addr>
                 </whiteList>
     
  4. add "foo" and remove 'bar"
                 <whiteList>
                     <addr op="+">foo</addr>
                     <addr op="-">bar</addr>
                 </whiteList>
     
  5. mix +/- and non-present op - not allowed, INVALID_REQUEST will be thrown
                 <whiteList>
                     <addr op="+">foo</addr>
                     <addr>bar</addr>
                 </whiteList>
     
Properties:
Authorization token required true
Admin Authorization token required false

ModifyWhiteBlackListRequest

    <ModifyWhiteBlackListRequest> ## ModifyWhiteBlackListRequest
        <whiteList>
            (<addr [op="..."]>{value}</addr> ## OpValue)*
        </whiteList>
        <blackList>
            (<addr [op="..."]>{value}</addr> ## See /whiteList/addr [ ## OpValue])*
        </blackList>
    </ModifyWhiteBlackListRequest>

elements and attributes you can define within a <ModifyWhiteBlackListRequest> element:

XPath Required / Optional Description
/whiteList Required (only 1)
/whiteList/addr Optional (0 or more) Type: {value}
Description for element text content:Email address
/whiteList/addr@op Optional (0 or 1) Type: String
Operation to apply to an address
  • + : add, ignored if the value already exists
  • - : remove, ignored if the value does not exist
if not present, replace the entire list with provided values.
/blackList Required (only 1)
/blackList/addr Optional (0 or more) Type: {value}
Description for element text content:Email address
See /whiteList/addr for more details.

ModifyWhiteBlackListResponse

    <ModifyWhiteBlackListResponse /> ## ModifyWhiteBlackListResponse