[ Index ]

PHP Cross Reference of Eventum

title

Body

[close]

/include/ -> class.draft.php (summary)

(no description)

File Size: 471 lines (18 kb)
Included or required: 6 times
Referenced: 0 times
Includes or requires: 1 file
 include/class.email_account.php

Defines 1 class

Draft:: (12 methods):
  saveRoutedMessage()
  saveEmail()
  update()
  remove()
  removeRecipients()
  addEmailRecipient()
  getDetails()
  getList()
  getEmailRecipients()
  getDraftBySequence()
  send()
  getCountByUser()


Class: Draft  - X-Ref

saveRoutedMessage($message)   X-Ref
Method used to save the routed draft into a backup directory.

param: string $message The full body of the draft

saveEmail($issue_id, $to, $cc, $subject, $message, $parent_id = FALSE, $unknown_user = FALSE, $add_history_entry = TRUE)   X-Ref
Method used to save the draft response in the database for
further use.

param: integer $issue_id The issue ID
param: string $to The primary recipient of the draft
param: string $cc The secondary recipients of the draft
param: string $subject The subject of the draft
param: string $message The draft body
param: integer $parent_id The ID of the email that this draft is replying to, if any
param: string $unknown_user The sender of the draft, if not a real user
param: boolean $add_history_entry Whether to add a history entry automatically or not
return: integer 1 if the update worked, -1 otherwise

update($issue_id, $emd_id, $to, $cc, $subject, $message, $parent_id = FALSE)   X-Ref
Method used to update an existing draft response.

param: integer $issue_id The issue ID
param: integer $emd_id The email draft ID
param: string $to The primary recipient of the draft
param: string $cc The secondary recipients of the draft
param: string $subject The subject of the draft
param: string $message The draft body
param: integer $parent_id The ID of the email that this draft is replying to, if any
return: integer 1 if the update worked, -1 otherwise

remove($emd_id)   X-Ref
Method used to remove a draft response.

param: integer $emd_id The email draft ID
return: boolean

removeRecipients($emd_id)   X-Ref
Method used to remove the recipients associated with the given
email draft response.

param: integer $emd_id The email draft ID
return: boolean

addEmailRecipient($emd_id, $email, $is_cc)   X-Ref
Method used to associate a recipient with a given email
draft response.

param: integer $emd_id The email draft ID
param: string $email The recipient's email address
param: boolean $is_cc Whether this recipient is in the Cc list for the given draft
return: boolean

getDetails($emd_id)   X-Ref
Method used to get the details on a given email draft response.

param: integer $emd_id The email draft ID
return: array The email draft details

getList($issue_id, $show_all = false)   X-Ref
Returns a list of drafts associated with an issue.

param: integer $issue_id The ID of the issue.
param: boolean $show_all If all draft statuses should be shown
return: array An array of drafts.

getEmailRecipients($emd_id)   X-Ref
Method used to get the list of email recipients for a
given draft response.

param: integer $emd_id The email draft ID
return: array The list of email recipients

getDraftBySequence($issue_id, $sequence)   X-Ref
Returns the nth draft for the specific issue. Sequence starts at 1.

param: integer $issue_id The id of the issue.
param: integer $sequence The sequential number of the draft.
return: array An array of data containing details about the draft.

send($draft_id)   X-Ref
Converts an email to a draft and sends it.

param: integer $draft_id The id of the draft to send.

getCountByUser($usr_id, $start, $end)   X-Ref
Returns the number of drafts by a user in a time range.

param: string $usr_id The ID of the user
param: integer $start The timestamp of the start date
param: integer $end The timestanp of the end date
return: integer The number of note by the user.



Generated: Wed Dec 19 21:21:33 2007 Cross-referenced by PHPXref 0.7