Class Zend_Mail

Description
Description | Vars (details) | Methods (details)

Class for sending an email.

Located in /library/Zend/Mail.php (line 53) 

Zend_Mime_Message
   |
   --Zend_Mail
Variable Summary
Description | Vars (details) | Methods (details)
mixed $_charset
Zend_Mail_Transport_Interface $_defaultTransport
mixed $_from
mixed $_hasAttachments
mixed $_hasHtmlBody
mixed $_hasTextBody
mixed $_headers
mixed $_mimeBoundary
mixed $_recipients
mixed $_subject
Method Summary
Description | Vars (details) | Methods (details)
Zend_Mail __construct ([string $charset = 'iso-8859-1'])
Zend_Mime_Part addAttachment (String $body, [String $mimeType = Zend_Mime::TYPE_OCTETSTREAM], [String $disposition = Zend_Mime::DISPOSITION_ATTACHMENT], [String $encoding = Zend_Mime::ENCODING_BASE64])
void addBcc (String $email)
void addCc (String $email, [String $name = ''])
void addHeader (String $name, String $value, [Boolean $append = false])
void addTo (String $email, [String $name = ''])
string getFrom ()
string getMimeBoundary ()
Array getRecipients ()
string getSubject ()
void send ([Zend_Mail_Transport_Interface $transport = null])
Zend_Mime_Part setBodyHtml (String $html, [String $charset = null])
Zend_Mime_Part setBodyText (String $txt, [String $charset = null])
void setDefaultTransport (Zend_Mail_Transport_Interface $transport)
void setFrom (String $email, String $name)
void setMimeBoundary (String $boundary)
void setSubject (String $subject)
void _addRecipient (string $email)
void _addRecipientAndHeader (String $headerName, String $name, String $email)
String _encodeHeader (String $value)
String _getHeaders ([String $boundary = null])
void _sendMail (Zend_Mail_Transport_Interface $transport)
void _sendMultiPart (Zend_Mail_Transport_Interface $transport)
void _sendSinglePart (Zend_Mail_Transport_Interface $transport)
void _storeHeader (String $headerName, String $value, [Boolean $append = false])
Variables
Description | Vars (details) | Methods (details)
mixed $_charset = null (line 62)
  • access: protected
Zend_Mail_Transport_Interface $_defaultTransport = null (line 59)
  • access: protected
  • static:
mixed $_from = null (line 63)
  • access: protected
mixed $_hasAttachments = false (line 67)
  • access: protected
mixed $_hasHtmlBody = false (line 66)
  • access: protected
mixed $_hasTextBody = false (line 65)
  • access: protected
mixed $_headers = array() (line 60)
  • access: protected
mixed $_mimeBoundary = null (line 68)
  • access: protected
mixed $_recipients = array() (line 61)
  • access: protected
mixed $_subject = null (line 64)
  • access: protected

Inherited Variables

Inherited from Zend_Mime_Message

Zend_Mime_Message::$_mime
 Zend_Mime_Message::$_parts
Methods
Description | Vars (details) Methods (details)
Constructor __construct (line 87)

Public constructor

  • access: public
Zend_Mail __construct ([string $charset = 'iso-8859-1'])
  • string $charset
addAttachment (line 174)

Adds an attachment to this eMail

  • return: Created Part Object for advanced settings
  • access: public
Zend_Mime_Part addAttachment (String $body, [String $mimeType = Zend_Mime::TYPE_OCTETSTREAM], [String $disposition = Zend_Mime::DISPOSITION_ATTACHMENT], [String $encoding = Zend_Mime::ENCODING_BASE64])
  • String $body
  • String $mimeType
  • String $disposition
  • String $encoding
addBcc (line 298)

Adds Bcc recipient

  • access: public
void addBcc (String $email)
  • String $email
addCc (line 287)

Adds Cc-header and recipient

  • access: public
void addCc (String $email, [String $name = ''])
  • String $name
  • String $email
addHeader (line 365)

Add a custom header to this eMail

  • access: public
void addHeader (String $name, String $value, [Boolean $append = false])
  • String $name
  • String $value
  • Boolean $append
