Mail Application Development Platform API Reference

Class openmail

All API methods are in following namespaces: Application, AuthService, Calendar, and Mail. The openmail class only contains general error codes. Namespaces can define their own specific error codes in these ranges:

Namespace Range Start
General 0
Application 1000
Mail 2000
AuthService 3000
Calendar 4000

Properties

apiVersion - private object

Current version of the API

ERR_BAD_ARG - static int

The arguments to the function were bad. If ERR_BAD_ARG is returned synchronously, it indicates that a sanity check on the arguments failed and the function wasn't called (the handler will still be called with { error: ERR_BAD_ARG }, and possibly additional information). When ERR_BAD_ARG is received by a handler, it indicates either a warning or an error.

ERR_DELETED - object

The method has been deleted. This is always an error. When passed to the handler, errorMsg may contain information for debugging.

ERR_DEPRECATED - static int

The method has been deprecated. This is a warning, never an error. If this is passed to a handler, errorMsg will contain useful information about the action you should take.

ERR_NONE - static int

ERR_NONE will be zero for this version and future versions.

ERR_XFRAME - object

A cross-frame communication failure occurred.

xdmProxyVer - private object



Copyright © 2009 Yahoo! Inc. All rights reserved.