Overview

Classes

  • _zp_captcha
  • _zp_HTML_cache
  • admin_approval
  • Album
  • AlbumBase
  • AlbumZip
  • AMFReader
  • AMFStream
  • AnyFile
  • AnyFile_Options
  • auto_backup
  • AVCSequenceParameterSetReader
  • bxslider
  • cacheManager
  • cachemanager_internal_deprecations
  • cacheManagerFeed
  • CI_jsmin
  • CI_load
  • cloneZenphoto
  • codeIgniter_kludge
  • colorbox
  • Combi
  • Comment
  • comment_form
  • contactformOptions
  • cookieConsent
  • crop_image
  • cycle
  • defaultCodeblocks
  • deprecated_functions
  • DownloadList
  • dynamic_locale
  • dynamicAlbum
  • elFinder
  • elFinder_options
  • elFinderConnector
  • elFinderEditor
  • elFinderEditorOnlineConvert
  • elFinderEditorZipArchive
  • elFinderEditorZohoOffice
  • elFinderLibGdBmp
  • elFinderPlugin
  • elFinderPluginAutoResize
  • elFinderPluginAutoRotate
  • elFinderPluginNormalizer
  • elFinderPluginSanitizer
  • elFinderPluginWatermark
  • elFinderSession
  • elFinderVolumeBox
  • elFinderVolumeDriver
  • elFinderVolumeDropbox
  • elFinderVolumeDropbox2
  • elFinderVolumeFlysystemGoogleDriveCache
  • elFinderVolumeFlysystemGoogleDriveNetmount
  • elFinderVolumeFTP
  • elFinderVolumeGoogleDrive
  • elFinderVolumeGroup
  • elFinderVolumeLocalFileSystem
  • elFinderVolumeMySQL
  • elFinderVolumeOneDrive
  • elFinderVolumeTrash
  • elFinderVolumeTrashMySQL
  • email_new_user
  • exampleMacros
  • external_auth
  • favorites
  • favoritesOptions
  • feed
  • fieldExtender
  • flag_thumbnail
  • Gallery
  • galleryArticles
  • getID3
  • getid3_aac
  • getid3_apetag
  • getid3_flv
  • getid3_handler
  • getid3_id3v1
  • getid3_id3v2
  • getid3_lib
  • getid3_lyrics3
  • getid3_mp3
  • getid3_mpeg
  • getid3_quicktime
  • getid3_swf
  • GoogleMap
  • Googlemaps
  • hitcounter
  • htmlmetatags
  • Image
  • internal_deprecations
  • ipBlocker
  • jPlayer
  • jplayer_options
  • jquery_rating
  • JSMin
  • lazyload
  • lib_GD_Options
  • lib_Imagick_Options
  • lib_NoGraphics
  • matomoStats
  • MediaObject
  • menu_manager
  • MergedRSS
  • MergedRSSOptions
  • mobile
  • Mobile_Detect
  • mobileTheme
  • multipleLayoutOptions
  • null_seo
  • OAuthConsumer
  • OAuthDataStore
  • OAuthRequest
  • OAuthServer
  • OAuthSignatureMethod
  • OAuthSignatureMethod_HMAC_SHA1
  • OAuthSignatureMethod_PLAINTEXT
  • OAuthSignatureMethod_RSA_SHA1
  • OAuthToken
  • OAuthUtil
  • openStreetMap
  • openStreetMapOptions
  • pagedThumbsNav
  • pagedthumbsOptions
  • PersistentObject
  • PHPMailer\PHPMailer\PHPMailer
  • PHPMailer\PHPMailer\POP3
  • PHPMailer\PHPMailer\SMTP
  • print_album_menu
  • pseudoPlayer
  • publishContent
  • quota_manager
  • reCaptcha
  • RecursiveCallbackFilterIterator
  • redirector
  • redirectorOptions
  • register_user
  • rewriteRules
  • rewriteTokens
  • RSS
  • rss_options
  • scriptlessSocialsharing
  • scriptlessSocialsharingOptions
  • search_statistics
  • SearchEngine
  • security_logger
  • securityHeaders
  • securityheadersOptions
  • seo_locale
  • Services_JSON
  • Services_JSON_Error
  • setup
  • setupMutex
  • setupRSS
  • show_not_loggedin
  • sitemap
  • sitemapOptions
  • static_html_cache
  • staticHTMLCacheOptions
  • tagsuggest
  • TextObject
  • TextObject_Options
  • ThemeObject
  • themeSwitcher
  • tinymce4Options
  • tinyURL
  • Transientimage
  • UploadHandler
  • user_expiry
  • user_groups
  • user_logout_options
  • userAddressFields
  • userDataExport
  • utf8
  • Video
  • VideoObject_Options
  • WEBdocs
  • WEBdocs_Options
  • xmpMetadata
  • Zenpage
  • Zenpage_internal_deprecations
  • ZenpageCategory
  • zenpagecms
  • ZenpageItems
  • ZenpageNews
  • ZenpagePage
  • ZenpageRoot
  • Zenphoto_Administrator
  • Zenphoto_Authority
  • zenphoto_org_news
  • zenphoto_seo
  • zenphotoDonate
  • ZipStream
  • zp_PHPMailer
  • zpFunctions
  • zpMutex
  • zpSimpleSpam
  • zpTrivialSpam

Interfaces

  • elFinderSessionInterface

Exceptions

  • elFinderAbortException
  • elFinderTriggerException
  • getid3_exception
  • JSMin_UnterminatedCommentException
  • JSMin_UnterminatedRegExpException
  • JSMin_UnterminatedStringException
  • OAuthExcept
  • PHPMailer\PHPMailer\Exception

