Service: zimbraMail

Command: CheckSpelling
Namespace: urn:zimbraMail
Description: Check spelling.
Suggested words are listed in decreasing order of their match score. The "available" attribute specifies whether the server-side spell checking interface is available or not.
Properties:
Authorization token required true
Admin Authorization token required false

CheckSpellingRequest

Type: {text}
Description for element text content:Text to spell check

    <CheckSpellingRequest [dictionary="{aspell-dictionary-name}"] [ignore="{comma-sep-ignore-words}"]>{text}</CheckSpellingRequest> ## CheckSpellingRequest

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

XPath Required / Optional Description
@dictionary Optional (0 or 1) Type: String
The optional name of the aspell dictionary that will be used to check spelling. If not specified, the the dictionary will be either zimbraPrefSpellDictionary or the one for the account's locale, in that order.
@ignore Optional (0 or 1) Type: String
Comma-separated list of words to ignore just for this request. These words are added to the user's personal dictionary of ignore words stored as zimbraPrefSpellIgnoreWord.

CheckSpellingResponse

    <CheckSpellingResponse available="{available} (0|1)"> ## CheckSpellingResponse
        (<misspelled word="{misspelled-word}" [suggestions="{comma-sep-suggestions}"] /> ## Misspelling)*
    </CheckSpellingResponse>

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

XPath Required / Optional Description
@available Required (only 1) Type: 0|1
The "available" attribute specifies whether the server-side spell checking interface is available or not.
/misspelled Optional (0 or more) Information for misspelled words
/misspelled@word Required (only 1) Type: String
Misspelled word
/misspelled@suggestions Optional (0 or 1) Type: String
Comma separated list of suggestions. Suggested words are listed in decreasing order of their match score.