Admidio API
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Packages

  • com
    • tecnick
      • tcpdf
  • None
  • PHPMailer
    • easypeasyics
  • PHPWavUtils
  • Securimage
    • classes

Classes

  • AutoLogin
  • Component
  • ComponentUpdate
  • ConditionParser
  • Database
  • DateTimeExtended
  • Email
  • Folder
  • FormValidation
  • FunctionClass
  • Htaccess
  • HtmlDiv
  • HtmlElement
  • HtmlForm
  • HtmlFormBasic
  • HtmlFormInstallation
  • HtmlList
  • HtmlNavbar
  • HtmlPage
  • HtmlTable
  • HtmlTableBasic
  • Image
  • Inventory
  • InventoryFields
  • Language
  • LanguageData
  • ListConfiguration
  • Menu
  • Message
  • ModuleAnnouncements
  • ModuleDates
  • ModuleLists
  • ModuleMenu
  • ModuleMessages
  • Modules
  • ModuleWeblinks
  • MyFiles
  • Navigation
  • ntlm_sasl_client_class
  • Organization
  • Participants
  • PasswordHash
  • PasswordHashing
  • ProfileFields
  • RoleDependency
  • RolesRights
  • RSSfeed
  • Session
  • SystemMail
  • TableAccess
  • TableAnnouncement
  • TableCategory
  • TableDate
  • TableFile
  • TableFolder
  • TableGuestbook
  • TableGuestbookComment
  • TableInventory
  • TableInventoryField
  • TableLists
  • TableMembers
  • TableMessage
  • TablePhotos
  • TableRoles
  • TableRooms
  • TableText
  • TableUserField
  • TableUsers
  • TableWeblink
  • UploadHandlerDownload
  • UploadHandlerPhoto
  • User
  • UserRegistration

Exceptions

  • AdmException
  • WavFileException
  • WavFormatException

Functions

  • admFuncAutoload
  • admFuncGeneratePagination
  • admFuncGetBytesFromSize
  • admFuncGetDirectoryEntries
  • admFuncMaxUploadSize
  • admFuncProcessableImageSize
  • admFuncShowCreateChangeInfoById
  • admFuncShowCreateChangeInfoByName
  • admFuncVariableIsValid
  • admReadTemplateFile
  • admStrIsValidFileName
  • admStrStripTagsSpecial
  • admStrToLower
  • admStrToUpper
  • bzip2Version
  • checkDatabaseVersion
  • checkPhpVersion
  • EmailAttachment
  • FileSizeNiceDisplay
  • FormattedTimeRemaining
  • FunctionIsDisabled
  • getFormerRolesFromDatabase
  • getFutureRolesFromDatabase
  • getmicrotime
  • getRoleMemberships
  • getRolesFromDatabase
  • gzipVersion
  • hasRole
  • hl_attrval
  • hl_bal
  • hl_cmtcd
  • hl_ent
  • hl_prot
  • hl_regex
  • hl_spec
  • hl_tag
  • hl_tag2
  • hl_tidy
  • hl_version
  • htmLawed
  • HTMLFilter
  • isGroupLeader
  • isMember
  • kses
  • kses_hook
  • MySQLdumpVersion
  • OutputInformation
  • SafeExec
  • showNotice
  • strAddSlashesDeep
  • strNextLetter
  • strStripSlashesDeep
  • strStripTags
  • strValidCharacters
  • tln_body2div
  • tln_casenormalize
  • tln_deent
  • tln_defang
  • tln_findnxreg
  • tln_findnxstr
  • tln_fixatts
  • tln_fixstyle
  • tln_fixurl
  • tln_getnxtag
  • tln_sanitize
  • tln_skipspace
  • tln_tagprint
  • tln_unspace
  • version_compare_replacement
  • version_compare_replacement_sub

Class SystemMail

PHPMailer
Extended by Email
Extended by SystemMail
Copyright: 2004-2016 The Admidio Team
License: GNU General Public License v2.0 only **********************************************************************************************
Class:

SystemMail Beside the methods of the parent class there are the following additional methods:

getMailText($systemMailId, &$user) - diese Methode liest den Mailtext aus der DB und ersetzt vorkommende Platzhalter durch den gewuenschten Inhalt

setVariable($number, $value) - hier kann der Inhalt fuer zusaetzliche Variablen gesetzt werden

sendSystemMail($systemMailId, &$user) - diese Methode sendet eine Systemmail nachdem der Mailtext ausgelesen und Platzhalter ersetzt wurden


Located at systemmail.php

Methods summary

public
# __construct( Database & $database )

Constructor that will create an object of a SystemMail to handle all system notifications.

Constructor that will create an object of a SystemMail to handle all system notifications.

Parameters

$database
Object of the class Database. This should be the default global object @b $gDb.

Overrides

Email::__construct
public string
# getMailText( string $systemMailId, User & $user )

diese Methode liest den Mailtext aus der DB und ersetzt vorkommende Platzhalter durch den gewuenschten Inhalt

diese Methode liest den Mailtext aus der DB und ersetzt vorkommende Platzhalter durch den gewuenschten Inhalt