Functions

  • access
  • accessAlbums
  • accessAllAlbums
  • accessImage
  • add_context
  • addalbumsToDatabase
  • addCategoriesToDatabase
  • addDateToTitlelink
  • addGeoCoord
  • addItem
  • addMissingDefaultRewriteTokens
  • addPagesToDatabase
  • addReconfigureNote
  • addSubalbumMenus
  • addWatermark
  • admin_album_list
  • admin_securityChecks
  • admin_showupdate
  • adminPageNav
  • adminToolbox
  • albumNumber
  • applyMacros
  • authorSelector
  • bind_textdomain_codeset
  • bindtextdomain
  • build_query
  • build_url
  • bulkActionRedirect
  • bulkTags
  • byteConvert
  • cacheImage
  • checkAccess
  • checkAlbumForImages
  • checkAlbumimagesort
  • checkAlbumParentid
  • checkAlbumPassword
  • checkChosenItemStatus
  • checkChosenMenuset
  • checked
  • checkFolder
  • checkForEmptyTitle
  • checkForGuest
  • checkForPage
  • checkForUpdate
  • checkHitcounterDisplay
  • checkIfChecked
  • checkIfLockedNews
  • checkIfLockedPage
  • checkIfNew
  • checkInstall
  • checkLayoutUseForImages
  • checkObjectsThumb
  • checkPageValidity
  • checkParentLayouts
  • checkPublishDates
  • checkRequiredField
  • checkSchedulePublishingNotes
  • checkSelectedAlbum
  • checkSignature
  • checkTitlelinkDuplicate
  • cleanAlbum
  • cleanHTML
  • clonedFrom
  • codeblocktabsJS
  • comment_form_addComment
  • comment_form_handle_comment
  • comment_form_PaginationJS
  • comment_form_postcomment
  • comment_form_print10Most
  • comment_form_visualEditor
  • commentFormUseCaptcha
  • commentReply
  • commentsAllowed
  • compressRow
  • consolidatedEditMessages
  • copyLayoutSelection
  • copyThemeDirectory
  • createMenuIfNotExists
  • createRelatedItemsResultArray
  • createTitlelink
  • cron_starter
  • curlRequest
  • currentRelativeURL
  • customOptions
  • dateDiff
  • datepickerJS
  • dateTimeConvert
  • db_affected_rows
  • db_close
  • db_collation
  • db_connect
  • db_count
  • db_create
  • db_create_table
  • db_error
  • db_fetch_assoc
  • db_fetch_row
  • db_free_result
  • db_getClientInfo
  • db_getServerInfo
  • db_getSQLmode
  • db_getVersion
  • db_insert_id
  • db_isMariaDB
  • db_LIKE_escape
  • db_list_fields
  • db_name
  • db_num_rows
  • db_permissions
  • db_quote
  • db_setSQLmode
  • db_show
  • db_software
  • db_table_update
  • db_truncate_table
  • debug404
  • debugLog
  • debugLogBacktrace
  • debuglogReconfigureNote
  • debugLogVar
  • decompressField
  • decompressRow
  • defaultCodeblocks_codebox
  • deleteArticle
  • deleteCategory
  • deleteItem
  • deleteLayoutSelection
  • deletePage
  • deleteThemeDirectory
  • dircopy
  • disableExtension
  • elFinder_admin_tabs
  • elFinder_tinymce
  • elFinderAutoloader
  • enableExtension
  • executeRSS
  • exitZP
  • exposeZenPhotoInformations
  • extendExecution
  • extensionEnabled
  • fetchComments
  • filesystemToInternal
  • fillbuffer
  • filterImageQuery
  • fix_path_redirect
  • formatList
  • fullText
  • galleryAlbumsPerPage
  • gallerystats_filesize_r
  • genAlbumList
  • generateAttributesFromArray
  • generateImageCacheFile
  • generateLanguageList
  • generateListFromArray
  • generateListFromFiles
  • generateRadiobuttonsFromArray
  • generateUnorderedListFromArray
  • get_AnyFile_suffixes
  • get_context
  • get_filterScript
  • get_instance
  • get_language_string
  • getAdminstratorsOptionsArray
  • getAdminThumb
  • getAdminThumbHTML
  • getAlbumArray
  • getAlbumBreadcrumb
  • getAlbumBreadcrumbAdmin
  • getAlbumCustomData
  • getAlbumData
  • getAlbumDate
  • getAlbumDesc
  • getAlbumFolder
  • getAlbumGeodata
  • getAlbumInherited
  • getAlbumLocation
  • getAlbumPage
  • getAlbumStatistic
  • getAlbumThumb
  • getAlbumTitle
  • getAlbumURL
  • getAllAccessibleAlbums
  • getAllAlbums
  • getAllDates
  • getAllowedTags
  • getAllSubAlbumIDs
  • getAllTagsCount
  • getAllTagsFromAlbum
  • getAllTagsFromAlbum_multi_unique
  • getAllTagsFromZenpage
  • getAllTagsUnique
  • getAllTranslations
  • getAnnotatedAlbumTitle
  • getAnnotatedImageTitle
  • getAnonymIP
  • getAuthor
  • getBare
  • getBareAlbumDesc
  • getBareAlbumTitle
  • getBareGalleryDesc
  • getBareGalleryTitle
  • getBareImageDesc
  • getBareImageTitle
  • getBareNewsTitle
  • getBarePageTitle
  • getCheckboxState
  • getCodeblock
  • getCommentAddress
  • getCommentAuthorEmail
  • getCommentAuthorLink
  • getCommentAuthorName
  • getCommentAuthorSite
  • getCommentBody
  • getCommentCount
  • getCommentDateTime
  • getCommentErrors
  • getCommentStored
  • getContactFormMacros
  • getContentShorten
  • getCookieInfoData
  • getCookieInfoHTML
  • getCookieInfoMacro
  • getCurrentMenuItem
  • getCurrentNewsArchive
  • getCurrentPage
  • getCurrentTheme
  • getCustomAlbumThumb
  • getCustomAlbumThumbMaxSpace
  • getCustomGalleryIndexPage
  • getCustomGalleryIndexURL
  • getCustomImageURL
  • getCustomPageURL
  • getCustomSizedImageMaxSpace
  • getCustomSizedImageThumbMaxSpace
  • getDataUsageNotice
  • getDefaultHeight
  • getDefaultRewriteTokens
  • getDefaultSizedImage
  • getDefaultWidth
  • getdownloadList
  • getDownloadURL
  • getE
  • getEnabledPlugins
  • getExpiryDatePost
  • getFavoritesURL
  • getField
  • getFullHeight
  • getFullImageFilesize
  • getFullImageURL
  • getFullWidth
  • getGalleryDesc
  • getGalleryIndexURL
  • getGalleryTitle
  • getGeoCoord
  • getHeadTitle
  • getHitcounter
  • getImageArgs
  • getImageCacheFilename
  • getImageCachePostfix
  • getImageCity
  • getImageCountry
  • getImageCustomData
  • getImageData
  • getImageDate
  • getImageDesc
  • getImageGeodata
  • getImageLocation
  • getImageMetaData
  • getImageParameters
  • getImageProcessorURI
  • getImageProcessorURIFromCacheName
  • getImageRotation
  • getImageState
  • getImageStatistic
  • getImageThumb
  • getImageTitle
  • getImageType
  • getImageURI
  • getImageURL
  • getItem
  • getItemByID
  • getItemTitleAndURL
  • getjPlayerSkinCSS
  • getjPlayerSkins
  • getLangAttributeLocale
  • getLanguageArray
  • getLanguageDisplayName
  • getLanguageFlag
  • getLanguageSubdomains
  • getLanguageText
  • getLatestComments
  • getLatestNews
  • getLatestZenpageComments
  • getLayout
  • getLayoutSelector
  • getLinkHTML
  • getLogTabs
  • getMacros
  • getMainSiteName
  • getMainSiteURL
  • getManagedAlbumList
  • getMaxSpaceContainer
  • getMenuFromLink
  • getMenuItemChilds
  • getMenuItems
  • getMenumanagerPredicessor
  • getMenumanagerSuccessor
  • getMenuSetSelector
  • getMenuVisibility
  • getMimeString
  • getNestedAlbumList
  • getNewsAdminOption
  • getNewsAdminOptionPath
  • getNewsArchivePath
  • getNewsArchiveURL
  • getNewsAuthor
  • getNewsCategories
  • getNewsCategoryCustomData
  • getNewsCategoryDesc
  • getNewsCategoryURL
  • getNewsContent
  • getNewsCustomData
  • getNewsDate
  • getNewsExtraContent
  • getNewsID
  • getNewsIndexURL
  • getNewsPagesStatistic
  • getNewsPathNav
  • getNewsReadMore
  • getNewsTitle
  • getNewsURL
  • getNextAlbum
  • getNextAlbumURL
  • getNextImageThumb
  • getNextImageURL
  • getNextNewsPageURL
  • getNextNewsURL
  • getNextPageURL
  • getNextPrevNews
  • getNotViewableAlbums
  • getNotViewableImages
  • getNumAlbums
  • getNumAllSubalbums
  • getNumImages
  • getNumNews
  • getNumPages
  • getOption
  • getOptionFromDB
  • getOptionList
  • getOwnerAuthor
  • getOwnerAuthorURL
  • getPageAuthor
  • getPageContent
  • getPageCustomData
  • getPageDate
  • getPageExtraContent
  • getPageID
  • getPageLastChangeDate
  • getPageNavList
  • getPageNumURL
  • getPageParentID
  • getPageRedirect
  • getPageSelector
  • getPageSortorder
  • getPageTitle
  • getPageTitleLink
  • getPageURL
  • getParentAlbums
  • getParentAlbumsAdmin
  • getParentBreadcrumb
  • getParentMenuItems
  • getPasswordProtectImage
  • getPHPFiles
  • getPictureOfTheDay
  • getPlugin
  • getPluginFiles
  • getPluginTabs
  • getPrevAlbum
  • getPrevAlbumURL
  • getPrevImageThumb
  • getPrevImageURL
  • getPrevNewsPageURL
  • getPrevNewsURL
  • getPrevPageURL
  • getProtectedImageURL
  • getRandomImages
  • getRandomImagesAlbum
  • getRating
  • getReconfigureNote
  • getRelatedItems
  • getRequestURI
  • getrow
  • getRSSLink
  • getRules
  • getSearchDate
  • getSearchURL
  • getSearchWords
  • getSelectedLayout
  • getSerializedArray
  • getSetClause
  • getSiteHomeURL
  • getSizeCustomImage
  • getSizeDefaultImage
  • getSizeDefaultThumb
  • getSizedImageURL
  • getSizeFullImage
  • getSortByOptions
  • getSortByStatusOptions
  • getStandardGalleryIndexURL
  • getSubtabs
  • getSuffix
  • getSystemLocales
  • getTagCountByAccess
  • getTagOrder
  • getTags
  • gettext
  • gettext_pl
  • gettext_th
  • getThemeFiles
  • getThemeOption
  • getTimezones
  • getTinyMCE4ConfigFiles
  • getTitle
  • getTotalHitcounter
  • getTotalImagesIn
  • getTotalNewsPages
  • getTotalPages
  • getUnprotectedImageURL
  • getUrAlbum
  • getUserIP
  • getUserLocale
  • getUserURL
  • getVersion
  • getWatermarkParam
  • getWatermarkPath
  • getWatermarks
  • getWhereClause
  • getXSRFToken
  • getZenpagePagesOptionsArray
  • getZenpageStatistic
  • handleSearchParms
  • hasDynamicAlbumSuffix
  • hasNextImage
  • hasNextNewsPage
  • hasNextPage
  • hasPrevImage
  • hasPrevNewsPage
  • hasPrevPage
  • hasPrimaryScripts
  • hl_attrval
  • hl_bal
  • hl_cmtcd
  • hl_ent
  • hl_prot
  • hl_regex
  • hl_spec
  • hl_tag
  • hl_tag2
  • hl_tidy
  • hl_version
  • html_decode
  • html_encode
  • html_encodeTagged
  • html_pathurlencode
  • htmLawed
  • httpsRedirect
  • httpUploadHandler
  • httpUploadHandler_admin_tabs
  • i18nSetLocale
  • ignoreSetupRunRequest
  • imageBlurGD
  • imagecreatefrombmp
  • imageDebug
  • imageError
  • imageNumber
  • imgSrcURI
  • in_context
  • installSignature
  • instrument
  • internalToFilesystem
  • inventMenuItem
  • iptc_make_tag
  • is_AdminEditPage
  • is_connected
  • is_News
  • is_NewsArchive
  • is_NewsArticle
  • is_NewsCategory
  • is_NewsPage
  • is_Pages
  • is_valid_email_zp
  • is_zip
  • isAlbumClass
  • isAlbumPage
  • isArchive
  • isCurrentitemParent
  • isHandledAlbum
  • isImageClass
  • isImagePage
  • isImagePhoto
  • isImageVideo
  • isIncompatibleExtension
  • isLandscape
  • isolate
  • isSetupProtected
  • isValidEmail
  • isValidURL
  • jQueryUpload_head
  • jQueryUpload_headers
  • jQueryUploadHandler
  • jQueryUploadHandler_admin_tabs
  • js_encode
  • json_decode
  • json_encode
  • kses
  • kses_array_lc
  • kses_attr
  • kses_bad_protocol
  • kses_bad_protocol_once
  • kses_bad_protocol_once2
  • kses_check_attr_val
  • kses_decode_entities
  • kses_hair
  • kses_hook
  • kses_html_error
  • kses_js_entities
  • kses_no_null
  • kses_normalize_entities
  • kses_normalize_entities2
  • kses_split
  • kses_split2
  • kses_stripslashes
  • kses_version
  • ksesProcess
  • layoutSelector
  • layoutSelector_album
  • listDBUses
  • listDirectoryFiles
  • listUses
  • load_zenpage_news
  • load_zenpage_pages
  • loadLocalOptions
  • log_message
  • lookupSortKey
  • macro_admin_tabs
  • macroList_show
  • makeAlbumCurrent
  • makeImageCurrent
  • makeSpecialImageName
  • markRelease_button
  • mb_strlen
  • mb_strpos
  • mb_strrpos
  • mb_strtolower
  • mb_strtoupper
  • mb_substr
  • mb_substr_count
  • menu_admin_toolbox_global
  • menu_tabs
  • minDiff
  • mkdir_recursive
  • myts_date
  • newAlbum
  • newImage
  • next_album
  • next_comment
  • next_image
  • next_news
  • next_page
  • ngettext
  • ngettext_pl
  • ngettext_th
  • omsAdditions
  • parse_query
  • parse_size
  • parseAllowedTags
  • parseHttpAcceptLanguage
  • pathurlencode
  • pluginDebug
  • populateManagedObjectsList
  • postAlbumSort
  • postIndexDecode
  • postIndexEncode
  • prefix
  • prepareAlbumPage
  • prepareCustomPage
  • prepareImagePage
  • prepareIndexPage
  • print404status
  • print_language_string_list
  • printAddToFavorites
  • printAdminFooter
  • printAdminHeader
  • printAdminRightsTable
  • printAdminThumb
  • printAlbumBreadcrumb
  • printAlbumButtons
  • printAlbumCustomData
  • printAlbumData
  • printAlbumDate
  • printAlbumDesc
  • printAlbumEditForm
  • printAlbumEditRow
  • printAlbumLegend
  • printAlbumLocation
  • printAlbumMenu
  • printAlbumMenuJump
  • printAlbumMenuList
  • printAlbumMenuListAlbum
  • printAlbumsSelector
  • printAlbumStatistic
  • printAlbumStatisticItem
  • printAlbumThumbImage
  • printAlbumTitle
  • printAlbumURL
  • printAllDates
  • printAllNestedList
  • printAllNewsCategories
  • printAllTags
  • printAllTagsAs
  • printAllTagsFromAlbum
  • printAllTagsFromZenpage
  • printAnnotatedAlbumTitle
  • printAnnotatedImageTitle
  • printArticleCategories
  • printArticleDatesDropdown
  • printArticlesPerPageDropdown
  • printAuthorDropdown
  • printBareAlbumDesc
  • printBareAlbumTitle
  • printBareGalleryDesc
  • printBareGalleryTitle
  • printBareImageDesc
  • printBareImageTitle
  • printBareNewsTitle
  • printBarePageTitle
  • printBarGraph
  • printBulkActions
  • printCategoriesStatistic
  • printCategoryCheckboxListEntry
  • printCategoryDropdown
  • printCategoryListSortableTable
  • printCategorySelection
  • printCodeblock
  • printCodeblockEdit
  • printCommentAuthorLink
  • printCommentErrors
  • printCommentForm
  • printContactForm
  • printContactFormMacro
  • printCookieInfo
  • printCopyrightNotice
  • printCurrentNewsArchive
  • printCurrentNewsCategory
  • printCustomAlbumThumbImage
  • printCustomAlbumThumbMaxSpace
  • printCustomMenu
  • printCustomPageSelector
  • printCustomPageURL
  • printCustomSizedImage
  • printCustomSizedImageMaxSpace
  • printCustomSizedImageThumbMaxSpace
  • printDataUsageNotice
  • printDefaultSizedImage
  • printDownloadAlbumZipURL
  • printdownloadList
  • printDownloadURL
  • printEditCommentLink
  • printEditDropdown
  • printExpired
  • printFavoritesURL
  • printFullAlbumsList
  • printFullImageDownloadURL
  • printGalleryDesc
  • printGalleryIndexURL
  • printGalleryTitle
  • printGoogleMap
  • printHeadTitle
  • printHomeLink
  • printImageCustomData
  • printImageData
  • printImageDate
  • printImageDesc
  • printImageMetadata
  • printImageslist
  • printImageStatistic
  • printImageThumb
  • printImageTitle
  • printImageURL
  • printItemEditLink
  • printItemsList
  • printItemsListTable
  • printItemStatusDropdown
  • printjPlayerPlaylist
  • printLangAttribute
  • printLanguageSelector
  • printLastChangeInfo
  • printLatestAlbums
  • printLatestComments
  • printLatestImages
  • printLatestImagesByDate
  • printLatestImagesByMtime
  • printLatestNews
  • printLatestUpdatedAlbums
  • printLinkHTML
  • printLogoAndLinks
  • printManagedObjects
  • printMenuemanagerPageList
  • printMenuemanagerPageListWithNav
  • printMenumanagerBreadcrumb
  • printMenumanagerNextLink
  • printMenumanagerPrevLink
  • printMostPopularItems
  • printMostRatedAlbums
  • printMostRatedImages
  • printMostRatedItems
  • printNestedAlbumsList
  • printNestedItemsList
  • printNestedMenu
  • printNews
  • printNewsArchive
  • printNewsArticlesList
  • printNewsAuthor
  • printNewsCategories
  • printNewsCategoryCustomData
  • printNewsCategoryDesc
  • printNewsCategoryURL
  • printNewsContent
  • printNewsCustomData
  • printNewsDate
  • printNewsExtraContent
  • printNewsIndexURL
  • printNewsPageList
  • printNewsPageListWithNav
  • printNewsStatistic
  • printNewsTitle
  • printNewsURL
  • printNextNewsLink
  • printNextNewsPageLink
  • printNextPageURL
  • printOpenStreetMap
  • printOwnerAuthor
  • printOwnerAuthorURL
  • printPageArticleTags
  • printPageAuthor
  • printPageContent
  • printPageCustomData
  • printPageDate
  • printPagedThumbsNav
  • printPageExtraContent
  • printPageID
  • printPageLastChangeDate
  • printPageList
  • printPageListWithNav
  • printPageMenu
  • printPageNav
  • printPageSelector
  • printPagesListTable
  • printPagesStatistic
  • printPageTitle
  • printPageTitleLink
  • printPageURL
  • printParentBreadcrumb
  • printPasswordForm
  • printPopularAlbums
  • printPopularImages
  • printPrevNewsLink
  • printPrevNewsPageLink
  • printPrevPageURL
  • printPrivacyPageLink
  • printPublished
  • printPublishIconLink
  • printPublishIconLinkGallery
  • printRandomImages
  • printRating
  • printReconfigureError
  • printReconfigureNote
  • printRegisterURL
  • printRegistrationForm
  • printRelatedItems
  • printRSSHeaderLink
  • printRSSLink
  • printScheduledPublishingNotes
  • printSearchBreadcrumb
  • printSearchForm
  • printSelectorWithCustomField
  • printSiteHomeURL
  • printSizedImageURL
  • printSlideShow
  • printSlideShowLink
  • printSortableHead
  • printSortOrderDropdown
  • printSubLevelAlbums
  • printSubPagesExcerpts
  • printSubtabs
  • printTabs
  • printTags
  • printThumbNav
  • printTinyPageNav
  • printTinyZenpageCategorySelector
  • printTopRatedAlbums
  • printTopRatedImages
  • printTopRatedItems
  • printUnpublishedDropdown
  • printUserLogin_out
  • printUserSelector
  • printUserURL
  • printVersion
  • printZenJavascripts
  • printZenpageIconLegend
  • printZenpageItems
  • printZenpageItemsBreadcrumb
  • printZenpageNewsCategorySelector
  • printZenpagePageSelector
  • printZenpagePagesSelector
  • printZenpageStatistic
  • printZenphotoLink
  • process_language_string_save
  • processAlbumBulkActions
  • processAlbumEdit
  • processCodeblockSave
  • processCommentBulkActions
  • processCredentials
  • processCustomOptionSave
  • processEditSelection
  • processExtensionVariable
  • processImageBulkActions
  • processImageEdit
  • processManagedObjects
  • processMenuBulkActions
  • processOrder
  • processRights
  • processTags
  • processZenpageBulkActions
  • propSizes
  • protectSetupFiles
  • publishItem
  • purgeOption
  • purgeThemeOption
  • query
  • query_full_array
  • query_single_row
  • rc4
  • read_exif_data_protected
  • readTags
  • reconfigureAction
  • reconfigureCSS
  • recordMissing
  • redirectionHandler
  • redirectURL
  • rem_context
  • removeDir
  • removeParentAlbumNames
  • removeTrailingSlash
  • renameOption
  • replaceOption
  • replaceThemeOption
  • restore_context
  • reveal
  • rewrite_get_album_image
  • rewrite_path
  • rewriteHandler
  • RSS_Channel
  • RSS_Retrieve
  • RSS_Tags
  • rulesList
  • safe_fnmatch
  • safe_glob
  • sanitize
  • sanitize_numeric
  • sanitize_path
  • sanitize_script
  • sanitize_string
  • sanitizeRedirect
  • save_context
  • saveLayoutSelection
  • saveZenphotoLayoutSelection
  • search_quote
  • secureServer
  • seo_cleanup_button
  • seoFriendly
  • seoFriendlyJS
  • set_context
  • setAlbumSubtabs
  • setexifvars
  • setMainDomain
  • setOption
  • setOptionDefault
  • setSiteState
  • setThemeColumns
  • setThemeOption
  • setThemeOptionDefault
  • setTinyZenpageLocale
  • setupCurrentLocale
  • setupDomain
  • setupTheme
  • shortenContent
  • shortentitle
  • showOrNotShowField
  • showZenphotoOptions
  • shuffle_assoc
  • signatureChange
  • site_upgrade_button
  • site_upgrade_status
  • skipScheduledPublishing
  • sortArray
  • sortByKey
  • sortByMultilingual
  • sortMultiArray
  • standardScripts
  • standardThemeOptions
  • stickyNews
  • storeConfig
  • storeTags
  • stripSuffix
  • submenuOf
  • switchLog
  • tagSelector
  • tagSuggestJS
  • tagSuggestJS_admin
  • tagSuggestJS_frontend
  • tagURLs
  • textdomain
  • themeIsEditable
  • themeSetup
  • tidyHTML
  • timezoneDiff
  • tinymce4ConfigJS
  • truncate_string
  • unprotectSetupFiles
  • unpublishedZenpageItemCheck
  • unpublishedZenphotoItemCheck
  • unpublishSubalbums
  • unQuote
  • unTagURLs
  • unzip
  • updateArticle
  • updateCacheName
  • updateCategory
  • updateConfigItem
  • updateImageProcessorLink
  • updateItemSortorder
  • updateItemsSortorder
  • updateMenuItem
  • updatePage
  • upload_extra
  • upload_form
  • upload_head
  • user_mailing_list_button
  • validateLocale
  • writeHeader
  • XSRFdefender
  • XSRFToken
  • zenpageAlbumImage
  • zenpageBulkActionMessage
  • zenpageJSCSS
  • zenpagePublish
  • zenphoto_PHPMailer
  • zenphoto_sendmail
  • zenPhotoTheme
  • zp_apply_filter
  • zp_clearCookie
  • zp_colorAllocate
  • zp_cookieEncode
  • zp_copyCanvas
  • zp_createImage
  • zp_drawRectangle
  • zp_error
  • zp_filter_slot
  • zp_filter_unique_id
  • zp_getCookie
  • zp_getFonts
  • zp_graphicsLibInfo
  • zp_handle_password
  • zp_handle_password_single
  • zp_has_filter
  • zp_image_types
  • zp_imageCanRotate
  • zp_imageColorTransparent
  • zp_imageDims
  • zp_imageFill
  • zp_imageFontHeight
  • zp_imageFontWidth
  • zp_imageFromString
  • zp_imageGet
  • zp_imageGray
  • zp_imageHeight
  • zp_imageIPTC
  • zp_imageKill
  • zp_imageLoadFont
  • zp_imageMerge
  • zp_imageOutput
  • zp_imageResizeAlpha
  • zp_imageResizeTransparent
  • zp_imageUnsharpMask
  • zp_imageWidth
  • zp_load_album
  • zp_load_gallery
  • zp_load_image
  • zp_load_page
  • zp_load_request
  • zp_load_search
  • zp_loggedin
  • zp_mail
  • zp_register_filter
  • zp_remove_filter
  • zp_resampleImage
  • zp_rotateImage
  • zp_session_destroy
  • zp_session_start
  • zp_setCookie
  • zp_writeString
  • zpErrorHandler
  • zpFormattedDate
  • zpRewriteURL
  • Overview
  • Class
  • Tree
  • Package
  • Deprecated

