Summary of all methods. Click an individual method for detailed documentation, or navigate by class in the left pane.
- Application.callWebService
- Calls a third-party Web service.
- Application.closeView
- Closes a currently opened view.
- Application.filterHTML
- Filters HTML to make it safe for rendering in an OpenMail app.
- Application.getAttachmentUrl
- Get the time-sensitive URL of a message's attachment content.
- Application.getAuthService
- Helper for interacting with web services that require authorization.
- Application.getData
- Retrieves data by key from the per-app-per-user persistent store.
- Application.getParameters
- Retrieves properties associated with the view that invoked the function.
- Application.getUserLanguages
- Obtain the user's language preferences.
- Application.isSSL
- Was Yahoo! Mail launched over SSL?.
- Application.openView
- Opens a new view for the current application.
- Application.removeData
- Removes data by key from the per-app-per-user persistent store.
- Application.sendMessage
- Send message between views of the same app.
- Application.setData
- Saves key/value datasets into a per-application-per-user persistent store.
- Application.setFolderConfig
- Customize the appearance of an application's folder, including changing its tooltip, count and subfolders, or extending its label.
- Application.setListener
- Registers an event handler for a particular event.
- Application.setTabCloseMessage
- Trigger a modal dialog with customizable message when user attempts to close a tab targetzone.
- Application.upgradeIfNecessary
- If a newer version of the app is available, trigger the upgrade flow.
- AuthService.callWebService
- Call a 3rd-party Web service using an authorized (i.e. signed) call.
- AuthService.getAuthService
- This is tricky because getAuthService is executed locally in app iframe so the wrapper executes getAuthService first then wraps the methods of the returned object.
- AuthService.getParameters
- Use this API to get access to the Logged-In user's protected information.
- AuthService.getStatus
- Retrieves current authorization status of the user with respect to the Web service.
- AuthService.getUserAuthorizationURL
- Retrieves the redirection URL that is needed by the user to continue authorization process.
- AuthService.notifyAuthorizationReceived
- Tells the authorization service that the user has completed the authorization process.
- AuthService.removeAuthorization
- Removes all authorization tokens and reverts back to initial state.
- Mail.compose
- Opens a compose tab with contents/addressing pre-filled from the arguments field.
- Mail.draft
- Opens an existing Draft message from the user's Drafts folder.
- Mail.openMessage
- Opens a message.
- Mail.search
- Equivalent to a user typing a query in the search box, then pressing "go".
- isSupported
- Check to see if an API is supported.