Docs For Class xPliciMail

Description

Abstract class to send an email

author: SimpliciWeb
version: $Id: xPliciMail.class.php 913 2008-03-19 15:46:33Z stephanet $

Located in /core/internal_components/common/mail/xPliciMail.class.php (line 66)

Direct descendents

Class	Description
CustomerMail	Send customer mail (based on the database TTextEmailBody)
DbIndexMail	Send db index mail from
InternalMail	Send an internalMail to Super admin emails
ModuleMail	The module send mail to use
PageMail	Send a mail containing the current page
SendMail	Send mail to specific persons.
WebsiteInternalMail	Web site internal mail

Variable Summary

array $m_authorized_body_type

string $m_body_type

bool $m_debug

string $m_from_email

string $m_from_name

string $m_interface_needed

string $m_recipients_by_coma

string $m_subject

string $m_subject_prefix

Method Summary

xPliciMail xPliciMail ([bool $send_from_admin_super = false])

void clearSubjectPrefix ()

string convertContentWithBaseMailTemplate (string $p_content)

void eraseSubjectPrefix ()

void setBodyType (string $p_body_type)

void setFromEmail (string $p_mail)

void setFromName (string $p_name)

void setRecipients (string $p_recipients)

void setSubject ( $p_string)

void setSubjectPrefix (string $p_string)

bool xSend (string $p_content)

Variables

array $m_authorized_body_type = array() (line 112)

List of body type authorised : HTML,PLAIN_TEXT

string $m_body_type = "" (line 118)

Type of email body

bool $m_debug = false (line 125)

Debug

string $m_from_email = "" (line 93)

From email

string $m_from_name = "" (line 99)

From name

string $m_interface_needed = "null" (line 74)

Interface needed for sending mail

string $m_recipients_by_coma = "" (line 87)

recipients separated by coma

string $m_subject = "" (line 81)

Subject for the mail

string $m_subject_prefix = "" (line 105)

Subject prefix

Methods

Constructor xPliciMail (line 134)

Constructor, init the requests and objects

xPliciMail xPliciMail ([bool $send_from_admin_super = false])

bool $send_from_admin_super

clearSubjectPrefix (line 232)

Clear subject prefix

void clearSubjectPrefix ()

convertContentWithBaseMailTemplate (line 334)

Convert cotent with base mail template

string convertContentWithBaseMailTemplate (string $p_content)

string $p_content

eraseSubjectPrefix (line 184)

Erase subject

void eraseSubjectPrefix ()

setBodyType (line 241)

Set body type

void setBodyType (string $p_body_type)

string $p_body_type

setFromEmail (line 215)

Set from email

void setFromEmail (string $p_mail)

string $p_mail

setFromName (line 224)

Set from name

void setFromName (string $p_name)

string $p_name

setRecipients (line 206)

Set recipients separated by coma

void setRecipients (string $p_recipients)

string $p_recipients

setSubject (line 197)

void setSubject ( $p_string)

$p_string

setSubjectPrefix (line 193)

Set subject prefix

void setSubjectPrefix (string $p_string)

string $p_string

xSend (line 258)

Send email

return: TRUE on error

bool xSend (string $p_content)

string $p_content