Transaction Engine 3 Application Programming Interface
[ class tree: Transaction Engine 3 Application Programming Interface ] [ index: Transaction Engine 3 Application Programming Interface ] [ all elements ]

Class: tNG_EmailPageSection

Source Location: /tNG3/triggers/tNG_EmailPageSection.class.php

Class Overview


Send Email Page Section SB class.


Author(s):

Variables

Methods



Class Details

[line 10]
Send Email Page Section SB class.



Tags:

access:  public


[ Top ]


Class Variables

$bcc =

[line 46]

blind copy carbon mail;



Tags:

access:  public

Type:   string


[ Top ]

$cc =

[line 39]

copy carbon mail;



Tags:

access:  public

Type:   string


[ Top ]

$content =

[line 60]

body of the email;



Tags:

access:  public

Type:   string


[ Top ]

$css =

[line 88]

the style which will be applyed;



Tags:

access:  public

Type:   string


[ Top ]

$encoding =

[line 67]

encoding type;



Tags:

access:  public

Type:   string


[ Top ]

$file =

[line 18]

filename from whom to read the styles and encoding;



Tags:

access:  public

Type:   string


[ Top ]

$format =

[line 74]

format of the email: text or html/text;



Tags:

access:  public

Type:   string


[ Top ]

$from =

[line 25]

from whom the email is send;



Tags:

access:  public

Type:   string


[ Top ]

$importance =

[line 81]

importance of the email: Normal, Low, High;



Tags:

access:  public

Type:   string


[ Top ]

$subject =

[line 53]

subject of the email;



Tags:

access:  public

Type:   string


[ Top ]

$to =

[line 32]

to whom send the email;



Tags:

access:  public

Type:   string


[ Top ]



Class Methods


constructor tNG_EmailPageSection [line 94]

tNG_EmailPageSection tNG_EmailPageSection( )

Constructor. Set default encoding and default css.



Tags:

access:  public


[ Top ]

method EndContent [line 324]

void EndContent( )

Finish the buffering of the output; Save it to content and send it to the browser; Remove any <script> tags and keep just the content of the <body> tag if exists.



Tags:

access:  public


[ Top ]

method Execute [line 380]

void Execute( )

the main method, execute the code of the class;



Tags:

access:  public


[ Top ]

method getBcc [line 215]

string getBcc( )

Getter. Get bcc.



Tags:

access:  public


[ Top ]

method getCc [line 205]

string getCc( )

Getter. Get cc.



Tags:

access:  public


[ Top ]

method getCSSFrom [line 245]

void getCSSFrom( string $file)

Setter. Set file to use for retrieving CSS and encoding.



Tags:

access:  public


Parameters:

string   $file  

[ Top ]

method getEncoding [line 235]

string getEncoding( )

Getter. Get encoding.



Tags:

access:  public


[ Top ]

method getFooter [line 304]

string getFooter( )

Getter. Get html footer.



Tags:

return:  the </body></html>
access:  protected


[ Top ]

method getFrom [line 185]

string getFrom( )

Getter. Get From.



Tags:

access:  public


[ Top ]

method getHeader [line 291]

string getHeader( )

Getter. Get html header.



Tags:

return:  the <html><head>any css or encoding</head><body>
access:  protected


[ Top ]

method getHtmlBody [line 274]

string getHtmlBody( )

Getter. Get htmlBody.

prepend to the content the html header tags with any CSS if found, and add the html footer;




Tags:

return:  the content of the email (can have any html tags but <script>)
access:  protected


[ Top ]

method getSubject [line 225]

string getSubject( )

Getter. Get subject.



Tags:

access:  public


[ Top ]

method getTextBody [line 255]

string getTextBody( )

Getter. Get textBody.



Tags:

return:  the text body of the email, stripped by all html tags;
access:  protected


[ Top ]

method getTo [line 195]

string getTo( )

Getter. Get to.



Tags:

access:  public


[ Top ]

method searchCss [line 402]

void searchCss( )

Parse the content of the $file and keep any CSS found in; If the encoding is not setted and found one in the text, it will use it.



Tags:

access:  protected


[ Top ]

method setBCC [line 135]

void setBCC( string $bcc)

Setter. Set bcc.



Tags:

access:  public


Parameters:

string   $bcc   the blind carbon copy string;

[ Top ]

method setCC [line 125]

void setCC( string $cc)

Setter. Set cc.



Tags:

access:  public


Parameters:

string   $cc   the carbon copy string;

[ Top ]

method setEncoding [line 165]

void setEncoding( [string $encoding = ''])

Setter. overwrite the default encoding.



Tags:

access:  public


Parameters:

string   $encoding   the encoding to use for encoding the email;

[ Top ]

method setFormat [line 155]

void setFormat( string $format)

Setter. Set format.



Tags:

access:  public


Parameters:

string   $format   the format text or html/text of the email

[ Top ]

method setFrom [line 105]

void setFrom( string $from)

Setter. Set from.



Tags:

access:  public


Parameters:

string   $from   the from string to use in header

[ Top ]

method setImportance [line 175]

void setImportance( string $importance)

Setter. Set importance.



Tags:

access:  public


Parameters:

string   $importance   set the importance of the email: Normal, High or Low;

[ Top ]

method setSubject [line 145]

void setSubject( string $subject)

Setter. Set subject.



Tags:

access:  public


Parameters:

string   $subject   set the subject of the email;

[ Top ]

method setTo [line 115]

void setTo( string $to)

Setter. Set to.



Tags:

access:  public


Parameters:

string   $to   the email to which the email is send;

[ Top ]



Documentation generated on Tue, 6 Dec 2005 15:11:41 +0200 by phpDocumentor 1.3.0RC3