Class PHPMailer

PHPMailer - PHP email creation and transport class.

Namespace: PHPMailer\PHPMailer
Author: Marcus Bointon (Synchro/coolbru) phpmailer@synchromedia.co.uk
Author: Jim Jagielski (jimjag) jimjag@gmail.com
Author: Andy Prevost (codeworxtech) codeworxtech@users.sourceforge.net
Author: Brent R. Matzelle (original founder)
Located at zp-extensions/PHPMailer/PHPMailer.php
Methods summary
public
# __construct( boolean $exceptions = null )

Constructor.

Constructor.

Parameters

$exceptions
Should we throw external exceptions?
public
# __destruct( )

Destructor.

Destructor.

protected
# edebug( string $str )

Output debugging info via a user-defined method. Only generates output if debug output is enabled.

Output debugging info via a user-defined method. Only generates output if debug output is enabled.

Parameters

$str

See

PHPMailer::$Debugoutput
PHPMailer::$SMTPDebug
public
# isHTML( boolean $isHtml = true )

Sets message type to HTML or plain.

Sets message type to HTML or plain.

Parameters

$isHtml
True for HTML mode
public
# isSMTP( )

Send messages using SMTP.

Send messages using SMTP.

public
# isMail( )

Send messages using PHP's mail() function.

