class CInvitationMail


Located at : UKNOWVA_ROOT/components/com_community/libraries/invitation.php

Callback methods must return a CInvitationMail object. If CInvitationEmail object is not returned, the invitations will not be invoked.

Properties

$html
$text
$title
$params

Methods

__construct($html, $text = '', $title, $params)

No description

String
getTitle()

Returns the title of the email

getParams()

Returns the params for the email

setError($message)

Set an error message

String
getError()

Set an error message

bool
hasError()

Determines if there is an error.

String
getContent()

Returns a text representation of the invite body. Determins whether to use html or text mode.

Details

at line 25
__construct($html, $text = '', $title, $params)

Parameters

$html
$text
$title
$params

at line 38
String getTitle()

Returns the title of the email

Return Value

String Title of the email

at line 48
JParameter getParams()

Returns the params for the email

Return Value

JParameter Params for the email.

at line 58
setError($message)

Set an error message

Parameters

$message String An error message of the current invite process.

at line 69
String getError()

Set an error message

Return Value

String Error message.

at line 79
bool hasError()

Determines if there is an error.

Return Value

bool Whether the current invite has any errors.

at line 91
String getContent()

Returns a text representation of the invite body. Determins whether to use html or text mode.

Return Value

String HTML or raw text for the email content.