Docs For Class messenger

Description

Messenger

Located in /includes/functions_messenger.php (line 23)

Variable Summary

mixed $addresses

mixed $extra_headers

mixed $from

mixed $mail_priority

mixed $msg

mixed $replyto

mixed $subject

mixed $tpl_msg

mixed $use_queue

mixed $vars

Method Summary

messenger messenger ([ $use_queue = true])

void assign_vars ( $vars)

void bcc ( $address, [ $realname = ''])

void build_header ( $to, $cc, $bcc)

void cc ( $address, [ $realname = ''])

void error ( $type, $msg)

void from ( $address)

void headers ( $headers)

void im ( $address, [ $realname = ''])

void msg_email ()

void msg_jabber ()

void replyto ( $address)

void reset ()

void save_queue ()

void send ([ $method = NOTIFY_EMAIL], [ $break = false])

void set_mail_priority ([ $priority = MAIL_NORMAL_PRIORITY])

void subject ([ $subject = ''])

void template ( $template_file, [ $template_lang = ''])

void to ( $address, [ $realname = ''])

Variables

mixed $addresses = array() (line 26)

mixed $extra_headers (line 25)

mixed $from (line 25)

mixed $mail_priority = MAIL_NORMAL_PRIORITY (line 28)

mixed $msg (line 25)

mixed $replyto (line 25)

mixed $subject (line 25)

mixed $tpl_msg = array() (line 30)

mixed $use_queue = true (line 29)

mixed $vars (line 25)

Methods

Constructor messenger (line 35)

Constructor

messenger messenger ([ $use_queue = true])

$use_queue

assign_vars (line 187)

assign variables to email template

void assign_vars ( $vars)

$vars

bcc (line 88)

Sets an bcc address to send to

void bcc ( $address, [ $realname = ''])

$address
$realname

build_header (line 302)

Return email header

void build_header ( $to, $cc, $bcc)

$to
$cc
$bcc

cc (line 78)

Sets an cc address to send to

void cc ( $address, [ $realname = ''])

$address
$realname

error (line 257)

Add error message to log

void error ( $type, $msg)

$type
$msg

from (line 116)

Set the from address

void from ( $address)

$address

headers (line 132)

set up extra mail headers

void headers ( $headers)

$headers

im (line 98)

Sets a im contact to send to

void im ( $address, [ $realname = ''])

$address
$realname

msg_email (line 349)

Send out emails

void msg_email ()

msg_jabber (line 437)

Send jabber message out

void msg_jabber ()

replyto (line 108)

Set the reply to address

void replyto ( $address)

$address

reset (line 46)

Resets all the data (address, template file, etc etc) to default

void reset ()

save_queue (line 288)

Save to queue

void save_queue ()

send (line 195)

Send the mail out to the recipients set previously in var $this->addresses

void send ([ $method = NOTIFY_EMAIL], [ $break = false])

$method
$break

set_mail_priority (line 140)

Set the email priority

void set_mail_priority ([ $priority = MAIL_NORMAL_PRIORITY])

$priority

subject (line 124)

set up subject for mail

void subject ([ $subject = ''])

$subject

template (line 148)

Set email template to use

void template ( $template_file, [ $template_lang = ''])

$template_file
$template_lang

to (line 56)

Sets an email address to send to

void to ( $address, [ $realname = ''])

$address
$realname