Send messages using PHP's mail() function.

public
# isSendmail( )

Send messages using $Sendmail.

Send messages using $Sendmail.

public
# isQmail( )

Send messages using qmail.

Send messages using qmail.

public boolean
# addAddress( string $address, string $name = '' )

Add a "To" address.

Add a "To" address.

Parameters

$address
The email address to send to
$name

Returns

boolean
true on success, false if address already used or invalid in some way

Throws

PHPMailer\PHPMailer\Exception
public boolean
# addCC( string $address, string $name = '' )

Add a "CC" address.

Add a "CC" address.

Parameters

$address
The email address to send to
$name

Returns

boolean
true on success, false if address already used or invalid in some way

Throws

PHPMailer\PHPMailer\Exception
public boolean
# addBCC( string $address, string $name = '' )

Add a "BCC" address.

Add a "BCC" address.

Parameters

$address
The email address to send to
$name

Returns

boolean
true on success, false if address already used or invalid in some way

Throws

PHPMailer\PHPMailer\Exception
public boolean
# addReplyTo( string $address, string $name = '' )

Add a "Reply-To" address.

Add a "Reply-To" address.

Parameters

$address
The email address to reply to
$name

Returns

boolean
true on success, false if address already used or invalid in some way

Throws

PHPMailer\PHPMailer\Exception
protected boolean
# addOrEnqueueAnAddress( string $kind, string $address, string $name )

Add an address to one of the recipient arrays or to the ReplyTo array. Because PHPMailer can't validate addresses with an IDN without knowing the PHPMailer::$CharSet (that can still be modified after calling this function), addition of such addresses is delayed until send(). Addresses that have been added already return false, but do not throw exceptions.

Add an address to one of the recipient arrays or to the ReplyTo array. Because PHPMailer can't validate addresses with an IDN without knowing the PHPMailer::$CharSet (that can still be modified after calling this function), addition of such addresses is delayed until send(). Addresses that have been added already return false, but do not throw exceptions.

Parameters

$kind
One of 'to', 'cc', 'bcc', or 'ReplyTo'
$address
The email address to send, resp. to reply to
$name

Returns

boolean
true on success, false if address already used or invalid in some way

Throws

PHPMailer\PHPMailer\Exception
protected boolean
# addAnAddress( string $kind, string $address, string $name = '' )

Add an address to one of the recipient arrays or to the ReplyTo array. Addresses that have been added already return false, but do not throw exceptions.

Add an address to one of the recipient arrays or to the ReplyTo array. Addresses that have been added already return false, but do not throw exceptions.

Parameters

$kind
One of 'to', 'cc', 'bcc', or 'ReplyTo'
$address
The email address to send, resp. to reply to
$name

Returns

boolean
true on success, false if address already used or invalid in some way

Throws

PHPMailer\PHPMailer\Exception
public static array
# parseAddresses( string $addrstr, boolean $useimap = true )

Parse and validate a string containing one or more RFC822-style comma-separated email addresses of the form "display name

<

address>" into an array of name/address pairs. Uses the imap_rfc822_parse_adrlist function if the IMAP extension is available. Note that quotes in the name part are removed.

Parse and validate a string containing one or more RFC822-style comma-separated email addresses of the form "display name

<

address>" into an array of name/address pairs. Uses the imap_rfc822_parse_adrlist function if the IMAP extension is available. Note that quotes in the name part are removed.

Parameters

$addrstr
The address list string
$useimap
Whether to use the IMAP extension to parse the list

Returns

array

See

http://www.andrew.cmu.edu/user/agreen1/testing/mrbs/web/Mail/RFC822.php A more careful implementation
public boolean
# setFrom( string $address, string $name = '', boolean $auto = true )

Set the From and FromName properties.

Set the From and FromName properties.

Parameters

$address
$name
$auto
Whether to also set the Sender address, defaults to true

Returns

boolean

Throws

PHPMailer\PHPMailer\Exception
public string
# getLastMessageID( )

Return the Message-ID header of the last email. Technically this is the value from the last time the headers were created, but it's also the message ID of the last sent message except in pathological cases.

Return the Message-ID header of the last email. Technically this is the value from the last time the headers were created, but it's also the message ID of the last sent message except in pathological cases.

Returns

string
public static boolean
# validateAddress( string $address, string|callable $patternselect = null )

Check that a string looks like an email address. Validation patterns supported: * auto Pick best pattern automatically; * pcre8 Use the squiloople.com pattern, requires PCRE > 8.0; * pcre Use old PCRE implementation; * php Use PHP built-in FILTER_VALIDATE_EMAIL; * html5 Use the pattern given by the HTML5 spec for 'email' type form input elements. * noregex Don't use a regex: super fast, really dumb. Alternatively you may pass in a callable to inject your own validator, for example:

Check that a string looks like an email address. Validation patterns supported: * auto Pick best pattern automatically; * pcre8 Use the squiloople.com pattern, requires PCRE > 8.0; * pcre Use old PCRE implementation; * php Use PHP built-in FILTER_VALIDATE_EMAIL; * html5 Use the pattern given by the HTML5 spec for 'email' type form input elements. * noregex Don't use a regex: super fast, really dumb. Alternatively you may pass in a callable to inject your own validator, for example:

PHPMailer::validateAddress('user@example.com', function($address) { return (strpos($address, '@') !== false);
});

You can also set the PHPMailer::$validator static to a callable, allowing built-in methods to use your validator.

Parameters

$address
The email address to check
$patternselect
Which pattern to use

Returns

boolean
public static boolean
# idnSupported( )

Tells whether IDNs (Internationalized Domain Names) are supported or not. This requires the intl and mbstring PHP extensions.

Tells whether IDNs (Internationalized Domain Names) are supported or not. This requires the intl and mbstring PHP extensions.

Returns

boolean
true if required functions for IDN support are present
public string
# punyencodeAddress( string $address )

Converts IDN in given email address to its ASCII form, also known as punycode, if possible. Important: Address must be passed in same encoding as currently set in PHPMailer::$CharSet. This function silently returns unmodified address if: - No conversion is necessary (i.e. domain name is not an IDN, or is already in ASCII form) - Conversion to punycode is impossible (e.g. required PHP functions are not available) or fails for any reason (e.g. domain contains characters not allowed in an IDN).

Converts IDN in given email address to its ASCII form, also known as punycode, if possible. Important: Address must be passed in same encoding as currently set in PHPMailer::$CharSet. This function silently returns unmodified address if: - No conversion is necessary (i.e. domain name is not an IDN, or is already in ASCII form) - Conversion to punycode is impossible (e.g. required PHP functions are not available) or fails for any reason (e.g. domain contains characters not allowed in an IDN).

Parameters

$address
The email address to convert

Returns

string
The encoded address in ASCII form

See

PHPMailer::$CharSet
public boolean
# send( )

Create a message and send it. Uses the sending method specified by $Mailer.

Create a message and send it. Uses the sending method specified by $Mailer.

Returns

boolean
false on error - See the ErrorInfo property for details of the error

Throws

PHPMailer\PHPMailer\Exception
public boolean
# preSend( )

Prepare a message for sending.

Prepare a message for sending.

Returns

boolean

Throws

PHPMailer\PHPMailer\Exception
public boolean
# postSend( )

Actually send a message via the selected mechanism.

Actually send a message via the selected mechanism.

Returns

boolean

Throws

PHPMailer\PHPMailer\Exception
protected boolean
# sendmailSend( string $header, string $body )

Send mail using the $Sendmail program.

Send mail using the $Sendmail program.

Parameters

$header
The message headers
$body
The message body

Returns

boolean

Throws

PHPMailer\PHPMailer\Exception

See

PHPMailer::$Sendmail
protected static boolean
# isShellSafe( string $string )

Fix CVE-2016-10033 and CVE-2016-10045 by disallowing potentially unsafe shell characters. Note that escapeshellarg and escapeshellcmd are inadequate for our purposes, especially on Windows.

Fix CVE-2016-10033 and CVE-2016-10045 by disallowing potentially unsafe shell characters. Note that escapeshellarg and escapeshellcmd are inadequate for our purposes, especially on Windows.

Parameters

$string
The string to be validated

Returns

boolean

See

https://github.com/PHPMailer/PHPMailer/issues/924 CVE-2016-10045 bug report
protected static boolean
# isPermittedPath( string $path )

Check whether a file path is of a permitted type. Used to reject URLs and phar files from functions that access local file paths, such as addAttachment.

Check whether a file path is of a permitted type. Used to reject URLs and phar files from functions that access local file paths, such as addAttachment.

Parameters

$path
A relative or absolute path to a file

Returns

boolean
protected static boolean
# fileIsAccessible( string $path )

Check whether a file path is safe, accessible, and readable.

Check whether a file path is safe, accessible, and readable.

Parameters

$path
A relative or absolute path to a file

Returns

boolean
protected boolean
# mailSend( string $header, string $body )

Send mail using the PHP mail() function.

Send mail using the PHP mail() function.

Parameters

$header
The message headers
$body
The message body

Returns

boolean

Throws

PHPMailer\PHPMailer\Exception

See

http://www.php.net/manual/en/book.mail.php
public PHPMailer\PHPMailer\SMTP
# getSMTPInstance( )

Get an instance to use for SMTP operations. Override this function to load your own SMTP implementation, or set one with setSMTPInstance.

Get an instance to use for SMTP operations. Override this function to load your own SMTP implementation, or set one with setSMTPInstance.

Returns

PHPMailer\PHPMailer\SMTP
public PHPMailer\PHPMailer\SMTP
# setSMTPInstance( PHPMailer\PHPMailer\SMTP $smtp )

Provide an instance to use for SMTP operations.

Provide an instance to use for SMTP operations.

Returns

PHPMailer\PHPMailer\SMTP
protected boolean
# smtpSend( string $header, string $body )

Send mail via SMTP. Returns false if there is a bad MAIL FROM, RCPT, or DATA input.

Send mail via SMTP. Returns false if there is a bad MAIL FROM, RCPT, or DATA input.

Parameters

$header
The message headers
$body
The message body

Returns

boolean

Throws

PHPMailer\PHPMailer\Exception

See

PHPMailer::setSMTPInstance() to use a different class.

Uses

PHPMailer\PHPMailer\SMTP
public boolean
# smtpConnect( array $options = null )

Initiate a connection to an SMTP server. Returns false if the operation failed.

Initiate a connection to an SMTP server. Returns false if the operation failed.

Parameters

$options
An array of options compatible with stream_context_create()

