SharedLib
[ class tree: SharedLib ] [ index: SharedLib ] [ all elements ]
Packages:
SharedLib


Files:
mail.php

Classes:
slMail

Class: slMail

Source Location: /mail.php

Class Overview

slPHPMailer
   |
   --slMail

slMail


Author(s):

  • IceWarp Technology - Pavel Perna

Version:

  • 0.1

Copyright:

  • 2009

Variables

Methods

Class Details

[line 20]
slMail

Class for composing and sending emails.




Tags:

author:  IceWarp Technology - Pavel Perna
version:  0.1
copyright:  2009
access:  public


[ Top ]

Class Variables

$bAllowEmptyReceipient =

[line 30]

Allow empty recipient ( no to,cc,bcc )



Tags:

access:  public

Type:   mixed


[ Top ]

$bRelay =

[line 25]

Use relay ( bounce back messages )



Tags:

access:  public

Type:   mixed


[ Top ]


Class Methods

constructor __construct [line 40]

void __construct( [string $charSet = 'UTF-8'], [ $bRelay = false])

slMail::__construct()

Creates an slMail object instance




Tags:

access:  public


Parameters:

string   $charSet   OPTIONAL charset to be used for sending message
   $bRelay  

[ Top ]

method addAttachment [line 210]

void addAttachment( mixed $file, mixed $type, [string $name = ''], [string $method = ''])

slMail::addAttachment()

Add an attachment to mail.




Tags:

access:  public


Parameters:

mixed   $file   Name of the attachment file.
mixed   $type   Mime type of the attachment.
string   $name   Name of the attachment.
string   $method   Attachment method

[ Top ]

method addBCC [line 136]

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

slMail::addBCC()

Add the BCC email address and name.




Tags:

access:  public


Parameters:

mixed   $address   Recipient address
string   $name   Recipient name

[ Top ]

method addCC [line 122]

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

slMail::addCC()

Add the CC email address and name.




Tags:

access:  public


Parameters:

mixed   $address   Recipient address
string   $name   Recipient name

[ Top ]

method addEmbededAttachment [line 232]

void addEmbededAttachment( mixed $file, mixed $type, mixed $cid, [string $name = ''])

slMail::addEmbededAttachment()

Add an embeded attachment to mail




Tags:

access:  public


Parameters:

mixed   $file   Name of the attachment file.
mixed   $type   Mime type of the attachment.
mixed   $cid   Content ID of the attachment (e.g. <img src="cid:1"/>).
string   $name   Name of the attachment.

[ Top ]

method addHeader [line 248]

void addHeader( mixed $header)

slMail::addHeader()

Add an user defined header.




Tags:

access:  public


Parameters:

mixed   $header   Header value( Header:value )

[ Top ]

method addReplyTo [line 155]

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

slMail::addReplyTo()

Add the Replay-To email address and name.




Tags:

access:  public


Parameters:

mixed   $address   Recipient address
string   $name   Recipient name

[ Top ]

method addTo [line 108]

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

slMail::addTo()

Add the To email address and name.




Tags:

access:  public


Parameters:

mixed   $address   Recipient address
string   $name   Recipient name

[ Top ]

method encrypt [line 372]

void encrypt( )

slMail::encrypt()

Encrypts the message before send




Tags:

access:  public


[ Top ]

method encryptAndSign [line 398]

void encryptAndSign( &$fp, &$filename, mixed $fp, mixed $filename)

slMail::encryptAndSign()

Do the signature/encryption




Tags:

access:  public


Parameters:

mixed   $fp  
mixed   $filename  
   &$fp  
   &$filename  

[ Top ]

method errmsg [line 421]

The errmsg( )

slMail::errmsg()

Get the most recent mailer error message.




Tags:

return:  error message.
access:  public


[ Top ]

method getMessage [line 284]

void getMessage( [string $charset = 'UTF-8'])

slMail::getMessage()

Get raw source of the message(string)




Tags:

access:  public


Parameters:

string   $charset   DEFAULT=UTF-8 Message will be returned in this charset

[ Top ]

method getMessageTempFile [line 312]

void getMessageTempFile( [string $charset = 'UTF-8'])

slMail::getMessageTempFile()

Get source file of the message(path).




Tags:

access:  public


Parameters:

string   $charset   DEFAULT=UTF-8 Message will be returned in this charset

[ Top ]

method send [line 345]

void send( [bool $header = false], [bool $body = false], [string $charset = false], [ &$filename = false], bool $filename)

slMail::send()

This method sends an email. If header and body is not supplied, it is autocreated depending on used AddTo, AddCC, AddBcc, SetSubject,SetBody,etc functions.When header or body is supplied ,it overrides the one prepared by object.Sending charset is set to UTF-8 by default or to the one set in constructor or by setCharset method. Filename is generated when not provided( temp file for sending )




Tags:

access:  public


Parameters:

bool   $header   OPTIONAL If supported it replaces generated headers
bool   $body   OPTIONAL If supported it replaces generated body
string   $charset   OPTIONAL If not supported UTF-8 is used
bool   $filename   NOT REQUIRED
   &$filename  

[ Top ]

method setBody [line 183]

void setBody( mixed $text, [string $html = ''])

slMail::setBody()

Sets the body of the message.If html is not provided it sends text/plain message




Tags:

access:  public


Parameters:

mixed   $text   The text part
string   $html   OPTIONAL The html part

[ Top ]

method setCharset [line 361]

void setCharset( mixed $charset)

slMail::setCharset()

Sets the message charset




Tags:

access:  public


Parameters:

mixed   $charset   Charset name

[ Top ]

method setFrom [line 88]

void setFrom( mixed $address, [string $name = ''], [bool $setSender = true])

slMail::setFrom()

Set the From email address and name.




Tags:

access:  public


Parameters:

mixed   $address   Recipient address
string   $name   Recipient name
bool   $setSender   If true, the Sender will be set

[ Top ]

method setPriority [line 261]

void setPriority( mixed $priority)

slMail::setPriority()

Set the priority of the message.




Tags:

access:  public


Parameters:

mixed   $priority   The priority ('high', 'normal', 'low').

[ Top ]

method setRelay [line 73]

void setRelay( mixed $relay)

slMail::setRelay()

Whether to use smtp relay ( bonce back messages )




Tags:

access:  public


Parameters:

mixed   $relay  
  • 0 - OFF 1 - ON ( bounce back )

[ Top ]

method setSendMode [line 59]

void setSendMode( mixed $mode)

slMail::setSendMode()

Sets the mode to send a message




Tags:

access:  public


Parameters:

mixed   $mode   'memory' - message is send using memort 'file - message is send using file stream'

[ Top ]

method setSubject [line 168]

void setSubject( mixed $subject)

slMail::setSubject()

Set the Subject of the message.




Tags:

access:  public


Parameters:

mixed   $subject   Message subject

[ Top ]

method sign [line 384]

void sign( )

slMail::sign()

Signs the message before send




Tags:

access:  public


[ Top ]

Documentation generated on Wed, 18 Feb 2009 14:39:28 +0100 by phpDocumentor 1.4.1