Overview

Packages

  • Admin
  • Archive
  • Common
  • DB
  • Express
  • Form
  • Layout
  • Mailer
  • None
  • OpenHomeoDB
  • PDF
    • MC
  • Process
  • Rep
  • RevRep
  • SaveReps
  • Search
  • Session
  • SymRem
  • TreeView
  • UserDB

Classes

  • Mailer
  • Overview
  • Package
  • Class
  • Tree

Class Mailer

The Mailer class is meant to simplify the task of sending emails to users. Note: this email system will not work if your server is not setup to send mail.

Package: Mailer
Category: Login
Copyright: 2007-2014 Henri Schumacher
License: GNU Affero General Public License v3
Author: Jpmaster77 a.k.a. The Grandmaster of C++ (GMC)
Author: Henri Schumacher <henri.hulski@gazeta.pl>
Located at include/classes/login/mailer.php
Methods summary
public boolean
# sendWelcome( string $user, string $email, string $pass )

sendWelcome - Sends a welcome message to the newly registered user, also supplying the username and password.

sendWelcome - Sends a welcome message to the newly registered user, also supplying the username and password.

Parameters

$user
string
$user username
$email
string
$email email
$pass
string
$pass password

Returns

boolean
true if the mail has been successful sent
public boolean
# sendWelcomePass( string $user, string $email, string $pass )

sendWelcomePass - Sends a welcome message to the newly registered user, sending a generated password and supplying the username.

sendWelcomePass - Sends a welcome message to the newly registered user, sending a generated password and supplying the username.

Parameters

$user
string
$user username
$email
string
$email email
$pass
string
$pass password

Returns

boolean
true if the mail has been successful sent
public boolean
# sendNewPass( string $user, string $email, string $pass )

sendNewPass - Sends the newly generated password to the user's email address that was specified at sign-up.

sendNewPass - Sends the newly generated password to the user's email address that was specified at sign-up.

Parameters

$user
string
$user username
$email
string
$email email
$pass
string
$pass password

Returns

boolean
true if the mail has been successful sent
public string
# mail_header_escape( string $header )

mail_header_escape - encode the header with 'quoted-printable', so that also non US-ASCII letters can be transmitted.

mail_header_escape - encode the header with 'quoted-printable', so that also non US-ASCII letters can be transmitted.

Parameters

$header
string
$header email header

Returns

string
the encoded header
public boolean
# send_mail( string $to, string $body, string $subject )

send_mail - Send the email with mail().

send_mail - Send the email with mail().

Parameters

$to
string
$to receiver
$body
string
$body email body
$subject
string
$subject email subject

Returns

boolean
true if the mail has been successful sent
OpenHomeopath PHP code documentation API documentation generated by ApiGen 2.8.0