[ Index ] |
PHP Cross Reference of Eventum |
[Source view] [Print] [Project Stats]
(no description)
File Size: | 2510 lines (104 kb) |
Included or required: | 17 times |
Referenced: | 0 times |
Includes or requires: | 14 files include/class.mail.php include/class.pager.php include/class.routing.php include/class.mime_helper.php include/class.history.php include/class.user.php include/class.search_profile.php include/class.misc.php include/class.date.php include/class.auth.php include/class.note.php include/class.email_account.php include/class.error_handler.php include/class.issue.php |
Support:: (50 methods):
expungeEmails()
removeEmail()
getListingSides()
getIssueSides()
saveRoutedEmail()
getSender()
clearErrors()
restoreEmails()
getRemovedList()
removeEmailByAccounts()
getServerURI()
connectEmailServer()
getTotalEmails()
getEmailInfo()
createIssueFromEmail()
closeEmailServer()
getMessageIDs()
exists()
insertEmail()
getParam()
saveSearchParams()
getSortingInfo()
getEmailListing()
buildWhereClause()
extractAttachments()
associateEmail()
associate()
getEmailDetails()
getEmailBySequence()
getListDetails()
getFullEmail()
getEmail()
getEmailsByIssue()
removeEmails()
removeAssociation()
isAllowedToEmail()
buildFullHeaders()
sendDirectEmail()
getRecipientsCC()
sendEmail()
getMessageIDByID()
getIDByMessageID()
getIssueByMessageID()
getIssueFromEmail()
getParentMessageIDbyMessageID()
getSentEmailCountByUser()
getProjectByEmailAccount()
moveEmail()
deleteMessage()
blockEmailIfNeeded()
expungeEmails($sup_ids) X-Ref |
Permanently removes the given support emails from the associated email server. param: array $sup_ids The list of support emails return: integer 1 if the removal worked, -1 otherwise |
removeEmail($sup_id) X-Ref |
Removes the given support email from the database table. param: integer $sup_id The support email ID return: boolean |
getListingSides($sup_id) X-Ref |
Method used to get the next and previous messages in order to build side links when viewing a particular email. param: integer $sup_id The email ID return: array Information on the next and previous messages |
getIssueSides($issue_id, $sup_id) X-Ref |
Method used to get the next and previous messages in order to build side links when viewing a particular email associated with an issue. param: integer $issue_id The issue ID param: integer $sup_id The email ID return: array Information on the next and previous messages |
saveRoutedEmail($message) X-Ref |
Method used to save the email note into a backup directory. param: string $message The full body of the email |
getSender($sup_ids) X-Ref |
Method used to get the sender of a given set of emails. param: integer $sup_ids The email IDs return: array The 'From:' headers for those emails |
clearErrors() X-Ref |
Method used to clear the error stack as required by the IMAP PHP extension. return: void |
restoreEmails() X-Ref |
Method used to restore the specified support emails from 'removed' to 'active'. return: integer 1 if the update worked, -1 otherwise |
getRemovedList() X-Ref |
Method used to get the list of support email entries that are set as 'removed'. return: array The list of support emails |
removeEmailByAccounts($ids) X-Ref |
Method used to remove all support email entries associated with a specified list of support email accounts. param: array $ids The list of support email accounts return: boolean |
getServerURI($info, $tls = FALSE) X-Ref |
Method used to build the server URI to connect to. param: array $info The email server information param: boolean $tls Whether to use TLS or not return: string The server URI to connect to |
connectEmailServer($info) X-Ref |
Method used to connect to the provided email server. param: array $info The email server information return: resource The email server connection |
getTotalEmails($mbox) X-Ref |
Method used to get the total number of emails in the specified mailbox. param: resource $mbox The mailbox return: integer The number of emails |
getEmailInfo($mbox, $info, $num) X-Ref |
Method used to get the information about a specific message from a given mailbox. XXX this function does more than that. param: resource $mbox The mailbox param: array $info The support email account information param: integer $num The index of the message return: void |
createIssueFromEmail($info, $headers, $message_body, $date, $from, $subject, $to, $cc) X-Ref |
Creates a new issue from an email if appropriate. Also returns if this message is related to a previous message. param: array $info An array of info about the email account. param: string $headers The headers of the email. param: string $message_body The body of the message. param: string $date The date this message was sent param: string $from The name and email address of the sender. param: string $subject The subject of this message. param: array $to An array of to addresses param: array $cc An array of cc addresses return: array An array of information about the message |
closeEmailServer($mbox) X-Ref |
Method used to close the existing connection to the email server. param: resource $mbox The mailbox return: void |
getMessageIDs($ema_id) X-Ref |
Builds a list of all distinct message-ids available in the provided email account. param: integer $ema_id The support email account ID return: array The list of message-ids |
exists($message_id) X-Ref |
Checks if a message already is downloaded. param: string $message_id The Message-ID header return: boolean |
insertEmail($row, &$structure, &$sup_id, $closing = false) X-Ref |
Method used to add a new support email to the system. param: array $row The support email details param: object $structure The email structure object param: integer $sup_id The support ID to be passed out param: boolean $closing If this email comes from closing the issue return: integer 1 if the insert worked, -1 otherwise |
getParam($name) X-Ref |
Method used to get a specific parameter in the email listing cookie. param: string $name The name of the parameter return: mixed The value of the specified parameter |
saveSearchParams() X-Ref |
Method used to save the current search parameters in a cookie. return: array The search parameters |
getSortingInfo($options) X-Ref |
Method used to get the current sorting options used in the grid layout of the emails listing page. param: array $options The current search parameters return: array The sorting options |
getEmailListing($options, $current_row = 0, $max = 5) X-Ref |
Method used to get the list of emails to be displayed in the grid layout. param: array $options The search parameters param: integer $current_row The current page number param: integer $max The maximum number of rows per page return: array The list of issues to be displayed |
buildWhereClause($options) X-Ref |
Method used to get the list of emails to be displayed in the grid layout. param: array $options The search parameters return: string The where clause |
extractAttachments($issue_id, $input, $internal_only = false, $associated_note_id = false) X-Ref |
Method used to extract and associate attachments in an email to the given issue. param: integer $issue_id The issue ID param: mixed $input The full body of the message or decoded email. param: boolean $internal_only Whether these files are supposed to be internal only or not param: integer $associated_note_id The note ID that these attachments should be associated with return: void |
associateEmail($usr_id, $issue_id, $items) X-Ref |
Method used to silently associate a support email with an existing issue. param: integer $usr_id The user ID of the person performing this change param: integer $issue_id The issue ID param: array $items The list of email IDs to associate return: integer 1 if it worked, -1 otherwise |
associate($usr_id, $issue_id, $items, $authorize = false, $add_recipients_to_nl = false) X-Ref |
Method used to associate a support email with an existing issue. param: integer $usr_id The user ID of the person performing this change param: integer $issue_id The issue ID param: array $items The list of email IDs to associate param: boolean $authorize If the senders should be added the authorized repliers list return: integer 1 if it worked, -1 otherwise |
getEmailDetails($ema_id, $sup_id) X-Ref |
Method used to get the support email entry details. param: integer $ema_id The support email account ID param: integer $sup_id The support email ID return: array The email entry details |
getEmailBySequence($issue_id, $sequence) X-Ref |
Returns the nth note for a specific issue. The sequence starts at 1. param: integer $issue_id The id of the issue. param: integer $sequence The sequential number of the email. return: array An array of data containing details about the email. |
getListDetails($items) X-Ref |
Method used to get the list of support emails associated with a given set of issues. param: array $items List of issues return: array The list of support emails |
getFullEmail($sup_id) X-Ref |
Method used to get the full email message for a given support email ID. param: integer $sup_id The support email ID return: string The full email message |
getEmail($sup_id) X-Ref |
Method used to get the email message for a given support email ID. param: integer $sup_id The support email ID return: string The email message |
getEmailsByIssue($issue_id) X-Ref |
Method used to get all of the support email entries associated with a given issue. param: integer $issue_id The issue ID return: array The list of support emails |
removeEmails() X-Ref |
Method used to update all of the selected support emails as 'removed' ones. return: integer 1 if it worked, -1 otherwise |
removeAssociation() X-Ref |
Method used to remove the association of all support emails for a given issue. return: integer 1 if it worked, -1 otherwise |
isAllowedToEmail($issue_id, $sender_email) X-Ref |
Checks whether the given email address is allowed to send emails in the issue ID. param: integer $issue_id The issue ID param: string $sender_email The email address return: boolean |
buildFullHeaders($issue_id, $message_id, $from, $to, $cc, $subject, $body, $in_reply_to) X-Ref |
Method used to build the headers of a web-based message. param: integer $issue_id The issue ID param: string $message_id The message-id param: string $from The sender of this message param: string $to The primary recipient of this message param: string $cc The extra recipients of this message param: string $body The message body param: string $in_reply_to The message-id that we are replying to return: string The full email |
sendDirectEmail($issue_id, $from, $to, $cc, $subject, $body, $message_id, $sender_usr_id = false) X-Ref |
Method used to send emails directly from the sender to the recipient. This will not re-write the sender's email address to issue-xxxx@ or whatever. param: integer $issue_id The issue ID param: string $from The sender of this message param: string $to The primary recipient of this message param: string $cc The extra recipients of this message param: string $subject The subject of this message param: string $body The message body param: string $message_id The message-id param: integer $sender_usr_id The ID of the user sending this message. return: void |
getRecipientsCC($cc) X-Ref |
Method used to parse the Cc list in a string format and return an array of the email addresses contained within. param: string $cc The Cc list return: array The list of email addresses |
sendEmail($parent_sup_id = FALSE) X-Ref |
Method used to send an email from the user interface. return: integer 1 if it worked, -1 otherwise |
getMessageIDByID($sup_id) X-Ref |
Method used to get the message-id associated with a given support email entry. param: integer $sup_id The support email ID return: integer The email ID |
getIDByMessageID($message_id) X-Ref |
Method used to get the support ID associated with a given support email message-id. param: string $message_id The message ID return: integer The email ID |
getIssueByMessageID($message_id) X-Ref |
Method used to get the issue ID associated with a given support email message-id. param: string $message_id The message ID return: integer The issue ID |
getIssueFromEmail($sup_id) X-Ref |
Method used to get the issue ID associated with a given support email entry. param: integer $sup_id The support email ID return: integer The issue ID |
getParentMessageIDbyMessageID($msg_id) X-Ref |
Returns the message-id of the parent email. param: string $msg_id The message ID return: string The message id of the parent email or false |
getSentEmailCountByUser($usr_id, $start, $end, $associated) X-Ref |
Returns the number of emails sent 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 param: boolean $associated If this should return emails associated with issues or non associated emails. return: integer The number of emails sent by the user. |
getProjectByEmailAccount($ema_id) X-Ref |
Returns the projectID based on the email account param: integer $ema_id The id of the email account. return: integer The ID of the of the project. |
moveEmail($sup_id, $current_ema_id, $new_ema_id) X-Ref |
Moves an email from one account to another. param: integer $sup_id The ID of the message. param: integer $current_ema_id The ID of the account the message is currently in. param: integer $new_ema_id The ID of the account to move the message too. return: integer -1 if there was error moving the message, 1 otherwise. |
deleteMessage($info, $mbox, $num) X-Ref |
Deletes the specified message from the server NOTE: YOU STILL MUST call imap_expunge($mbox) to permanently delete the message. param: array $info An array of email account information param: object $mbox The mailbox object param: integer $num The number of the message to delete. |
blockEmailIfNeeded($email) X-Ref |
Check if this email needs to be blocked and if so, block it. |
Generated: Wed Dec 19 21:21:33 2007 | Cross-referenced by PHPXref 0.7 |