[ Index ]

PHP Cross Reference of phpBB-3.3.2-deutsch

title

Body

[close]

/phpbb/message/ -> message.php (summary)

This file is part of the phpBB Forum Software package.

Copyright: (c) phpBB Limited
License: GNU General Public License, version 2 (GPL-2.0)
File Size: 282 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

message:: (12 methods):
  __construct()
  set_subject()
  set_body()
  set_template()
  set_template_vars()
  add_recipient_from_user_row()
  add_recipient()
  set_sender_from_user()
  set_sender()
  set_sender_notify_type()
  cc_sender()
  send()


Class: message  - X-Ref

Class message
Holds all information for an email and sends it in the end

__construct($server_name)   X-Ref
Construct

param: string $server_name    Used for AntiAbuse header

set_subject($subject)   X-Ref
Set the subject of the email

param: string $subject
return: null

set_body($body)   X-Ref
Set the body of the email text

param: string $body
return: null

set_template($template)   X-Ref
Set the name of the email template to use

param: string $template
return: null

set_template_vars($template_vars)   X-Ref
Set the array with the "template" data for the email

param: array $template_vars
return: null

add_recipient_from_user_row(array $user)   X-Ref
Add a recipient from \phpbb\user

param: array $user
return: null

add_recipient($recipient_name, $recipient_address, $recipient_lang, $recipient_notify_type = NOTIFY_EMAIL, $recipient_username = '', $recipient_jabber = '')   X-Ref
Add a recipient

param: string $recipient_name        Displayed sender name
param: string $recipient_address    Email address
param: string $recipient_lang
param: int $recipient_notify_type    Used notification methods (Jabber, Email, ...)
param: string $recipient_username    User Name (used for AntiAbuse header)
param: string $recipient_jabber
return: null

set_sender_from_user($user)   X-Ref
Set the senders data from \phpbb\user object

param: \phpbb\user $user
return: null

set_sender($sender_ip, $sender_name, $sender_address, $sender_lang = '', $sender_id = 0, $sender_username = '', $sender_jabber = '')   X-Ref
Set the senders data

param: string $sender_ip
param: string $sender_name        Displayed sender name
param: string $sender_address        Email address
param: string $sender_lang
param: int $sender_id                User ID
param: string $sender_username    User Name (used for AntiAbuse header)
param: string $sender_jabber
return: null

set_sender_notify_type($sender_notify_type)   X-Ref
Which notification type should be used? Jabber, Email, ...?

param: int $sender_notify_type
return: null

cc_sender()   X-Ref
Ok, now the same email if CC specified, but without exposing the user's email address

return: null

send(\messenger $messenger, $contact)   X-Ref
Send the email

param: \messenger $messenger
param: string $contact
return: null



Generated: Wed Nov 11 20:28:18 2020 Cross-referenced by PHPXref 0.7.1