ProMailerEmail class

Located in file /site/modules/ProMailer/ProMailerEmail.php

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the ProMailerEmail class also inherits all the methods and properties of: ProMailerTypeManager and Wire.

Show class?             Show args?        

Common

NameReturnSummary 
ProMailerEmail::emailInDomain(string $email, $domain)
boolIs the given email in the given domain (or host)? 
ProMailerEmail::getDefaultEmailPage()
Page NullPageGet the default email template page 
ProMailerEmail::getMailer()
WireMailGet WireMail module
ProMailerEmail::install()
(nothing) 
ProMailerEmail::markupToText(string $markup)
stringConvert markup to text using best available method
ProMailerEmail::parseEmail(string $email)
arrayGet all the parts of an email address 
ProMailerEmail::populateConditionals(string $body, array $data)
stringPopulate conditional {tag} statements in $body according to $data 
ProMailerEmail::populatePlaceholders(string $body, array $data)
stringPopulate placeholders from $data in $body 
ProMailerEmail::renderMessageBody(ProMailerMessage $message, ProMailerSubscriber $subscriber)
stringRender message body for subscriber 
ProMailerEmail::saveLog(string $str)
(nothing)Save entry to sent email log 
ProMailerEmail::send(WireMail $mailer)
intSend a populated WireMail object 
ProMailerEmail::sendFail(string $email, WireMail $mailer, string $error)
(nothing)Hook called when message fails to send to subscriber
ProMailerEmail::sendMessage($message, $subscriber)
bool arraySend given message to given subscriber 
ProMailerEmail::sendReady(string $email, WireMail $mailer)
boolHook called when message ready to send to email
ProMailerEmail::sent(string $email, WireMail $mailer)
(nothing)Hook called after message has been sent to subscriber
ProMailerEmail::subscriberMessageFail(array $data)
(nothing)Message failed to send to subscriber
ProMailerEmail::subscriberMessageReady(array $data)
boolMessage ready to send to subscriber
ProMailerEmail::subscriberMessageSent(array $data)
(nothing)Message sent to subscriber
ProMailerEmail::table()
stringGet the DB table name used by this type 
ProMailerEmail::typeName()
stringGet the class name of the type this class manages 
ProMailerEmail::uninstall()
(nothing) 

Additional methods and properties

In addition to the methods and properties above, ProMailerEmail also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #553
    In the 553rd issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a new third party module called Text Synthesis, and more. Read on!
    Weekly.pw / 14 December 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer