Overview

Packages

  • Auth
    • Ads
    • Ldap
    • Xoops
  • Autotasks
  • Config
    • Category
    • Item
    • Option
  • Core
    • Filesystem
    • Filters
    • Logger
    • Mail
    • Message
    • Password
    • Security
    • StopSpammer
    • Template
    • Textsanitizer
    • VersionChecker
  • Data
    • Avatar
    • Comment
  • Database
    • Connection
    • Criteria
    • Legacy
    • MySQL
    • PDO
    • Updater
  • Feeds
    • RSS
  • File
  • Form
    • Base
    • Elements
  • ICMS
    • IPF
      • View
  • Image
    • Category
  • Ipf
    • Category
    • Controller
    • Export
    • form
    • Keyhighlighter
    • Member
    • Object
    • Permission
    • richfile
    • Tree
    • urllink
    • View
  • kernel
    • Set
  • Member
    • Group
    • GroupMembership
    • GroupPermission
    • User
  • Messaging
  • Module
  • None
  • Notification
  • Page
  • Plugins
    • Editor
  • Preload
    • Libraries
  • Privmessage
  • Session
  • SmartObject
  • View
    • Block
    • Breadcrumb
    • PageNav
    • PrinterFriendly
    • Template
    • Templates
    • Theme
    • Tree

Classes

  • icms_messaging_EmailHandler
  • Overview
  • Package
  • Class

Class icms_messaging_EmailHandler

Mailer Class.

PHPMailer\PHPMailer\PHPMailer
Extended by icms_messaging_EmailHandler
Package: Core\Mail
Category: ICMS
Copyright: copyright (c) 2000-2003 The XOOPS Project (http://www.xoops.org)
License: GNU General Public License (GPL)
Author: Jochen B��nagel jb@buennagel.com
Located at messaging/EmailHandler.php
Methods summary
public
# __construct( )

Constuctor

Constuctor

public string
# AddrFormat( string $addr )

Formats an address correctly. This overrides the default addr_format method which does not seem to encode $FromName correctly

Formats an address correctly. This overrides the default addr_format method which does not seem to encode $FromName correctly

Parameters

$addr
the email address to be formatted

Returns

string
the formatted string (address)
public
# encodeFromName( $text )
public
# encodeSubject( $text )
public
# encodeBody( & $text )
Properties summary
public string $From

"from" address

"from" address

# ""
public string $FromName

"from" name

"from" name

# ""
public string $Mailer

Method to be used when sending the mail.

Method to be used when sending the mail.

This can be:

  • mail (standard PHP function "mail()") (default)
  • smtp (send through any SMTP server, SMTPAuth is supported. You must set icms_messaging_EmailHandler::$Host, for SMTPAuth also icms_messaging_EmailHandler::$SMTPAuth, icms_messaging_EmailHandler::$Username, and icms_messaging_EmailHandler::$Password.)
  • sendmail (manually set the path to your sendmail program to something different than "mail()" uses in icms_messaging_EmailHandler::$Sendmail)

  • # "mail"
    public string $Sendmail

    set if $Mailer is "sendmail"

    set if $Mailer is "sendmail"

    Only used if icms_messaging_EmailHandler::$Mailer is set to "sendmail". Contains the full path to your sendmail program or replacement.

    # "/usr/sbin/sendmail"
    public string $Host

    SMTP Host.

    SMTP Host.

    Only used if icms_messaging_EmailHandler::$Mailer is set to "smtp"

    # ""
    public string $SMTPSecure

    Sets connection prefix. Options are "", "ssl" or "tls"

    Sets connection prefix. Options are "", "ssl" or "tls"

    # ""
    public boolean $SMTPAuth

    Does your SMTP host require SMTPAuth authentication?

    Does your SMTP host require SMTPAuth authentication?

    # FALSE
    public string $Username

    Username for authentication with your SMTP host.

    Username for authentication with your SMTP host.

    Only used if icms_messaging_EmailHandler::$Mailer is "smtp" and icms_messaging_EmailHandler::$SMTPAuth is TRUE

    # ""
    public string $Password

    Password for SMTPAuth.

    Password for SMTPAuth.

    Only used if icms_messaging_EmailHandler::$Mailer is "smtp" and icms_messaging_EmailHandler::$SMTPAuth is TRUE

    # ""
    public boolean $Port

    Sets default SMTP Port to use?

    Sets default SMTP Port to use?

    # 25
    API documentation generated by ApiGen