API Emailer
Parameter | Default | Description |
Emailer ($mServer) | ||
Class constructor, returns a pointer. | ||
$mServer | <blank>. | Server address in case messages will be sent via socket. |
Clear () | ||
Clears all previously prepared data. | ||
SetCharset ($mCharset) | ||
Sets the encoding in which the message will be sent. | ||
$mCharset | The name of the encoding. | |
SetTypeHTML () | ||
Sets the format of the email to HTML. | ||
SetTypeText () | ||
Sets the text format of the email. | ||
AddMessage ($mText) | ||
Loads the message text of the email. | ||
$mText | Text. | |
AddAttachment ($mFile, $mAttachName, $mType) | ||
Attaches a file to the email being sent. | ||
$mFile | Path to the file on the server. | |
$mAttachName | The name under which the file will be attached to the email. | |
$mType | application/octet-stream | The type of file to be uploaded. |
BuildMessage () | ||
Build message (executed before sending). | ||
Send ($mTo, $mFrom, $mSubject) | ||
Performs the sending of the email. Returns the response from the mail server. | ||
$mTo | Recipients. A comma separated list of e-mail addresses. | |
$mFrom | Name and mailing address of the sender. | |
$mSubject | Subject of the e-mail to be sent. |