[ Index ]

PHP Cross Reference of Eventum

title

Body

[close]

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

(no description)

File Size: 1015 lines (37 kb)
Included or required: 9 times
Referenced: 0 times
Includes or requires: 6 files
 include/class.mail_queue.php
 include/class.mime_helper.php
 include/class.user.php
 include/class.error_handler.php
 include/class.setup.php
 include/class.reminder.php

Defines 1 class

Mail_API:: (39 methods):
  Mail_API()
  formatSubject()
  removeExcessRe()
  getCannedBlockedMsgExplanation()
  isVacationAutoResponder()
  getEmailAddresses()
  fixAddressQuoting()
  getAddressInfo()
  getEmailAddress()
  getName()
  getFormattedName()
  getSMTPSettings()
  setTextBody()
  setHTMLBody()
  addHTMLImage()
  setHeaders()
  addCc()
  addAttachment()
  addMessageRfc822()
  stripWarningMessage()
  getWarningMessage()
  addWarningMessage()
  stripHeaders()
  send()
  getFullHeaders()
  saveEmailInformation()
  prepareHeaders()
  getSpecializedHeaders()
  generateMessageID()
  getReferenceMessageID()
  getAllReferences()
  rewriteThreadingHeaders()
  getReferences()
  _getReferences()
  getBaseThreadingHeaders()
  unfold()
  fold()
  getMessageID()
  splitAddresses()


Class: Mail_API  - X-Ref

Class to handle the business logic related to sending email to
outside recipients. This class utilizes the PEAR::Mail
infrastructure to deliver email in a compatible way across
different platforms.

Mail_API()   X-Ref
Class constructor. It includes and initializes the required
PEAR::Mail related objects


formatSubject($issue_id, $subject)   X-Ref
Correctly formats the subject line of outgoing emails/notes

param: integer $issue_id The issue ID
param: string $subject The subject to be formatted
return: string The formatted subject

removeExcessRe($subject, $remove_issue_id = false)   X-Ref
Believe it or not, this is a method that will remove excess occurrences
of 'Re:' that commonly are found in email subject lines.
If the second parameter is true, issue #'s will also be stripped.

param: string $subject The subject line
param: boolean $remove_issue_id If the issue ID should be removed
return: string The subject line with the extra occurrences removed from it

getCannedBlockedMsgExplanation()   X-Ref
Returns the canned explanation about why an email message was blocked
and saved into an internal note.

return: string The canned explanation

isVacationAutoResponder($headers)   X-Ref
Checks whether the given headers are from a vacation
auto-responder message or not.

param: array $headers The list of headers
return: boolean

getEmailAddresses($str)   X-Ref
Method used to parse a string and return all email addresses contained
within it.

param: string $str The string containing email addresses
return: array The list of email addresses

fixAddressQuoting($address)   X-Ref
Method used to build a properly quoted email address, in the form of
"Sender Name" <sender@example.com>.

param: string $address The email address value
return: array The address information

getAddressInfo($address, $multiple = false)   X-Ref
Method used to break down the email address information and
return it for easy manipulation.

param: string $address The email address value
param: boolean $multiple If multiple addresses should be returned
return: array The address information

getEmailAddress($address)   X-Ref
Method used to get the email address portion of a given
recipient information.

param: string $address The email address value
return: string The email address

getName($address, $multiple = false)   X-Ref
Method used to get the name portion of a given recipient information.

param: string $address The email address value
param: boolean $multiple If multiple addresses should be returned
return: mixed The name or an array of names if multiple is true

getFormattedName($name, $email)   X-Ref
Method used to get the formatted name of the passed address
information.

param: string $name The name of the recipient
param: string $email The email of the recipient
return: string

getSMTPSettings()   X-Ref
Method used to get the application specific settings regarding
which SMTP server to use, such as login and server information.

return: array

setTextBody($text)   X-Ref
Method used to set the text version of the body of the MIME
multipart message that you wish to send.

param: string $text The text-based message
return: void

setHTMLBody($html)   X-Ref
Method used to set the HTML version of the body of the MIME
multipart message that you wish to send.

param: string $html The HTML-based message
return: void

addHTMLImage($filename)   X-Ref
Method used to add an embedded image to a MIME message.

param: string $filename The full path to the image
return: void

setHeaders($header, $value = FALSE)   X-Ref
Method used to set extra headers that you may wish to use when
sending the email.

param: mixed $header The header(s) to set
param: mixed $value The value of the header to be set
return: void

addCc($email)   X-Ref
Method used to add an email address in the Cc list.

param: string $email The email address to be added
return: void

