Documentation TYPO3 par Ameos

t3lib_formmail Class Reference

Inheritance diagram for t3lib_formmail:
[legend]
Collaboration diagram for t3lib_formmail:
[legend]
List of all members.

Public Member Functions

 start ($V, $base64=false)
 addAttachment ($file, $filename)
 sanitizeHeaderString ($string)

Public Attributes

 $reserved_names = 'recipient,recipient_copy,auto_respond_msg,redirect,subject,attachment,from_email,from_name,replyto_email,replyto_name,organisation,priority,html_enabled,quoted_printable,submit_x,submit_y'
 $dirtyHeaders = array()

Detailed Description

Definition at line 69 of file class.t3lib_formmail.php.


Member Function Documentation

t3lib_formmail::start ( V,
base64 = false 
)

Start function This class is able to generate a mail in formmail-style from the data in $V Fields:

[recipient]: email-adress of the one to receive the mail. If array, then all values are expected to be recipients [attachment]: ....

[subject]: The subject of the mail [from_email]: Sender email. If not set, [email] is used [from_name]: Sender name. If not set, [name] is used [replyto_email]: Reply-to email. If not set [from_email] is used [replyto_name]: Reply-to name. If not set [from_name] is used [organisation]: Organisation (header) [priority]: Priority, 1-5, default 3 [html_enabled]: If mail is sent as html [use_base64]: If set, base64 encoding will be used instead of quoted-printable

Parameters:
array Contains values for the field names listed above (with slashes removed if from POST input)
boolean Whether to base64 encode the mail content
Returns:
void

Definition at line 96 of file class.t3lib_formmail.php.

References addAttachment(), t3lib_htmlmail::addPlain(), t3lib_div::arrayToLogString(), t3lib_div::devLog(), t3lib_htmlmail::encodeMsg(), t3lib_div::getIndpEnv(), t3lib_div::inList(), t3lib_div::intInRange(), sanitizeHeaderString(), t3lib_htmlmail::setContent(), t3lib_htmlmail::setHeaders(), t3lib_htmlmail::setRecipient(), t3lib_div::sysLog(), t3lib_div::unlink_tempfile(), t3lib_div::upload_to_tempfile(), t3lib_htmlmail::useBase64(), and t3lib_div::validEmail().

t3lib_formmail::addAttachment ( file,
filename 
)

Adds an attachment to the mail

Parameters:
string The absolute path to the file to add as attachment
string The files original filename (not necessarily the same as the current since this could be uploaded files...)
Returns:
boolean True if the file existed and was added. private

Definition at line 203 of file class.t3lib_formmail.php.

References t3lib_htmlmail::getURL(), and t3lib_htmlmail::split_fileref().

Referenced by start().

t3lib_formmail::sanitizeHeaderString ( string  ) 

Checks string for suspicious characters

Parameters:
string String to check
Returns:
string Valid or empty string

Definition at line 228 of file class.t3lib_formmail.php.

Referenced by start().


The documentation for this class was generated from the following file:


Généré par Le spécialiste TYPO3 avec  doxygen 1.4.6