addTo (line 275)

Adds to-header and recipient

  • access: public
void addTo (String $email, [String $name = ''])
  • String $name
  • String $email
getFrom (line 419)

returns the sender of the mail

  • access: public
string getFrom ()
getMimeBoundary (line 109)

returns the boundary string used for this email.

  • access: public
string getMimeBoundary ()
getRecipients (line 309)

Return list of recipient email addresses

  • return: (of strings)
  • access: public
Array getRecipients ()
getSubject (line 353)

returns the subject of the mail

  • access: public
string getSubject ()
send (line 478)

Sends this email using the given transport or a previously set DefaultTransport or the internal mail function if no default transport had been set.

  • access: public
void send ([Zend_Mail_Transport_Interface $transport = null])
setBodyHtml (line 147)

Sets the HTML Body for this eMail

  • access: public
Zend_Mime_Part setBodyHtml (String $html, [String $charset = null])
  • String $html
  • String $charset
setBodyText (line 122)

Sets the Text body for this message.

  • access: public
Zend_Mime_Part setBodyText (String $txt, [String $charset = null])
  • String $txt
  • String $charset
setDefaultTransport (line 77)

sets the default Zend_Mail_Transport_Interface for all following uses of Zend_Mail::send();

  • access: public
  • static:
void setDefaultTransport (Zend_Mail_Transport_Interface $transport)
setFrom (line 320)

Sets From Header and sender of the eMail

  • access: public
void setFrom (String $email, String $name)
  • String $email
  • String $name
setMimeBoundary (line 98)

Set an arbitrary mime boundary for this mail object.

If not set, Zend_Mime will generate one.

  • access: public
void setMimeBoundary (String $boundary)
  • String $boundary
setSubject (line 337)

Sets the subject of the eMail

  • access: public
void setSubject (String $subject)
  • String $subject
_addRecipient (line 242)

Add a recipient

  • access: protected
void _addRecipient (string $email)
  • string $email
_addRecipientAndHeader (line 257)

Helper function for adding a Recipient and the according header

  • access: protected
void _addRecipientAndHeader (String $headerName, String $name, String $email)
  • String $headerName
  • String $name
  • String $email
_encodeHeader (line 199)

Encode header fields according to RFC1522 if it contains non-printable characters

  • access: protected
String _encodeHeader (String $value)
  • String $value
_getHeaders (line 386)

Return all Mail Headers as a string. If a boundary is given, a multipart-header is generated with a mime-type of multipart/alternative or multipart/mixed depending on the MailParts in this ZMail object.

  • access: protected
String _getHeaders ([String $boundary = null])
  • String $boundary
_sendMail (line 458)

Send this mail using the given transport

  • access: protected
void _sendMail (Zend_Mail_Transport_Interface $transport)
_sendMultiPart (line 429)

Sends a Multipart eMail using the given Transport

  • access: protected
void _sendMultiPart (Zend_Mail_Transport_Interface $transport)
_sendSinglePart (line 444)

Sends a single part message using a given transport

  • access: protected
void _sendSinglePart (Zend_Mail_Transport_Interface $transport)
_storeHeader (line 221)

Adds another custom header to this eMail if append is true and the header does already exist, append the given string to the existing header.

  • access: protected
void _storeHeader (String $headerName, String $value, [Boolean $append = false])
  • String $headerName
  • String $value
  • Boolean $append

Inherited Methods

Inherited From Zend_Mime_Message

Zend_Mime_Message::addPart()
Zend_Mime_Message::createFromMessage()
Zend_Mime_Message::generateMessage()
Zend_Mime_Message::getMime()
Zend_Mime_Message::getPartContent()
Zend_Mime_Message::getPartHeaders()
Zend_Mime_Message::getParts()
Zend_Mime_Message::isMultiPart()
Zend_Mime_Message::setMime()
Zend_Mime_Message::setParts()
Zend_Mime_Message::_disassembleMime()

Documentation generated on Wed, 08 Mar 2006 04:53:29 -0800 by phpDocumentor 1.3.0RC4