Benvingut a la secció d'administració del mòdul CMSMailer';
$lang['changelog'] = '
This module provides no end user functionality. It is designed to be integrated into other modules to provide email capabilities. Thats it, nothing more.
This module provides a simple wrapper around all of the methods and variables of phpmailer. It is designed for use by other module developers, below is an example, and a brief API reference. Please read the PHPMailer documentation included for more information.
void reset()
Reset the object back to the values specified in the admin panel
string GetAltBody()
Return the alternate body of the email
void SetAltBody( $string )
Set the alternate body of the email
string GetBody()
Return the primary body of the email
void SetBody( $string )
Set the primary body of the email
string GetCharSet()
Default: iso-8859-1
Return the mailer character set
void SetCharSet( $string )
Set the mailer character set
string GetConfirmReadingTo()
Return the address confirmed reading email flag
void SetConfirmReadingTo( $address )
Set or unset the confirm reading address
string GetContentType()
Default: text/plain
Return the content type
void SetContentType()
Set the content type
string GetEncoding()
Return the encoding
void SetEncoding( $encoding )
Set the encoding
Options are: 8bit, 7bit, binary, base64, quoted-printable
string GetErrorInfo()
Return any error information
string GetFrom()
Return the current originating address
void SetFrom( $address )
Set the originating address
string GetFromName()
Return the current originating name
SetFromName( $name )
Set the originating name
string GetHelo()
Return the HELO string
SetHelo( $string )
Set the HELO string
Default value: $hostname
string GetHost()
Return the SMTPs host separated by semicolon
void SetHost( $string )
Set the hosts
string GetHostName()
Return the hostname used for SMTP Helo
void SetHostName( $hostname )
Set the hostname used for SMTP Helo
string GetMailer()
Return the mailer
void SetMailer( $mailer )
Set the mailer, either sendmail,mail, or smtp
string GetPassword()
Return the password for smtp auth
void SetPassword( $string )
Set the password for smtp auth
int GetPort()
Return the port number for smtp connections
void SetPort( $int )
Set the port for smtp connections
int GetPriority()
Return the message priority
void SetPriority( int )
Set the message priority
Values are 1=High, 3 = Normal, 5 = Low
string GetSender()
Return the sender email (return path) string
void SetSender( $address )
Set the sender string
string GetSendmail()
Return the sendmail path
void SetSendmail( $path )
Set the sendmail path
bool GetSMTPAuth()
Return the current value of the smtp auth flag
SetSMTPAuth( $bool )
Set the smtp auth flag
bool GetSMTPDebug()
Return the value of the SMTP debug flag
void SetSMTPDebug( $bool )
Set the SMTP debug flag
bool GetSMTPKeepAlive()
Return the value of the SMTP keep alive flag
SetSMTPKeepAlive( $bool )
Set the SMTP keep alive flag
string GetSubject()
Return the current subject string
void SetSubject( $string )
Set the subject string
int GetTimeout()
Return the timeout value
void SetTimeout( $seconds )
Set the timeout value
string GetUsername()
Return the smtp auth username
void SetUsername( $string )
Set the smtp auth username
int GetWordWrap()
Return the wordwrap value
void SetWordWrap( $int )
Return the wordwrap value
AddAddress( $address, $name = '' )
Add a destination address
AddAttachment( $path, $name = '', $encoding = 'base64', $type = 'application/octent-stream' )
Add a file attachment
AddBCC( $address, $name = '' )
Add a BCC'd destination address
AddCC( $address, $name = '' )
Add a CC'd destination address
AddCustomHeader( $txt )
Add a custom header to the email
AddEmbeddedImage( $path, $cid, $name = '', $encoding = 'base64', $type = 'application/octent-stream' )
Add an embedded image
AddReplyTo( $address, $name = '' )
Add a reply to address
AddStringAttachment( $string, $filename, $encoding = 'base64', $type = 'application/octent-stream' )
Add a file attachment
ClearAddresses()
Clear all addresses
ClearAllRecipients()
Clear all recipients
ClearAttachments()
Clear all attachments
ClearBCCs()
Clear all BCC addresses
ClearCCs()
Clear all CC addresses
ClearCustomHeaders()
Clear all custom headers
ClearReplyto()
Clear reply to address
IsError()
Check for an error condition
bool IsHTML( $bool )
Set the html flag
Note possibly this should be a get and set method
bool IsMail()
Check wether we are using mail
bool IsQmail()
Check wether we are using qmail
IsSendmail()
Check wether we are using sendmail
IsSMTP()
Check wether we are using smtp
Send()
Send the currently prepared email
SetLanguage( $lang_type, $lang_path = '' )
Set the current language and (optional) language path
SmtpClose()
Close the smtp connection
This module does not include commercial support. However, there are a number of resources available to help you with it:
As per the GPL, this software is provided as-is. Please read the text
of the license for the full disclaimer.