[net.nehmer.mail] element index

Package indexes

All elements
a d g i k l m n s v _
_
top
Variable $_message_count
Internal variable, caches the total message count for performance reasons.
Variable $_unseen_count
Internal variable, caches the unseen message count for performance reasons.
Method _create_mailbox
This funciton handles the actual mailbox creation from the 'create' handler.
Method _handler_index
The index handler will list all mailboxes of the current user, along with their message counts. The handler only prepares the mailbox listing, the viewer code takes the bulk of the logic here.
Method _handler_mailbox
Loads the mailbox referenced by $args, validats the privileges, and retrieves all mails from that mailbox.
Method _handler_mailbox_create
This is small creation form, driven by DM2 without any data backend.
Method _handler_mailbox_delete
Deletes a mailbox (currently without safety checks).
Method _handler_mailbox_edit
Prepares an edit form using the dm2, which is frozen unless we have update privileges.
Method _handler_mail_manage
Deletes a mail and relocates accordingly. This call doesn't have a show hook, as it will relocate or generate_error in all branches.
Method _handler_mail_new
Prepares a datamanager for entering the contents of a new mail.
Method _handler_mail_searchto
Simple search form to allow lookup of users to write mails to.
Method _handler_mail_sent
Prepares the mail for showing. This is used only if no outbox is available.
Method _handler_mail_show
Prepares the mail for showing.
Method _handler_welcome
Welcome page handler.
Method _mailbox_to_leaf
Little helper, transforms a mailbox into a leaf structure.
Method _on_deleted
The delete event deletes all messages bound to this mailbox.
Method _on_handle
General request initialization, which populates the topic toolbar.
Method _on_initialize
Method _on_initialize
Method _on_resolve_permalink
Simple lookup method which tries to map the guid to an mailbox or mail.
Method _on_watched_dba_delete
The delete handler will drop all mailboxes accociated with any person record that has been deleted. We don't need to check for watched classes at this time, since we have no other watches defined.
Method _prepare_topic_toolbar
This function adds all of the standard items (configuration and create links) to the topic toolbar.
Method _send_mail
Sends a mail, according to the information from the component context.
Method _send_notification_mail
Sends a mail to the user notifying him about a new mail in his inbox. This
Method _show_index
The rendering code consists of a standard init/loop/end construct.
Method _show_index_prepare_requestdata
Helper function used in _show_index to prepare all meta-information around the mailbox.
Method _show_mailbox
Renders a mailbox' contents.
Method _show_mailbox_create
Simple Mailbox creation form handler.
Method _show_mailbox_delete
Mailbox deletion stub. Not used yet.
Method _show_mailbox_edit
Simple Mailbox creation form handler.
Method _show_mail_new
Shows the send form. Nothing special.
Method _show_mail_searchto
Shows the search form and, if applicable, the search results.
Method _show_mail_sent
Shows a sent mail. This is used only if no outbox is available.
Method _show_mail_show
Displays an e-Mail
Method _show_welcome
Renders the welcome page.
a
top
Method autocreate_inbox
This function will automatically create the inbox for the currently active user.
Method autocreate_outbox
This function will automatically create the outbox for the currently active user.
Page admin.php
admin.php in admin.php
d
top
Method deliver_mail
This function delivers a mail to this mailbox. If the Quota of the mailbox is set (nonzero) and would be exceeded by this mail delivery, the component checks the ignore_quota privilege. If it is set, the mail can be delivered nonetheless, otherwise delivery fails.
g
top
Method get_body_formatted
Returns the HMTL-formatted body of the message. Uses the net.nehmer.markdown library.
Method get_class_magic_default_privileges
DBA magic defaults which assign write privileges for all USERS, so that they can freely create mails without the need to sudo of the component. Also, we deny read unconditionally, as read privileges are set during creation for the sender, and are inherited from the mailbox for the receiver.
Method get_inbox
Returns the Inbox of a given user, defaulting to the currently authenticated user.
Method get_leaves
Method get_mailbox
This function returns a given mailbox of a user, defaulting to the Inbox currently authenticated user. If you request the current user's mailbox without having a user authenticated, an ACCESS DENIED error is triggered.
Method get_mailbox
Returns an instance of the owning mailbox. A new object is created.
Method get_message_count
Returns the total message count within this mailbox. You do not need read access for this query, as ACL is bypassed using the count_unchecked() method of the MidCOM Query Builder. This way you will always get a fast and accurate result (especially useful for quota checks).
Method get_name_for_key
Method get_outbox
Returns the Outbox of a given user, defaulting to the currently authenticated user.
Method get_parent_guid_uncached
The get_parent_guid_uncached method links to the person owning the mailbox.
Method get_parent_guid_uncached
The get_parent_guid_uncached method links to the owning mailbox. If the mailbox cannot be resolved, the error is logged but ignored silently, to allow for error handling.
Method get_qb_list_by_user
This function returns a new query builder instance which allows you to list mailboxes by a given user. You may pass a midcom_core_user object, any midcom_person subclass, an ID or an GUID to this function.
Method get_qb_mails
This is a small helper which prepares a query builder ready to query the mails in this mailbox.
Method get_unseen_count
Returns the total number of unseen messages within this mailbox. Same notes as with get_message_count() applies.
i
top
Method is_over_quota
Returns true, if this Mailbox has a qutoa set and the message count is equal to or larger then the quota.
Page interfaces.php
interfaces.php in interfaces.php
k
top
Method key_exists
l
top
Method list_all
Method list_mailboxes
This function lists all mailboxes for the current user. If no user is authenticated, an ACCESS DENIED error is triggered.
Method list_mails
This is a helper which lists all mails belonging to this mailbox.
Method list_unread_mails
This is a helper which lists all unread mails belonging to this mailbox.
m
top
Page mailboxowners.php
mailboxowners.php in mailboxowners.php
Page mailbox.php
mailbox.php in mailbox.php
Page mail.php
mail.php in mail.php
n
top
Page navigation.php
navigation.php in navigation.php
Method net_nehmer_mail
Class net_nehmer_mail_admin
On-Site Mail System AIS interface class
Method net_nehmer_mail_admin
Class net_nehmer_mail_callbacks_mailboxowners
On-Site Mail System Owner Listing Callback.
Method net_nehmer_mail_interface
Constructor.
Class net_nehmer_mail_interface
net_nehmer_mail_interface in interfaces.php
On-Site E-Mail System MidCOM interface class.
Class net_nehmer_mail_mail
On-Site Mail System Mailbox class
Method net_nehmer_mail_mail
Method net_nehmer_mail_mailbox
Empty constructor calling parent only.
Class net_nehmer_mail_mailbox
On-Site Mail System Mailbox class
Method net_nehmer_mail_navigation
Simple constructor, calls base class.
Class net_nehmer_mail_navigation
net_nehmer_mail_navigation in navigation.php
Onsite Mailing System NAP interface class
Method net_nehmer_mail_viewer
Class net_nehmer_mail_viewer
On-Site Mailing System site interface class
s
top
Method set_type
We ignore set_type, as we don't need the type.
v
top
Page viewer.php
viewer.php in viewer.php
a d g i k l m n s v _