AppSuite:Extension points for email: Difference between revisions
(Created page with "<div class="title">Extension points for e-mail</div> '''Abstract:''' This describes extension points for the e-mail module, allowing you to add functions. == io.ox/mail/all/a...") |
No edit summary |
||
| (12 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
<!-- !!! --> | |||
<!-- PLEASE APPLY CHANGES ONLY TO THE NEW TECHNICAL DOCUMENTATION: wd/frontend/web/documentation --> | |||
<!-- !!! --> | |||
{{Stability-experimental}} | |||
<div class="title">Extension points for e-mail</div> | <div class="title">Extension points for e-mail</div> | ||
'''Abstract:''' This describes extension points for the e-mail module, allowing you to add functions. | '''Abstract:''' This describes extension points for the e-mail module, allowing you to add functions. | ||
| Line 61: | Line 67: | ||
== io.ox/mail/vgrid/options == | == io.ox/mail/vgrid/options == | ||
The point for applying options to the vgrid related to the mail app. | 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'' | |||
<pre> | |||
sort: 610 | |||
</pre> | |||
''option: by from'' | |||
<pre> | |||
sort: 603 | |||
</pre> | |||
''option: by subject'' | |||
<pre> | |||
sort: 607 | |||
</pre> | |||
''option: by label'' | |||
<pre> | |||
sort: 102 | |||
</pre> | |||
''option: show threads (if threadview is enabled), sort by date (if threadview are disabled)'' | |||
<pre> | |||
sort: 'thread' | |||
</pre> | |||
== io.ox/mail/vgrid/toolbar == | == io.ox/mail/vgrid/toolbar == | ||
| Line 71: | Line 107: | ||
The point for the action related to the send button. | The point for the action related to the send button. | ||
The baton is available. | The baton is available. | ||
== io.ox/mail/write/autoCompleteItem (since 7.4.2) == | |||
The point for extending the autocomplete items in the mail app. | |||
== io.ox/mail/write/contactItem (since 7.4.2) == | |||
The point for extending the contact list items in the mail app. | |||
== io.ox/mail/write/contactPicture (since 7.4.2) == | |||
The point for extending contact picture in autocomplete and contact list. | |||
== io.ox/mail/write/displayName (since 7.4.2) == | |||
The point for extending display name in autocomplete and contact list. | |||
== io.ox/mail/write/emailAddress (since 7.4.2) == | |||
The point for extending email address in autocomplete and contact list. | |||
== io.ox/mail/write/actions/draft == | == io.ox/mail/write/actions/draft == | ||
Latest revision as of 08:52, 10 February 2016
API status: In Development
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: 603
option: by subject
sort: 607
option: by label
sort: 102
option: show threads (if threadview is enabled), sort by date (if threadview are disabled)
sort: 'thread'
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/autoCompleteItem (since 7.4.2)
The point for extending the autocomplete items in the mail app.
io.ox/mail/write/contactItem (since 7.4.2)
The point for extending the contact list items in the mail app.
io.ox/mail/write/contactPicture (since 7.4.2)
The point for extending contact picture in autocomplete and contact list.
io.ox/mail/write/displayName (since 7.4.2)
The point for extending display name in autocomplete and contact list.
io.ox/mail/write/emailAddress (since 7.4.2)
The point for extending email address in autocomplete and contact list.
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.