Returns

boolean

Throws

PHPMailer\PHPMailer\Exception

Uses

PHPMailer\PHPMailer\SMTP
public
# smtpClose( )

Close the active SMTP session if one exists.

Close the active SMTP session if one exists.

public boolean
# setLanguage( string $langcode = 'en', string $lang_path = '' )

Set the language for error messages. Returns false if it cannot load the language file. The default language is English.

Set the language for error messages. Returns false if it cannot load the language file. The default language is English.

Parameters

$langcode
ISO 639-1 2-character language code (e.g. French is "fr")
$lang_path
Path to the language file directory, with trailing separator (slash)

Returns

boolean
public array
# getTranslations( )

Get the array of strings for the current language.

Get the array of strings for the current language.

Returns

array
public string
# addrAppend( string $type, array $addr )

Create recipient headers.

Create recipient headers.

Parameters

$type
$addr

An array of recipients, where each recipient is a 2-element indexed array with element 0 containing an address and element 1 containing a name, like: [['joe@example.com', 'Joe User'], ['zoe@example.com', 'Zoe User']]

Returns

string
public string
# addrFormat( array $addr )

Format an address for use in a message header.

Format an address for use in a message header.

Parameters

$addr

A 2-element indexed array, element 0 containing an address, element 1 containing a name like ['joe@example.com', 'Joe User']

Returns

string
public string
# wrapText( string $message, integer $length, boolean $qp_mode = false )

Word-wrap message. For use with mailers that do not automatically perform wrapping and for quoted-printable encoded messages. Original written by philippe.

Word-wrap message. For use with mailers that do not automatically perform wrapping and for quoted-printable encoded messages. Original written by philippe.

Parameters

$message
The message to wrap
$length
The line length to wrap to
$qp_mode
Whether to run in Quoted-Printable mode

Returns

string
public integer
# utf8CharBoundary( string $encodedText, integer $maxLength )

Find the last character boundary prior to $maxLength in a utf-8 quoted-printable encoded string. Original written by Colin Brown.

Find the last character boundary prior to $maxLength in a utf-8 quoted-printable encoded string. Original written by Colin Brown.

Parameters

$encodedText
utf-8 QP text
$maxLength
Find the last character boundary prior to this length

Returns

integer
public
# setWordWrap( )

Apply word wrapping to the message body. Wraps the message body to the number of chars set in the WordWrap property. You should only do this to plain-text bodies as wrapping HTML tags may break them. This is called automatically by createBody(), so you don't need to call it yourself.

Apply word wrapping to the message body. Wraps the message body to the number of chars set in the WordWrap property. You should only do this to plain-text bodies as wrapping HTML tags may break them. This is called automatically by createBody(), so you don't need to call it yourself.

public string
# createHeader( )

Assemble message headers.

Assemble message headers.

Returns

string
The assembled headers
public string
# getMailMIME( )

Get the message MIME type headers.

Get the message MIME type headers.

Returns

string
public string
# getSentMIMEMessage( )

Returns the whole MIME message. Includes complete headers and body. Only valid post preSend().

Returns the whole MIME message. Includes complete headers and body. Only valid post preSend().

Returns

string

See

PHPMailer::preSend()
protected string
# generateId( )

Create a unique ID to use for boundaries.

Create a unique ID to use for boundaries.

Returns

string
public string
# createBody( )

Assemble the message body. Returns an empty string on failure.

Assemble the message body. Returns an empty string on failure.

Returns

string
The assembled message body

Throws

PHPMailer\PHPMailer\Exception
protected string
# getBoundary( string $boundary, string $charSet, string $contentType, string $encoding )

Return the start of a message boundary.

Return the start of a message boundary.

Parameters

$boundary
$charSet
$contentType
$encoding

Returns

string
protected string
# endBoundary( string $boundary )

Return the end of a message boundary.

Return the end of a message boundary.

Parameters

$boundary

Returns

string
protected
# setMessageType( )

Set the message type. PHPMailer only supports some preset message types, not arbitrary MIME structures.

Set the message type. PHPMailer only supports some preset message types, not arbitrary MIME structures.

public string
# headerLine( string $name, string|integer $value )

Format a header line.

Format a header line.

Parameters

$name
$value

Returns

string
public string
# textLine( string $value )

Return a formatted mail line.

Return a formatted mail line.

Parameters

$value

Returns

string
public boolean
# addAttachment( string $path, string $name = '', string $encoding = self::ENCODING_BASE64, string $type = '', string $disposition = 'attachment' )

Add an attachment from a path on the filesystem. Never use a user-supplied path to a file! Returns false if the file could not be found or read. Explicitly does not support passing URLs; PHPMailer is not an HTTP client. If you need to do that, fetch the resource yourself and pass it in via a local file or string.

Add an attachment from a path on the filesystem. Never use a user-supplied path to a file! Returns false if the file could not be found or read. Explicitly does not support passing URLs; PHPMailer is not an HTTP client. If you need to do that, fetch the resource yourself and pass it in via a local file or string.

Parameters

$path
Path to the attachment
$name
Overrides the attachment name
$encoding
File encoding (see $Encoding)
$type
MIME type, e.g. image/jpeg; determined automatically from $path if not specified
$disposition
Disposition to use

Returns

boolean

Throws

PHPMailer\PHPMailer\Exception
public array
# getAttachments( )

Return the array of attachments.

Return the array of attachments.

Returns

array
protected string
# attachAll( string $disposition_type, string $boundary )

Attach all file, string, and binary attachments to the message. Returns an empty string on failure.

Attach all file, string, and binary attachments to the message. Returns an empty string on failure.

Parameters

$disposition_type
$boundary

Returns

string

Throws

PHPMailer\PHPMailer\Exception
protected string
# encodeFile( string $path, string $encoding = self::ENCODING_BASE64 )

Encode a file attachment in requested format. Returns an empty string on failure.

Encode a file attachment in requested format. Returns an empty string on failure.

Parameters

$path
The full path to the file
$encoding
The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable'

Returns

string
public string
# encodeString( string $str, string $encoding = self::ENCODING_BASE64 )

Encode a string in requested format. Returns an empty string on failure.

Encode a string in requested format. Returns an empty string on failure.

Parameters

$str
The text to encode
$encoding
The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable'

Returns

string

Throws

PHPMailer\PHPMailer\Exception
public string
# encodeHeader( string $str, string $position = 'text' )

Encode a header value (not including its label) optimally. Picks shortest of Q, B, or none. Result includes folding if needed. See RFC822 definitions for phrase, comment and text positions.

Encode a header value (not including its label) optimally. Picks shortest of Q, B, or none. Result includes folding if needed. See RFC822 definitions for phrase, comment and text positions.

Parameters

$str
The header value to encode
$position
What context the string will be used in

Returns

string
public boolean
# hasMultiBytes( string $str )

Check if a string contains multi-byte characters.

Check if a string contains multi-byte characters.

Parameters

$str
multi-byte text to wrap encode

Returns

boolean
public boolean
# has8bitChars( string $text )

Does a string contain any 8-bit chars (in any charset)?

Does a string contain any 8-bit chars (in any charset)?

Parameters

$text

Returns

boolean
public string
# base64EncodeWrapMB( string $str, string $linebreak = null )

Encode and wrap long multibyte strings for mail headers without breaking lines within a character. Adapted from a function by paravoid.

Encode and wrap long multibyte strings for mail headers without breaking lines within a character. Adapted from a function by paravoid.

Parameters

$str
multi-byte text to wrap encode
$linebreak
string to use as linefeed/end-of-line

Returns

string

See

http://www.php.net/manual/en/function.mb-encode-mimeheader.php#60283
public string
# encodeQP( string $string )

Encode a string in quoted-printable format. According to RFC2045 section 6.7.

Encode a string in quoted-printable format. According to RFC2045 section 6.7.

Parameters

$string
The text to encode

Returns

string
public string
# encodeQ( string $str, string $position = 'text' )

Encode a string using Q encoding.

Encode a string using Q encoding.

Parameters

$str
the text to encode
$position
Where the text is going to be used, see the RFC for what that means

Returns

string

See

http://tools.ietf.org/html/rfc2047#section-4.2
public boolean
# addStringAttachment( string $string, string $filename, string $encoding = self::ENCODING_BASE64, string $type = '', string $disposition = 'attachment' )

Add a string or binary attachment (non-filesystem). This method can be used to attach ascii or binary data, such as a BLOB record from a database.

Add a string or binary attachment (non-filesystem). This method can be used to attach ascii or binary data, such as a BLOB record from a database.

Parameters

$string
String attachment data
$filename
Name of the attachment
$encoding
File encoding (see $Encoding)
$type
File extension (MIME) type
$disposition
Disposition to use

Returns

boolean
True on successfully adding an attachment

Throws

PHPMailer\PHPMailer\Exception
public boolean
# addEmbeddedImage( string $path, string $cid, string $name = '', string $encoding = self::ENCODING_BASE64, string $type = '', string $disposition = 'inline' )

Add an embedded (inline) attachment from a file. This can include images, sounds, and just about any other document type. These differ from 'regular' attachments in that they are intended to be displayed inline with the message, not just attached for download. This is used in HTML messages that embed the images the HTML refers to using the $cid value. Never use a user-supplied path to a file!

Add an embedded (inline) attachment from a file. This can include images, sounds, and just about any other document type. These differ from 'regular' attachments in that they are intended to be displayed inline with the message, not just attached for download. This is used in HTML messages that embed the images the HTML refers to using the $cid value. Never use a user-supplied path to a file!

Parameters

$path
Path to the attachment
$cid

Content ID of the attachment; Use this to reference the content when using an embedded image in HTML

$name
Overrides the attachment name
$encoding
File encoding (see $Encoding)
$type
File MIME type
$disposition
Disposition to use

Returns

boolean
True on successfully adding an attachment

Throws

PHPMailer\PHPMailer\Exception
public boolean
# addStringEmbeddedImage( string $string, string $cid, string $name = '', string $encoding = self::ENCODING_BASE64, string $type = '', string $disposition = 'inline' )

Add an embedded stringified attachment. This can include images, sounds, and just about any other document type. If your filename doesn't contain an extension, be sure to set the $type to an appropriate MIME type.

Add an embedded stringified attachment. This can include images, sounds, and just about any other document type. If your filename doesn't contain an extension, be sure to set the $type to an appropriate MIME type.

Parameters

$string
The attachment binary data
$cid

Content ID of the attachment; Use this to reference the content when using an embedded image in HTML

$name

A filename for the attachment. If this contains an extension, PHPMailer will attempt to set a MIME type for the attachment. For example 'file.jpg' would get an 'image/jpeg' MIME type.

$encoding
File encoding (see $Encoding), defaults to 'base64'
$type
MIME type - will be used in preference to any automatically derived type
$disposition
Disposition to use

Returns

boolean
True on successfully adding an attachment

Throws

PHPMailer\PHPMailer\Exception
protected boolean
# validateEncoding( string $encoding )

Validate encodings.

Validate encodings.

Parameters

$encoding

Returns

boolean
protected boolean
# cidExists( string $cid )

Check if an embedded attachment is present with this cid.

Check if an embedded attachment is present with this cid.

Parameters

$cid

Returns

boolean
public boolean
# inlineImageExists( )

Check if an inline attachment is present.

Check if an inline attachment is present.

Returns

boolean
public boolean
# attachmentExists( )

Check if an attachment (non-inline) is present.

Check if an attachment (non-inline) is present.

Returns

boolean
public boolean
# alternativeExists( )

Check if this message has an alternative body set.

Check if this message has an alternative body set.

Returns

boolean
public
# clearQueuedAddresses( string $kind )

Clear queued addresses of given kind.

Clear queued addresses of given kind.

Parameters

$kind
'to', 'cc', or 'bcc'
public
# clearAddresses( )

Clear all To recipients.

Clear all To recipients.

public
# clearCCs( )

Clear all CC recipients.

Clear all CC recipients.

public
# clearBCCs( )

Clear all BCC recipients.

Clear all BCC recipients.

public
# clearReplyTos( )

Clear all ReplyTo recipients.

Clear all ReplyTo recipients.

public
# clearAllRecipients( )

Clear all recipient types.

Clear all recipient types.

public
# clearAttachments( )

Clear all filesystem, string, and binary attachments.

Clear all filesystem, string, and binary attachments.

public
# clearCustomHeaders( )

Clear all custom headers.

Clear all custom headers.

protected
# setError( string $msg )

Add an error message to the error container.

Add an error message to the error container.

Parameters

$msg
public static string
# rfcDate( )

Return an RFC 822 formatted date.

Return an RFC 822 formatted date.

Returns

string
protected string
# serverHostname( )

Get the server hostname. Returns 'localhost.localdomain' if unknown.

Get the server hostname. Returns 'localhost.localdomain' if unknown.

Returns

string
public static boolean
# isValidHost( string $host )

Validate whether a string contains a valid value to use as a hostname or IP address. IPv6 addresses must include [], e.g. [::1], not just ::1.

Validate whether a string contains a valid value to use as a hostname or IP address. IPv6 addresses must include [], e.g. [::1], not just ::1.

Parameters

$host
The host name or IP address to check

Returns

boolean
protected string
# lang( string $key )

Get an error message in the current language.

Get an error message in the current language.

Parameters

$key

Returns

string
public boolean
# isError( )

Check if an error occurred.

Check if an error occurred.

Returns

boolean
True if an error did occur
public
# addCustomHeader( string $name, string|null $value = null )

Add a custom header. $name value can be overloaded to contain both header name and value (name:value).

Add a custom header. $name value can be overloaded to contain both header name and value (name:value).

Parameters

$name
Custom header name
$value
Header value

Throws

PHPMailer\PHPMailer\Exception
public array
# getCustomHeaders( )

Returns all custom headers.

Returns all custom headers.

Returns

array
public string
# msgHTML( string $message, string $basedir = '', boolean|callable $advanced = false )

Create a message body from an HTML string. Automatically inlines images and creates a plain-text version by converting the HTML, overwriting any existing values in Body and AltBody. Do not source $message content from user input! $basedir is prepended when handling relative URLs, e.g. and must not be empty will look for an image file in $basedir/images/a.png and convert it to inline. If you don't provide a $basedir, relative paths will be left untouched (and thus probably break in email) Converts data-uri images into embedded attachments. If you don't want to apply these transformations to your HTML, just set Body and AltBody directly.

Create a message body from an HTML string. Automatically inlines images and creates a plain-text version by converting the HTML, overwriting any existing values in Body and AltBody. Do not source $message content from user input! $basedir is prepended when handling relative URLs, e.g. and must not be empty will look for an image file in $basedir/images/a.png and convert it to inline. If you don't provide a $basedir, relative paths will be left untouched (and thus probably break in email) Converts data-uri images into embedded attachments. If you don't want to apply these transformations to your HTML, just set Body and AltBody directly.

Parameters

$message
HTML message string
$basedir
Absolute path to a base directory to prepend to relative paths to images
$advanced

Whether to use the internal HTML to text converter or your own custom converter

Returns

string
The transformed message body

Throws

PHPMailer\PHPMailer\Exception

See

PHPMailer::html2text()
public string
# html2text( string $html, boolean|callable $advanced = false )

Convert an HTML string into plain text. This is used by msgHTML(). Note - older versions of this function used a bundled advanced converter which was removed for license reasons in #232. Example usage:

Convert an HTML string into plain text. This is used by msgHTML(). Note - older versions of this function used a bundled advanced converter which was removed for license reasons in #232. Example usage:

//Use default conversion
$plain = $mail->html2text($html);
//Use your own custom converter
$plain = $mail->html2text($html, function($html) { $converter = new MyHtml2text($html); return $converter->get_text();
});

Parameters

$html
The HTML text to convert
$advanced

Any boolean value to use the internal converter, or provide your own callable for custom conversion

Returns

string
public static string
# _mime_types( string $ext = '' )

Get the MIME type for a file extension.

Get the MIME type for a file extension.

Parameters

$ext
File extension

Returns

string
MIME type of file
public static string
# filenameToType( string $filename )

Map a file name to a MIME type. Defaults to 'application/octet-stream', i.e.. arbitrary binary data.

Map a file name to a MIME type. Defaults to 'application/octet-stream', i.e.. arbitrary binary data.

Parameters

$filename
A file name or full path, does not need to exist as a file

Returns

string
public static string|array
# mb_pathinfo( string $path, integer|string $options = null )

Multi-byte-safe pathinfo replacement. Drop-in replacement for pathinfo(), but multibyte- and cross-platform-safe.

Multi-byte-safe pathinfo replacement. Drop-in replacement for pathinfo(), but multibyte- and cross-platform-safe.

Parameters

$path
A filename or path, does not need to exist as a file
$options

Either a PATHINFO_* constant, or a string name to return only the specified piece

Returns

string|array

See

http://www.php.net/manual/en/function.pathinfo.php#107461
public boolean
# set( string $name, mixed $value = '' )

Set or reset instance properties. You should avoid this function - it's more verbose, less efficient, more error-prone and harder to debug than setting properties directly. Usage Example: $mail->set('SMTPSecure', static::ENCRYPTION_STARTTLS); is the same as: $mail->SMTPSecure = static::ENCRYPTION_STARTTLS;.

Set or reset instance properties. You should avoid this function - it's more verbose, less efficient, more error-prone and harder to debug than setting properties directly. Usage Example: $mail->set('SMTPSecure', static::ENCRYPTION_STARTTLS); is the same as: $mail->SMTPSecure = static::ENCRYPTION_STARTTLS;.

Parameters

$name
The property name to set
$value
The value to set the property to

Returns

boolean
public string
# secureHeader( string $str )

Strip newlines to prevent header injection.

Strip newlines to prevent header injection.

Parameters

$str

Returns

string
public static string
# normalizeBreaks( string $text, string $breaktype = null )

Normalize line breaks in a string. Converts UNIX LF, Mac CR and Windows CRLF line breaks into a single line break format. Defaults to CRLF (for message bodies) and preserves consecutive breaks.

Normalize line breaks in a string. Converts UNIX LF, Mac CR and Windows CRLF line breaks into a single line break format. Defaults to CRLF (for message bodies) and preserves consecutive breaks.

Parameters

$text
$breaktype
What kind of line break to use; defaults to static::$LE

Returns

string
public static string
# stripTrailingWSP( string $text )

Remove trailing breaks from a string.

Remove trailing breaks from a string.

Parameters

$text

Returns

string
The text to remove breaks from
public static string
# getLE( )

Return the current line break format string.

Return the current line break format string.

Returns

string
protected static
# setLE( string $le )

Set the line break format string, e.g. "\r\n".

Set the line break format string, e.g. "\r\n".

Parameters

$le
public
# sign( string $cert_filename, string $key_filename, string $key_pass, string $extracerts_filename = '' )

Set the public and private key files and password for S/MIME signing.

Set the public and private key files and password for S/MIME signing.

Parameters

$cert_filename
$key_filename
$key_pass
Password for private key
$extracerts_filename
Optional path to chain certificate
public string
# DKIM_QP( string $txt )

Quoted-Printable-encode a DKIM header.

Quoted-Printable-encode a DKIM header.

Parameters

$txt

Returns

string
public string
# DKIM_Sign( string $signHeader )

Generate a DKIM signature.

Generate a DKIM signature.

Parameters

$signHeader

Returns

string
The DKIM signature value

Throws

PHPMailer\PHPMailer\Exception
public string
# DKIM_HeaderC( string $signHeader )

Generate a DKIM canonicalization header. Uses the 'relaxed' algorithm from RFC6376 section 3.4.2. Canonicalized headers should always use CRLF, regardless of mailer setting.

Generate a DKIM canonicalization header. Uses the 'relaxed' algorithm from RFC6376 section 3.4.2. Canonicalized headers should always use CRLF, regardless of mailer setting.

Parameters

$signHeader
Header

Returns

string

See

https://tools.ietf.org/html/rfc6376#section-3.4.2
public string
# DKIM_BodyC( string $body )

Generate a DKIM canonicalization body. Uses the 'simple' algorithm from RFC6376 section 3.4.3. Canonicalized bodies should always use CRLF, regardless of mailer setting.

Generate a DKIM canonicalization body. Uses the 'simple' algorithm from RFC6376 section 3.4.3. Canonicalized bodies should always use CRLF, regardless of mailer setting.

Parameters

$body
Message Body

Returns

string

See

https://tools.ietf.org/html/rfc6376#section-3.4.3
public string
# DKIM_Add( string $headers_line, string $subject, string $body )

Create the DKIM header and body in a new message header.

Create the DKIM header and body in a new message header.

Parameters

$headers_line
Header lines
$subject
Subject
$body
Body

Returns

string

Throws

PHPMailer\PHPMailer\Exception
public static boolean
# hasLineLongerThanMax( string $str )

Detect if a string contains a line longer than the maximum line length allowed by RFC 2822 section 2.1.1.

Detect if a string contains a line longer than the maximum line length allowed by RFC 2822 section 2.1.1.

Parameters

$str

Returns

boolean
public static string
# quotedString( string $str )

If a string contains any "special" characters, double-quote the name, and escape any double quotes with a backslash.

If a string contains any "special" characters, double-quote the name, and escape any double quotes with a backslash.

Parameters

$str

Returns

string

See

RFC822 3.4.1
public array
# getToAddresses( )

Allows for public read access to 'to' property. Before the send() call, queued addresses (i.e. with IDN) are not yet included.

Allows for public read access to 'to' property. Before the send() call, queued addresses (i.e. with IDN) are not yet included.

Returns

array
public array
# getCcAddresses( )

Allows for public read access to 'cc' property. Before the send() call, queued addresses (i.e. with IDN) are not yet included.

