AppSuite:Extension points for email

From Open-Xchange
Revision as of 10:38, 3 July 2013 by Frank.paczynski (talk | contribs) (sort params)
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

API status: In Development

Extension points for e-mail

Abstract: This describes extension points for the e-mail module, allowing you to add functions.

io.ox/mail/all/actions

The point for the "all" actions dropdown in the detail view of a selected mail. This place should be used for actions in context with all involved contacts. The baton is forwarded to the the single action functions.

baton contains: data - holds the mail object of the current selected contact

data.threadKey - data.threadPosition - data.threadSize - tracker

io.ox/mail/attachment/links

The point for actions related to the attachments of a mail.

io.ox/mail/detail

The point for the detail view of a selected mail. The baton is forwarded. It is followed by points for each mail detail:

  • io.ox/mail/detail/contact-picture
  • io.ox/mail/detail/receiveddate
  • io.ox/mail/detail/fromlist
  • io.ox/mail/detail/thread-position
  • io.ox/mail/detail/flag
  • io.ox/mail/detail/subject
  • io.ox/mail/detail/tocopy
  • io.ox/mail/detail/attachments
  • io.ox/mail/detail/inline-links
  • io.ox/mail/detail/phishing-warning
  • io.ox/mail/detail/externalresources-warning
  • io.ox/mail/detail/content

io.ox/mail/detail/notification

The point for the notification handling. A extended mail object is forwarded.

io.ox/mail/detail/notification/update-notification

The point to remove read mails in notification Area.

io.ox/mail/dnd/actions

The point for mail import via drag & drop.

io.ox/mail/links/inline

The Point for inserting actions like reply & delete.

io.ox/mail/settings/detail

The point for the mail settings detailpage.

io.ox/mail/settings/detail/section

This point is not longer supported.

io.ox/mail/thread

The Point for inserting actions related to the whole thread like move & delete. The baton is forwarded.

io.ox/mail/vgrid/options

The point for applying options to the vgrid related to the mail app.

sort

  • specifies default sort field
  • in case threadview is enabled/used and default sort field is not set to 'thread' user has to select 'sort by -> chat' manually after each login/page refresh
  • alternatively you can use sever setting io.ox/mail//vgrid/sort=

option: by date

sort: 610

option: by from

sort: 'from-to'

option: by subject

sort: 607

option: by label

sort: 102

option: show threads (if threads are enabled), sort by date (if threads are disabled)

sort: 'thread' //threadview

io.ox/mail/vgrid/toolbar

The point for extending the vgrid toolbar in the mail app.

io.ox/mail/write/toolbar

The point for inserting inline buttons on top of the mail write view.

io.ox/mail/write/actions/send

The point for the action related to the send button. The baton is available.

io.ox/mail/write/actions/draft

The point for the action related to the save button. The baton is available.

io.ox/mail/write/actions/discard

The point for the action related to the discard button. The baton is available.