Parameters

$systemMailId
eindeutige Bezeichnung der entsprechenden Systemmail, entspricht adm_texts.txt_name
$user
Benutzerobjekt, zu dem die Daten dann ausgelesen und in die entsprechenden Platzhalter gesetzt werden

Returns

string
public
# setVariable( integer $number, string $value )

die Methode setzt den Inhalt fuer spezielle Variablen

die Methode setzt den Inhalt fuer spezielle Variablen

Parameters

$number
$value
public true
# sendSystemMail( string $systemMailId, User & $user )

diese Methode sendet eine Systemmail nachdem der Mailtext ausgelesen und Platzhalter ersetzt wurden

diese Methode sendet eine Systemmail nachdem der Mailtext ausgelesen und Platzhalter ersetzt wurden

Parameters

$systemMailId
eindeutige Bezeichnung der entsprechenden Systemmail, entspricht adm_texts.txt_name
$user
Benutzerobjekt, zu dem die Daten dann ausgelesen und in die entsprechenden Platzhalter gesetzt werden

Returns

true

Throws

AdmException
SYS_EMAIL_NOT_SEND

Methods inherited from Email

addBlindCopy(), addCopy(), addRecipient(), adminNotfication(), getMaxAttachementSize(), sendDataAsHtml(), sendEmail(), setCopyToSenderFlag(), setListRecipientsFlag(), setSender(), setSenderInText(), setSubject(), setText()

Methods inherited from PHPMailer

DKIM_Add(), DKIM_BodyC(), DKIM_HeaderC(), DKIM_QP(), DKIM_Sign(), __destruct(), _mime_types(), addAddress(), addAnAddress(), addAttachment(), addBCC(), addCC(), addCustomHeader(), addEmbeddedImage(), addOrEnqueueAnAddress(), addReplyTo(), addStringAttachment(), addStringEmbeddedImage(), addrAppend(), addrFormat(), alternativeExists(), attachAll(), attachmentExists(), base64EncodeWrapMB(), clearAddresses(), clearAllRecipients(), clearAttachments(), clearBCCs(), clearCCs(), clearCustomHeaders(), clearQueuedAddresses(), clearReplyTos(), createBody(), createHeader(), doCallback(), edebug(), encodeFile(), encodeHeader(), encodeQ(), encodeQP(), encodeQPphp(), encodeString(), endBoundary(), filenameToType(), fixEOL(), getAllRecipientAddresses(), getAttachments(), getBccAddresses(), getBoundary(), getCcAddresses(), getCustomHeaders(), getLastMessageID(), getMailMIME(), getReplyToAddresses(), getSMTPInstance(), getSentMIMEMessage(), getToAddresses(), getTranslations(), has8bitChars(), hasLineLongerThanMax(), hasMultiBytes(), headerLine(), html2text(), idnSupported(), inlineImageExists(), isError(), isHTML(), isMail(), isQmail(), isSMTP(), isSendmail(), lang(), mailSend(), mb_pathinfo(), msgHTML(), normalizeBreaks(), parseAddresses(), postSend(), preSend(), punyencodeAddress(), rfcDate(), secureHeader(), send(), sendmailSend(), serverHostname(), set(), setError(), setFrom(), setLanguage(), setMessageType(), setWordWrap(), sign(), smtpClose(), smtpConnect(), smtpSend(), textLine(), utf8CharBoundary(), validateAddress(), wrapText()

Constants summary

Constants inherited from PHPMailer

CRLF, MAX_LINE_LENGTH, STOP_CONTINUE, STOP_CRITICAL, STOP_MESSAGE

Properties summary

private $smTextObject
#
private $smOrganization
#
private $db
#
private $smMailText
#
private $smMailHeader
#
private array $smVariables
# array()

Properties inherited from PHPMailer

$AllowEmpty, $AltBody, $AuthType, $Body, $CharSet, $ConfirmReadingTo, $ContentType, $CustomHeader, $DKIM_domain, $DKIM_identity, $DKIM_passphrase, $DKIM_private, $DKIM_selector, $Debugoutput, $Encoding, $ErrorInfo, $From, $FromName, $Helo, $Host, $Hostname, $Ical, $LE, $MIMEBody, $MIMEHeader, $Mailer, $MessageDate, $MessageID, $Password, $PluginDir, $Port, $Priority, $Realm, $RecipientsQueue, $ReplyTo, $ReplyToQueue, $ReturnPath, $SMTPAuth, $SMTPAutoTLS, $SMTPDebug, $SMTPKeepAlive, $SMTPOptions, $SMTPSecure, $Sender, $Sendmail, $SingleTo, $SingleToArray, $Subject, $Timeout, $UseSendmailOptions, $Username, $Version, $WordWrap, $Workstation, $XMailer, $action_function, $all_recipients, $attachment, $bcc, $boundary, $cc, $do_verp, $error_count, $exceptions, $language, $lastMessageID, $mailHeader, $message_type, $sign_cert_file, $sign_extracerts_file, $sign_key_file, $sign_key_pass, $smtp, $to, $uniqueid

Admidio API API documentation generated by ApiGen