Allows for public read access to 'cc' property. Before the send() call, queued addresses (i.e. with IDN) are not yet included.

Returns

array
public array
# getBccAddresses( )

Allows for public read access to 'bcc' property. Before the send() call, queued addresses (i.e. with IDN) are not yet included.

Allows for public read access to 'bcc' property. Before the send() call, queued addresses (i.e. with IDN) are not yet included.

Returns

array
public array
# getReplyToAddresses( )

Allows for public read access to 'ReplyTo' property. Before the send() call, queued addresses (i.e. with IDN) are not yet included.

Allows for public read access to 'ReplyTo' property. Before the send() call, queued addresses (i.e. with IDN) are not yet included.

Returns

array
public array
# getAllRecipientAddresses( )

Allows for public read access to 'all_recipients' property. Before the send() call, queued addresses (i.e. with IDN) are not yet included.

Allows for public read access to 'all_recipients' property. Before the send() call, queued addresses (i.e. with IDN) are not yet included.

Returns

array
protected
# doCallback( boolean $isSent, array $to, array $cc, array $bcc, string $subject, string $body, string $from, array $extra )

Perform a callback.

Perform a callback.

Parameters

$isSent
$to
$cc
$bcc
$subject
$body
$from
$extra
public OAuth
# getOAuth( )

Get the OAuth instance.

Get the OAuth instance.

Returns

OAuth
public
# setOAuth( PHPMailer\PHPMailer\OAuth $oauth )

Set an OAuth instance.

Set an OAuth instance.

Constants summary
string CHARSET_ASCII
# 'us-ascii'
string CHARSET_ISO88591
# 'iso-8859-1'
string CHARSET_UTF8
# 'utf-8'
string CONTENT_TYPE_PLAINTEXT
# 'text/plain'
string CONTENT_TYPE_TEXT_CALENDAR
# 'text/calendar'
string CONTENT_TYPE_TEXT_HTML
# 'text/html'
string CONTENT_TYPE_MULTIPART_ALTERNATIVE
# 'multipart/alternative'
string CONTENT_TYPE_MULTIPART_MIXED
# 'multipart/mixed'
string CONTENT_TYPE_MULTIPART_RELATED
# 'multipart/related'
string ENCODING_7BIT
# '7bit'
string ENCODING_8BIT
# '8bit'
string ENCODING_BASE64
# 'base64'
string ENCODING_BINARY
# 'binary'
string ENCODING_QUOTED_PRINTABLE
# 'quoted-printable'
string ENCRYPTION_STARTTLS
# 'tls'
string ENCRYPTION_SMTPS
# 'ssl'
string ICAL_METHOD_REQUEST
# 'REQUEST'
string ICAL_METHOD_PUBLISH
# 'PUBLISH'
string ICAL_METHOD_REPLY
# 'REPLY'
string ICAL_METHOD_ADD
# 'ADD'
string ICAL_METHOD_CANCEL
# 'CANCEL'
string ICAL_METHOD_REFRESH
# 'REFRESH'
string ICAL_METHOD_COUNTER
# 'COUNTER'
string ICAL_METHOD_DECLINECOUNTER
# 'DECLINECOUNTER'
string VERSION

The PHPMailer Version number.

The PHPMailer Version number.

# '6.4.1'
integer STOP_MESSAGE

Error severity: message only, continue processing.

Error severity: message only, continue processing.

# 0
integer STOP_CONTINUE

Error severity: message, likely ok to continue processing.

Error severity: message, likely ok to continue processing.

# 1
integer STOP_CRITICAL

Error severity: message, plus full stop, critical error reached.

Error severity: message, plus full stop, critical error reached.

# 2
string CRLF

The SMTP standard CRLF line break. If you want to change line break format, change static::$LE, not this.

The SMTP standard CRLF line break. If you want to change line break format, change static::$LE, not this.

# "\r\n"
string FWS

"Folding White Space" a white space string used for line folding.

"Folding White Space" a white space string used for line folding.

# ' '
integer MAIL_MAX_LINE_LENGTH

The maximum line length supported by mail().

The maximum line length supported by mail().

Background: mail() will sometimes corrupt messages with headers headers longer than 65 chars, see #818.

# 63
integer MAX_LINE_LENGTH

The maximum line length allowed by RFC 2822 section 2.1.1.

The maximum line length allowed by RFC 2822 section 2.1.1.

# 998
integer STD_LINE_LENGTH

The lower maximum line length allowed by RFC 2822 section 2.1.1. This length does NOT include the line break 76 means that lines will be 77 or 78 chars depending on whether the line break format is LF or CRLF; both are valid.

The lower maximum line length allowed by RFC 2822 section 2.1.1. This length does NOT include the line break 76 means that lines will be 77 or 78 chars depending on whether the line break format is LF or CRLF; both are valid.

# 76
Properties summary
public integer|null $Priority

Email priority. Options: null (default), 1 = High, 3 = Normal, 5 = low. When null, the header is not set at all.

Email priority. Options: null (default), 1 = High, 3 = Normal, 5 = low. When null, the header is not set at all.

#
public string $CharSet

The character set of the message.

The character set of the message.

# self::CHARSET_ISO88591
public string $ContentType

The MIME Content-type of the message.

The MIME Content-type of the message.

# self::CONTENT_TYPE_PLAINTEXT
public string $Encoding

The message encoding. Options: "8bit", "7bit", "binary", "base64", and "quoted-printable".

The message encoding. Options: "8bit", "7bit", "binary", "base64", and "quoted-printable".

# self::ENCODING_8BIT
public string $ErrorInfo

Holds the most recent mailer error message.

Holds the most recent mailer error message.

# ''
public string $From

The From email address for the message.

The From email address for the message.

# 'root@localhost'
public string $FromName

The From name of the message.

The From name of the message.

# 'Root User'
public string $Sender

The envelope sender of the message. This will usually be turned into a Return-Path header by the receiver, and is the address that bounces will be sent to. If not empty, will be passed via -f to sendmail or as the 'MAIL FROM' value over SMTP.

The envelope sender of the message. This will usually be turned into a Return-Path header by the receiver, and is the address that bounces will be sent to. If not empty, will be passed via -f to sendmail or as the 'MAIL FROM' value over SMTP.

# ''
public string $Subject

The Subject of the message.

The Subject of the message.

# ''
public string $Body

An HTML or plain text message body. If HTML then call isHTML(true).

An HTML or plain text message body. If HTML then call isHTML(true).

# ''
public string $AltBody

The plain-text message body. This body can be read by mail clients that do not have HTML email capability such as mutt & Eudora. Clients that can read HTML will view the normal Body.

The plain-text message body. This body can be read by mail clients that do not have HTML email capability such as mutt & Eudora. Clients that can read HTML will view the normal Body.

# ''
public string $Ical

An iCal message part body. Only supported in simple alt or alt_inline message types To generate iCal event structures, use classes like EasyPeasyICS or iCalcreator.

An iCal message part body. Only supported in simple alt or alt_inline message types To generate iCal event structures, use classes like EasyPeasyICS or iCalcreator.

See

http://sprain.ch/blog/downloads/php-class-easypeasyics-create-ical-files-with-php/
http://kigkonsult.se/iCalcreator/
# ''
protected static string[] $IcalMethods

Value-array of "method" in Contenttype header "text/calendar"

Value-array of "method" in Contenttype header "text/calendar"

# [ self::ICAL_METHOD_REQUEST, self::ICAL_METHOD_PUBLISH, self::ICAL_METHOD_REPLY, self::ICAL_METHOD_ADD, self::ICAL_METHOD_CANCEL, self::ICAL_METHOD_REFRESH, self::ICAL_METHOD_COUNTER, self::ICAL_METHOD_DECLINECOUNTER, ]
protected string $MIMEBody

The complete compiled MIME message body.

The complete compiled MIME message body.

# ''
protected string $MIMEHeader

The complete compiled MIME message headers.

The complete compiled MIME message headers.

# ''
protected string $mailHeader

Extra headers that createHeader() doesn't fold in.

Extra headers that createHeader() doesn't fold in.

# ''
public integer $WordWrap

Word-wrap the message body to this number of chars. Set to 0 to not wrap. A useful value here is 78, for RFC2822 section 2.1.1 compliance.

Word-wrap the message body to this number of chars. Set to 0 to not wrap. A useful value here is 78, for RFC2822 section 2.1.1 compliance.

See

static::STD_LINE_LENGTH
# 0
public string $Mailer

Which method to use to send mail. Options: "mail", "sendmail", or "smtp".

Which method to use to send mail. Options: "mail", "sendmail", or "smtp".

# 'mail'
public string $Sendmail

The path to the sendmail program.

The path to the sendmail program.

# '/usr/sbin/sendmail'
public boolean $UseSendmailOptions

Whether mail() uses a fully sendmail-compatible MTA. One which supports sendmail's "-oi -f" options.

Whether mail() uses a fully sendmail-compatible MTA. One which supports sendmail's "-oi -f" options.

# true
public string $ConfirmReadingTo

The email address that a reading confirmation should be sent to, also known as read receipt.

The email address that a reading confirmation should be sent to, also known as read receipt.

# ''
public string $Hostname

The hostname to use in the Message-ID header and as default HELO string. If empty, PHPMailer attempts to find one with, in order, $_SERVER['SERVER_NAME'], gethostname(), php_uname('n'), or the value 'localhost.localdomain'.

The hostname to use in the Message-ID header and as default HELO string. If empty, PHPMailer attempts to find one with, in order, $_SERVER['SERVER_NAME'], gethostname(), php_uname('n'), or the value 'localhost.localdomain'.

See

PHPMailer::$Helo
# ''
public string $MessageID

An ID to be used in the Message-ID header. If empty, a unique id will be generated. You can set your own, but it must be in the format "<id@domain>", as defined in RFC5322 section 3.6.4 or it will be ignored.

An ID to be used in the Message-ID header. If empty, a unique id will be generated. You can set your own, but it must be in the format "<id@domain>", as defined in RFC5322 section 3.6.4 or it will be ignored.

See

https://tools.ietf.org/html/rfc5322#section-3.6.4
# ''
public string $MessageDate

The message Date to be used in the Date header. If empty, the current date will be added.

The message Date to be used in the Date header. If empty, the current date will be added.

# ''
public string $Host

SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host by using this format: [hostname:port] (e.g. "smtp1.example.com:25;smtp2.example.com"). You can also specify encryption type, for example: (e.g. "tls://smtp1.example.com:587;ssl://smtp2.example.com:465"). Hosts will be tried in order.

SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host by using this format: [hostname:port] (e.g. "smtp1.example.com:25;smtp2.example.com"). You can also specify encryption type, for example: (e.g. "tls://smtp1.example.com:587;ssl://smtp2.example.com:465"). Hosts will be tried in order.

# 'localhost'
public integer $Port

The default SMTP server port.

The default SMTP server port.

# 25
public string $Helo

