File/includes/functions_privmsgs.php

Description
  • version: $Id: functions_privmsgs.php 8567 2008-05-26 12:00:17Z acydburn $
  • copyright: (c) 2005 phpBB Group
  • license: GNU Public License
Constants
ACTION_DELETE_MESSAGE = 4 (line 46)
ACTION_MARK_AS_IMPORTANT = 3 (line 45)
ACTION_MARK_AS_READ = 2 (line 44)
ACTION_PLACE_INTO_FOLDER = 1 (line 43)
CHECK_MESSAGE = 3 (line 50)
CHECK_SENDER = 2 (line 49)
CHECK_STATUS = 4 (line 51)
CHECK_SUBJECT = 1 (line 48)
CHECK_TO = 5 (line 52)
RULE_ANSWERED = 11 (line 38)
RULE_BEGINS_WITH = 5 (line 32)
RULE_ENDS_WITH = 6 (line 33)
RULE_FORWARDED = 12 (line 39)
RULE_IS = 3 (line 30)
RULE_IS_FOE = 8 (line 35)
RULE_IS_FRIEND = 7 (line 34)
RULE_IS_GROUP = 10 (line 37)
RULE_IS_LIKE = 1 (line 28)
RULE_IS_NOT = 4 (line 31)
RULE_IS_NOT_LIKE = 2 (line 29)
RULE_IS_USER = 9 (line 36)
RULE_TO_GROUP = 14 (line 40)
RULE_TO_ME = 15 (line 41)
Functions
check_rule (line 252)

Check Rule against Message Information

void check_rule ( &$rules,  &$rule_row,  &$message_row,  $user_id)
  • &$rules
  • &$rule_row
  • &$message_row
  • $user_id
clean_sentbox (line 223)

Delete Messages From Sentbox

we are doing this here because this saves us a bunch of checks and queries

void clean_sentbox ( $num_sentbox_messages)
  • $num_sentbox_messages
delete_pm (line 931)

Delete PM(s)

void delete_pm ( $user_id,  $msg_ids,  $folder_id)
  • $user_id
  • $msg_ids
  • $folder_id
get_folder (line 116)

Get all folder

void get_folder ( $user_id, [ $folder_id = false])
  • $user_id
  • $folder_id
get_folder_status (line 1249)

Get folder status

void get_folder_status ( $folder_id,  $folder)
  • $folder_id
  • $folder
handle_mark_actions (line 869)

Handle all actions possible with marked messages

void handle_mark_actions ( $user_id,  $mark_action)
  • $user_id
  • $mark_action
message_history (line 1673)

Display Message History

void message_history ( $msg_id,  $user_id,  $message_row,  $folder, [ $in_post_mode = false])
  • $msg_id
  • $user_id
  • $message_row
  • $folder
  • $in_post_mode
move_pm (line 731)

Move PM from one to another folder

void move_pm ( $user_id,  $message_limit,  $move_msg_ids,  $dest_folder,  $cur_folder_id)
  • $user_id
  • $message_limit
  • $move_msg_ids
  • $dest_folder
  • $cur_folder_id
place_pm_into_folder (line 367)

Place new messages into appropriate folder

void place_pm_into_folder ( &$global_privmsgs_rules, [ $release = false])
  • &$global_privmsgs_rules
  • $release
pm_notification (line 1586)

PM Notification

void pm_notification ( $mode,  $author,  $recipients,  $subject,  $message)
  • $mode
  • $author
  • $recipients
  • $subject
  • $message
rebuild_header (line 1070)

Rebuild message header

void rebuild_header ( $check_ary)
  • $check_ary
set_user_message_limit (line 1815)

Set correct users max messages in PM folder.

If several group memberships define different amount of messages, the highest will be chosen.

void set_user_message_limit ()
submit_pm (line 1282)

Submit PM

void submit_pm ( $mode,  $subject,  &$data, [ $put_in_outbox = true])
  • $mode
  • $subject
  • &$data
  • $put_in_outbox
update_pm_counts (line 323)

Update user PM count

void update_pm_counts ()
update_unread_status (line 828)

Update unread message status

void update_unread_status ( $unread,  $msg_id,  $user_id,  $folder_id)
  • $unread
  • $msg_id
  • $user_id
  • $folder_id
write_pm_addresses (line 1106)

Print out/assign recipient information

void write_pm_addresses ( $check_ary,  $author_id, [ $plaintext = false])
  • $check_ary
  • $author_id
  • $plaintext

Documentation generated on Tue, 26 Aug 2008 08:34:04 +0200 by phpDocumentor 1.4.2