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 Email

PHPMailer
Extended by Email

Direct known subclasses

SystemMail

Copyright: 2004-2016 The Admidio Team
License: GNU General Public License v2.0 only **********************************************************************************************
Class:

Email Mit dieser Klasse kann ein Email-Objekt erstellt und anschliessend verschickt werden.

Das Objekt wird erzeugt durch Aufruf des Konstruktors: Email()

Nun wird der Absender gesetzt: setSender($address, $name = '') Parameters: $address - Die Emailadresse $name - Der Name des Absenders (optional)

Nun koennen in beliebiger Reihenfolge und Anzahl Adressaten (To,Cc,Bcc) der Mail hinzugefuegt werden: (optional und mehrfach aufrufbar, es muss jedoch mindestens ein Empfaenger mittels einer der drei Funktionen gesetzt werden)

addRecipient($address, $name = '') addCopy($address, $name = '') addBlindCopy($address, $name = '') Parameters: $address - Die Emailadresse $name - Der Name des Absenders (optional)

Nun noch ein Subject setzen (optional): setSubject($subject) Parameters: $subject - Der Text des Betreffs

Der Email einen Text geben: function setText($text. ) Parameters: $text - Der Text der Mail

Bei Bedarf kann man sich eine Kopie der Mail zuschicken lassen (optional): setCopyToSenderFlag()

Sollen in der Kopie zusaetzlich noch alle Empfaenger aufgelistet werden, muss folgende Funktion auch noch aufgerufen werden (optional): function setListRecipientsFlag()

Methode gibt die maximale Groesse der Anhaenge zurueck size_unit : 'b' = byte; 'kb' = kilobyte; 'mb' = megabyte getMaxAttachementSize($size_unit = 'kb')

Soll die Nachricht als HTML Code interpretiert und versendet werden, muss folgende Funktion auch noch aufgerufen werden (optional): function sendDataAsHtml()

Am Ende muss die Mail natuerlich noch gesendet werden: function sendEmail();


Located at email.php

Methods summary

public
# __construct( )

Email constructor.

Email constructor.

Overrides

PHPMailer::__construct
public boolean
# addBlindCopy( string $address, string $name = '' )

method adds BCC recipients to mail Bcc Empfänger werden ersteinmal gesammelt, damit später Päckchen verschickt werden können

method adds BCC recipients to mail Bcc Empfänger werden ersteinmal gesammelt, damit später Päckchen verschickt werden können

Parameters

$address
$name

Returns

boolean
public true|string
# addCopy( string $address, string $name = '' )

method adds CC recipients to mail

method adds CC recipients to mail

Parameters

$address
$name

Returns

true|string
public true|string
# addRecipient( string $address, string $name = '' )

method adds main recipients to mail

method adds main recipients to mail

Parameters

$address
$name

Returns

true|string
public static float
# getMaxAttachementSize( string $sizeUnit = 'mib' )

Returns the maximum size of an attachment

Returns the maximum size of an attachment

Parameters

$sizeUnit
'b' = byte, 'kib' = kilobyte, 'mib' = megabyte, 'gib' = gigabyte, 'tib' = terabyte

Returns

float
The maximum attachment size in the given size-unit
public true|string
# setSender( string $address, string $name = '' )

method adds sender to mail

method adds sender to mail

Parameters

$address
$name

Returns

true|string
public boolean
# setSubject( string $subject )

Set the subject of the email

Set the subject of the email

Parameters

$subject
A text that should be the subject of the email

Returns

boolean
Returns @b false if the parameter has no text
public
# setText( string $text )

Funktion um den Nachrichtentext an die Mail uebergeben

Funktion um den Nachrichtentext an die Mail uebergeben

Parameters

$text
public
# setCopyToSenderFlag( )

Funktion um das Flag zu setzen, dass eine Kopie verschickt werden soll...

Funktion um das Flag zu setzen, dass eine Kopie verschickt werden soll...

public
# setListRecipientsFlag( )

Funktion um das Flag zu setzen, dass in der Kopie alle Empfaenger der Mail aufgelistet werden

Funktion um das Flag zu setzen, dass in der Kopie alle Empfaenger der Mail aufgelistet werden

public
# setSenderInText( string $senderName, string $receivers )

Write a short text with sender information in text of email

Write a short text with sender information in text of email

Parameters

$senderName
Firstname and lastname of email sender
$receivers
List with firstname and lastname of all recipients of this mail
public
# sendDataAsHtml( )

method change email header so that client will interpret mail as html mail

method change email header so that client will interpret mail as html mail

public boolean|string
# adminNotfication( string $subject, string $message, string $editorName = '', string $editorEmail = '' )

Mailbenachrichtigung für Admin

Mailbenachrichtigung für Admin

Parameters

$subject
$message
$editorName
$editorEmail

Returns

boolean|string
public true|string
# sendEmail( )

Funktion um die Email endgueltig zu versenden...

Funktion um die Email endgueltig zu versenden...

Returns

true|string

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 $emText
#
private $emHtmlText
#
private $emSender
#
private $emAddresses
#
private $emCopyToSender
#
private $emListRecipients
#
private $emSendAsHTML
#
private array $emBccArray
# 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