[ class tree: Geeklog ] [ index: Geeklog ] [ all elements ]

Class: Mail

Source Location: /system/classes/Mail.php

Class Overview

Class Mail



Class Details

[line 10]
Class Mail

[ Top ]

Class Methods

static method send [line 51]

static bool send( string $to, string $subject, string $body, [string $from = ''], [bool $html = false], [int $priority = 0], [mixed $optional = null], [ $attachments = array()])

Send an email.

All emails sent by Geeklog are sent through this function. NOTE: Please note that using CC: will expose the email addresses of all recipients. Use with care.


return:  true if successful, otherwise false
access:  public


string   $to   recipients name and email address
string   $subject   subject of the email
string   $body   the text of the email
string   $from   (optional) sender of the the email
bool   $html   (optional) true if to be sent as HTML email
int   $priority   (optional) add X-Priority header, if > 0
mixed   $optional   (optional) other headers or CC:
array   $attachments   (optional) attachment files

[ Top ]

Class Constants

NEW_LINE =  "\r\n"

[line 12]

[ Top ]

Documentation generated on Sun, 02 Oct 2016 07:52:00 +0000 by phpDocumentor 1.4.3