The SMTP HELO/EHLO name used for the SMTP connection. Default is $Hostname. If $Hostname is empty, PHPMailer attempts to find one with the same method described above for $Hostname.

The SMTP HELO/EHLO name used for the SMTP connection. Default is $Hostname. If $Hostname is empty, PHPMailer attempts to find one with the same method described above for $Hostname.

See

PHPMailer::$Hostname
# ''
public string $SMTPSecure

What kind of encryption to use on the SMTP connection. Options: '', static::ENCRYPTION_STARTTLS, or static::ENCRYPTION_SMTPS.

What kind of encryption to use on the SMTP connection. Options: '', static::ENCRYPTION_STARTTLS, or static::ENCRYPTION_SMTPS.

# ''
public boolean $SMTPAutoTLS

Whether to enable TLS encryption automatically if a server supports it, even if SMTPSecure is not set to 'tls'. Be aware that in PHP >= 5.6 this requires that the server's certificates are valid.

Whether to enable TLS encryption automatically if a server supports it, even if SMTPSecure is not set to 'tls'. Be aware that in PHP >= 5.6 this requires that the server's certificates are valid.

# true
public boolean $SMTPAuth

Whether to use SMTP authentication. Uses the Username and Password properties.

Whether to use SMTP authentication. Uses the Username and Password properties.

See

PHPMailer::$Username
PHPMailer::$Password
# false
public array $SMTPOptions

Options array passed to stream_context_create when connecting via SMTP.

Options array passed to stream_context_create when connecting via SMTP.

# []
public string $Username

SMTP username.

SMTP username.

# ''
public string $Password

SMTP password.

SMTP password.

# ''
public string $AuthType

SMTP auth type. Options are CRAM-MD5, LOGIN, PLAIN, XOAUTH2, attempted in that order if not specified.

SMTP auth type. Options are CRAM-MD5, LOGIN, PLAIN, XOAUTH2, attempted in that order if not specified.

# ''
protected OAuth $oauth

An instance of the PHPMailer OAuth class.

An instance of the PHPMailer OAuth class.

#
public integer $Timeout

The SMTP server timeout in seconds. Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2.

The SMTP server timeout in seconds. Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2.

# 300
public string $dsn

Comma separated list of DSN notifications 'NEVER' under no circumstances a DSN must be returned to the sender. If you use NEVER all other notifications will be ignored. 'SUCCESS' will notify you when your mail has arrived at its destination. 'FAILURE' will arrive if an error occurred during delivery. 'DELAY' will notify you if there is an unusual delay in delivery, but the actual delivery's outcome (success or failure) is not yet decided.

Comma separated list of DSN notifications 'NEVER' under no circumstances a DSN must be returned to the sender. If you use NEVER all other notifications will be ignored. 'SUCCESS' will notify you when your mail has arrived at its destination. 'FAILURE' will arrive if an error occurred during delivery. 'DELAY' will notify you if there is an unusual delay in delivery, but the actual delivery's outcome (success or failure) is not yet decided.

See

https://tools.ietf.org/html/rfc3461 See section 4.1 for more information about NOTIFY
# ''
public integer $SMTPDebug

SMTP class debug output mode. Debug output level. Options:

SMTP class debug output mode. Debug output level. Options:

See

SMTP::DEBUG_OFF: No output
SMTP::DEBUG_CLIENT: Client messages
SMTP::DEBUG_SERVER: Client and server messages
SMTP::DEBUG_CONNECTION: As SERVER plus connection status
SMTP::DEBUG_LOWLEVEL: Noisy, low-level data output, rarely needed
SMTP::$do_debug
# 0
public string|callable|Psr\Log\LoggerInterface $Debugoutput

How to handle debug output. Options: * echo Output plain-text as-is, appropriate for CLI * html Output escaped, line breaks converted to <br>, appropriate for browser output * error_log Output to error log as configured in php.ini By default PHPMailer will use echo if run from a cli or cli-server SAPI, html otherwise. Alternatively, you can provide a callable expecting two params: a message string and the debug level:

How to handle debug output. Options: * echo Output plain-text as-is, appropriate for CLI * html Output escaped, line breaks converted to <br>, appropriate for browser output * error_log Output to error log as configured in php.ini By default PHPMailer will use echo if run from a cli or cli-server SAPI, html otherwise. Alternatively, you can provide a callable expecting two params: a message string and the debug level:

$mail->Debugoutput = function($str, $level) {echo "debug level $level; message: $str";};

Alternatively, you can pass in an instance of a PSR-3 compatible logger, though only debug level output is used:

$mail->Debugoutput = new myPsr3Logger;

See

SMTP::$Debugoutput
# 'echo'
public boolean $SMTPKeepAlive

Whether to keep SMTP connection open after each message. If this is set to true then to close the connection requires an explicit call to smtpClose().

Whether to keep SMTP connection open after each message. If this is set to true then to close the connection requires an explicit call to smtpClose().

# false
public boolean $SingleTo

Whether to split multiple to addresses into multiple messages or send them all in one message. Only supported in mail and sendmail transports, not in SMTP.

Whether to split multiple to addresses into multiple messages or send them all in one message. Only supported in mail and sendmail transports, not in SMTP.

Deprecated

6.0.0 PHPMailer isn't a mailing list manager!
# false
protected array $SingleToArray

Storage for addresses when SingleTo is enabled.

Storage for addresses when SingleTo is enabled.

# []
public boolean $do_verp

Whether to generate VERP addresses on send. Only applicable when sending via SMTP.

Whether to generate VERP addresses on send. Only applicable when sending via SMTP.

See

https://en.wikipedia.org/wiki/Variable_envelope_return_path
http://www.postfix.org/VERP_README.html Postfix VERP info
# false
public boolean $AllowEmpty

Whether to allow sending messages with an empty body.

Whether to allow sending messages with an empty body.

# false
public string $DKIM_selector

DKIM selector.

DKIM selector.

# ''
public string $DKIM_identity

DKIM Identity. Usually the email address used as the source of the email.

DKIM Identity. Usually the email address used as the source of the email.

# ''
public string $DKIM_passphrase

DKIM passphrase. Used if your key is encrypted.

DKIM passphrase. Used if your key is encrypted.

# ''
public string $DKIM_domain

DKIM signing domain name.

DKIM signing domain name.

Example

'example.com'
# ''
public boolean $DKIM_copyHeaderFields

DKIM Copy header field values for diagnostic use.

DKIM Copy header field values for diagnostic use.

# true
public array $DKIM_extraHeaders

DKIM Extra signing headers.

DKIM Extra signing headers.

Example

['List-Unsubscribe', 'List-Help']
# []
public string $DKIM_private

DKIM private key file path.

DKIM private key file path.

# ''
public string $DKIM_private_string

DKIM private key string.

DKIM private key string.

If set, takes precedence over $DKIM_private.

# ''
public string $action_function

Callback Action function name.

Callback Action function name.

The function that handles the result of the send email action. It is called out by send() for each email sent.

Value can be any php callable: http://www.php.net/is_callable

Parameters: bool $result result of the send action array $to email addresses of the recipients array $cc cc email addresses array $bcc bcc email addresses string $subject the subject string $body the email body string $from email address of sender string $extra extra information of possible use "smtp_transaction_id' => last smtp transaction id

# ''
public string|null $XMailer

What to put in the X-Mailer header. Options: An empty string for PHPMailer default, whitespace/null for none, or a string to use.

What to put in the X-Mailer header. Options: An empty string for PHPMailer default, whitespace/null for none, or a string to use.

# ''
public static string|callable $validator

Which validator to use by default when validating email addresses. May be a callable to inject your own validator, but there are several built-in validators. The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option.

Which validator to use by default when validating email addresses. May be a callable to inject your own validator, but there are several built-in validators. The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option.

See

PHPMailer::validateAddress()
# 'php'
protected PHPMailer\PHPMailer\SMTP $smtp

An instance of the SMTP sender class.

An instance of the SMTP sender class.

#
protected array $to

The array of 'to' names and addresses.

The array of 'to' names and addresses.

# []
protected array $cc

The array of 'cc' names and addresses.

The array of 'cc' names and addresses.

# []
protected array $bcc

The array of 'bcc' names and addresses.

The array of 'bcc' names and addresses.

# []
protected array $ReplyTo

The array of reply-to names and addresses.

The array of reply-to names and addresses.

# []
protected array $all_recipients

An array of all kinds of addresses. Includes all of $to, $cc, $bcc.

An array of all kinds of addresses. Includes all of $to, $cc, $bcc.

See

PHPMailer::$to
PHPMailer::$cc
PHPMailer::$bcc
# []
protected array $RecipientsQueue

An array of names and addresses queued for validation. In send(), valid and non duplicate entries are moved to $all_recipients and one of $to, $cc, or $bcc. This array is used only for addresses with IDN.

An array of names and addresses queued for validation. In send(), valid and non duplicate entries are moved to $all_recipients and one of $to, $cc, or $bcc. This array is used only for addresses with IDN.

See

PHPMailer::$to
PHPMailer::$cc
PHPMailer::$bcc
PHPMailer::$all_recipients
# []
protected array $ReplyToQueue

An array of reply-to names and addresses queued for validation. In send(), valid and non duplicate entries are moved to $ReplyTo. This array is used only for addresses with IDN.

An array of reply-to names and addresses queued for validation. In send(), valid and non duplicate entries are moved to $ReplyTo. This array is used only for addresses with IDN.

See

PHPMailer::$ReplyTo
# []
protected array $attachment

The array of attachments.

The array of attachments.

# []
protected array $CustomHeader

The array of custom headers.

The array of custom headers.

# []
protected string $lastMessageID

The most recent Message-ID (including angular brackets).

The most recent Message-ID (including angular brackets).

# ''
protected string $message_type

The message's MIME type.

The message's MIME type.

# ''
protected array $boundary

The array of MIME boundary strings.

The array of MIME boundary strings.

# []
protected array $language

The array of available languages.

The array of available languages.

# []
protected integer $error_count

The number of errors encountered.

The number of errors encountered.

# 0
protected string $sign_cert_file

The S/MIME certificate file path.

The S/MIME certificate file path.

# ''
protected string $sign_key_file

The S/MIME key file path.

The S/MIME key file path.

# ''
protected string $sign_extracerts_file

The optional S/MIME extra certificates ("CA Chain") file path.

The optional S/MIME extra certificates ("CA Chain") file path.

# ''
protected string $sign_key_pass

The S/MIME password for the key. Used only if the key is encrypted.

The S/MIME password for the key. Used only if the key is encrypted.

# ''
protected boolean $exceptions

Whether to throw exceptions for errors.

Whether to throw exceptions for errors.

# false
protected string $uniqueid

Unique ID used for message ID and boundaries.

Unique ID used for message ID and boundaries.

# ''
protected static string $LE

SMTP RFC standard line ending; Carriage Return, Line Feed.

SMTP RFC standard line ending; Carriage Return, Line Feed.

# self::CRLF
ZenphotoCMS 1.5.x API documentation generated by ApiGen