addAttachment($name, $data, $content_type)   X-Ref
Method used to add an attachment to the message.

param: string $name The attachment name
param: string $data The attachment data
param: string $content_type The content type of the attachment
return: void

addMessageRfc822($message_body)   X-Ref
Method used to add a message/rfc822 attachment to the message.

param: string $message_body The attachment data
return: void

stripWarningMessage($str)   X-Ref
Removes the warning message contained in a message, so that certain users
don't receive that extra information as it may not be relevant to them.

param: string $str The body of the email
return: string The body of the email, without the warning message

getWarningMessage($type)   X-Ref
Returns the warning message that needs to be added to the top of routed
issue emails to alert the recipient that he can (or not) send emails to
the issue notification list.

param: string $type Whether the warning message is of an allowed recipient or not
return: string The warning message

addWarningMessage($issue_id, $to, $body, $headers)   X-Ref
Method used to add a customized warning message to the body
of outgoing emails.

param: integer $issue_id The issue ID
param: string $to The recipient of the message
param: string $body The body of the message
param: headers $headers The headers of the message
return: string The body of the message with the warning message, if appropriate

stripHeaders($headers)   X-Ref
Strips out email headers that should not be sent over to the recipient
of the routed email. The 'Received:' header was sometimes being used to
validate the sender of the message, and because of that some emails were
not being delivered correctly.

param: string $headers The full headers of the email
return: string The headers of the email, without the stripped ones

send($from, $to, $subject, $save_email_copy = 0, $issue_id = false, $type = '', $sender_usr_id = false, $type_id = false)   X-Ref
Method used to send the SMTP based email message.

param: string $from The originator of the message
param: string $to The recipient of the message
param: string $subject The subject of the message
param: integer $issue_id The ID of the issue. If false, email will not be associated with issue.
param: string $type The type of message this is
param: integer $sender_usr_id The id of the user sending this email.
param: integer $type_id The ID of the event that triggered this notification (issue_id, sup_id, not_id, etc)
return: string The full body of the message that was sent

getFullHeaders($from, $to, $subject)   X-Ref
Returns the full headers for the email properly encoded.

param: string $from The sender of the email
param: string $to The recipient of the email
param: string $subject The subject of this email
return: string The full header version of the email

saveEmailInformation($email)   X-Ref
Method used to save a copy of the given email to a configurable address.

param: array $email The email to save.

prepareHeaders($headers)   X-Ref
Since Mail::prepareHeaders() is not supposed to be called statically, this method
instantiates an instance of the mail class and calls prepareHeaders on it.

param: array $headers The array of headers to prepare, in an associative
return: mixed Returns false if it encounters a bad address,

getSpecializedHeaders($issue_id, $type, $headers, $sender_usr_id)   X-Ref
Generates the specialized headers for an email.

param: integer $issue_id The issue ID
param: string $type The type of message this is
param: string $headers The existing headers of this message.
param: integer $sender_usr_id The id of the user sending this email.
return: array An array of specialized headers

generateMessageID()   X-Ref
Method used to get the appropriate Message-ID header for a
given issue.

return: string The Message-ID header

getReferenceMessageID($text_headers)   X-Ref
Returns the referenced message-id for a given reply.

param: string $text_headers The full headers of the reply
return: string The message-id of the original email

getAllReferences($text_headers)   X-Ref
Returns the message IDs of all emails this message references.

param: string $text_headers The full headers of the message
return: array An array of message-ids

rewriteThreadingHeaders($issue_id, $full_email, $headers, $type = 'email')   X-Ref
Checks to make sure In-Reply-To and References headers are correct.


getReferences($issue_id, $msg_id, $type)   X-Ref
Returns a complete list of references for an email/note, including
the issue root message ID

param: integer $issue_id The ID of the issue
param: string $msg_id The ID of the message
param: string $type If this is a note or an email
return: array An array of message IDs

_getReferences($msg_id, $type, &$references)   X-Ref
Method to get the list of messages an email/note references

param: string $msg_id The ID of the parent message
param: string $type If this is a note or an email
param: array $references The array the references will be stored in.

getBaseThreadingHeaders($issue_id)   X-Ref
No description

unfold($input)   X-Ref
Unfolds message headers

param: string $input The headers to unfold
return: string The unfolded headers

fold($input)   X-Ref
Folds message headers

param: string $input The headers to fold
return: string The folded headers

getMessageID($headers, $body)   X-Ref
Returns the Message-ID from an email. If no message ID is found (Outlook 2003 doesn't
generate them in some cases) a "fake" message-id will be calculated.

param: string $headers The message headers
param: string $body The message body

splitAddresses($addresses)   X-Ref
No description



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