phpCoreLib2
[ class tree: phpCoreLib2 ] [ index: phpCoreLib2 ] [ all elements ]

Class: DMailingAbstract

Source Location: /Mails/DMailingAbstract.php

Class Overview

DObject
   |
   --DMailingAbstract

Abstract class for mailing


Variables

Methods


Child classes:

DMailSend
SMTP send mail class
DPasswordProtectedMailing
Password Protected Mailing class
DSimplePHPMailing
Base PHP Mailing class
DSMTPSendMail
SMTP send mail class

Inherited Constants

Inherited Variables

Inherited Methods

Class: DObject

DObject::__construct()
Constructor
DObject::debug()
Debig
DObject::getClassMembers()
Gets member variables of the instance
DObject::getClassMemberType()
Gets class member type
DObject::getClassMethods()
Gets classes of the class
DObject::getClassName()
Gets class name
DObject::PHPSerialize()
Gets serialized string of the class
DObject::trace()
Trace
DObject::__destruct()
Descructor
DObject::__toString()
Returns String equivalent of the object.

Class Details

[line 15]
Abstract class for mailing



[ Top ]


Class Variables

$AltBody =  ''

[line 86]

Sets the text-only body of the message. This automatically sets the email to multipart/alternative. This body can be read by mail clients that do not have HTML email capability such as mutt. Clients that can read HTML will view the normal Body.


Type:   string


[ Top ]

$Body =  ''

[line 77]

Sets the Body of the message. This can be either an HTML or text body.

If HTML then run IsHTML(true).



Type:   string


[ Top ]

$CharSet =  'iso-8859-1'

[line 26]

Sets the CharSet of the message.


Type:   string


[ Top ]

$ConfirmReadingTo =  ''

[line 111]

Sets the email address that a reading confirmation will be sent.


Type:   string


[ Top ]

$ContentType =  'text/plain'

[line 32]

Sets the Content-type of the message.


Type:   string


[ Top ]

$Encoding =  '8bit'

[line 39]

Sets the Encoding of the message. Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable".


Type:   string


[ Top ]

$ErrorInfo =  ''

[line 45]

Holds the most recent mailer error message.


Type:   string


[ Top ]

$From =  'nobody@localhost'

[line 51]

Sets the From email address for the message.


Type:   string


[ Top ]

$FromName =  'Nobody User'

[line 57]

Sets the From name of the message.


Type:   string


[ Top ]

$Hostname =  ''

[line 119]

Sets the hostname to use in Message-Id and Received headers and as default HELO string. If empty, the value returned by SERVER_NAME is used or 'localhost.localdomain'.


Type:   string


[ Top ]

$Mailer =  'mail'

[line 99]

Method to send mail: ("mail", "sendmail", or "smtp").


Type:   string


[ Top ]

$Priority =  3

[line 20]

Email priority (1 = High, 3 = Normal, 5 = low).


Type:   int


[ Top ]

$Sender =  ''

[line 64]

Sets the Sender email (Return-Path) of the message. If not empty, will be sent via -f to sendmail or as 'MAIL FROM' in smtp mode.


Type:   string


[ Top ]

$Sendmail =  '/usr/sbin/sendmail'

[line 105]

Sets the path of the sendmail program.


Type:   string


[ Top ]

$Subject =  ''

[line 70]

Sets the Subject of the message.


Type:   string


[ Top ]

$WordWrap =  0

[line 93]

Sets word wrapping on the body of the message to a given number of characters.


Type:   int


[ Top ]

$_attachment = array()

[line 132]


Type:   mixed


[ Top ]

$_bcc = array()

[line 130]


Type:   mixed


[ Top ]

$_boundary = array()

[line 135]


Type:   mixed


[ Top ]

$_cc = array()

[line 129]


Type:   mixed


[ Top ]

$_CustomHeader = array()

[line 133]


Type:   mixed


[ Top ]

$_error_count =  0

[line 137]


Type:   mixed


[ Top ]

$_language = array()

[line 136]


Type:   mixed


[ Top ]

$_LE =  "\n"

[line 138]


Type:   mixed


[ Top ]

$_message_type =  ''

[line 134]


Type:   mixed


[ Top ]

$_ReplyTo = array()

[line 131]


Type:   mixed


[ Top ]

$_smtp =  NULL

[line 127]


Type:   mixed


[ Top ]

$_to = array()

[line 128]


Type:   mixed


[ Top ]



Class Methods


constructor DMailingAbstract [line 146]

DMailingAbstract DMailingAbstract( )

Constructor



Tags:

access:  public


[ Top ]

method AddAddress [line 156]

void AddAddress( string $address, [string $name = ''])

Adds a "To" address.



Parameters:

string   $address  
string   $name  

[ Top ]

method AddBCC [line 180]

void AddBCC( string $address, [string $name = ''])

Adds a "Bcc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.



Parameters:

string   $address  
string   $name  

[ Top ]

method AddCC [line 168]

void AddCC( string $address, [string $name = ''])

Adds a "Cc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.



Parameters:

string   $address  
string   $name  

[ Top ]

method AddReplyTo [line 190]

void AddReplyTo( string $address, [string $name = ''])

Adds a "Reply-To" address.



Parameters:

string   $address  
string   $name  

[ Top ]

method HeaderLine [line 198]

void HeaderLine( $name, $value)



Parameters:

   $name  
   $value  

[ Top ]

method _errorHandling [line 579]

void _errorHandling( [string $message = ""], [string $code = ""], [string $retError = ""], [int $debug = 0], [string $debugMsg = ''])

Handling returned error



Overridden in child classes as:

DSMTPSendMail::_errorHandling()
Handling returned error

Parameters:

string   $message  
string   $code  
string   $retError  
int   $debug  
string   $debugMsg  

[ Top ]


Documentation generated on Sat, 17 Apr 2010 22:07:23 +0300 by phpDocumentor 1.4.3