Jump to content


Recommended Posts

Can you give concrete examples to the following?

Are you able, and if so, how do you create your instances instance_A and instance_B, and which one is called from where?

You have to be aware that WireMailSmtp supports PW Versions up from 2.4.1 until now. There wasn't any multi instance available and it can be that it is not easily possible to implement it into the module. But it can be possible to find a simple to use and easy to maintainable way. Therefor, I need to know how you are using it, how the code snippets look like.

Where is your instance_A, where your instance_B,

how do you create the second instance,

where and how do you call the wireMail object?


Share this post

Link to post
Share on other sites
14 minutes ago, horst said:

Where is your instance_A, where your instance_B,

In your terminology, lets say instance_B is "site" and instance_A is "site-web". Both sites sit under the same root, sharing the same wire/ (i.e. a multi-site installation).

17 minutes ago, horst said:

how do you create the second instance,

in _init.php (part of the template rendering) in instance_A:

$config->admin_site = new ProcessWire($config->paths->root . 'site/');

I use $config->admin_site so that it can be accessed anywhere (assuming the current context is instance_A).

20 minutes ago, horst said:

where and how do you call the wireMail object?

Ah, that's a bit (!) more complicated. Instance_A accesses a runtime markup field in instance_B thus:

$adminPage = $config->admin_site->pages->get("template=Availability, name=bawd-hall-availability");
$availabilityTable = $adminPage->runtime_markup_availability;

This field renders php in the file Availability.php, which lives in instance_B ("site")

Availability.php renders a form thus:

$out .= $config->admin_site->files->render($currentPath . 'booking_form.php');

where $currentPath is $files->currentPath(); - i.e. booking_form is a sibling of Availability. (BTW, Availability.php checks the host name in the headers to determine whether it is being called as a second instance or not).

booking_form's action is $_SERVER['REQUEST_URI'] (i.e. the original page, thus running Availability.php again). Availability.php tests (isset($_GET["submit"]) ) and if true processes the POST variables from the form. After validation, the mail is constructed from these variables with $mail = wireMail(); etc.

For more background (if you really want 😉 ) you can see here, where @kongondo was extremely helpful getting the RuntimeMarkup Fields module working in a multi-instance environment.

Share this post

Link to post
Share on other sites

@MarkE, it is not necessary for me to know what and which forms you are using and how you have organized this. 🙂

I only want to know where and how you call the WireMail object.

Is it in the runtime markup field? Where and how do you call it?


Share this post

Link to post
Share on other sites
13 minutes ago, horst said:

Is it in the runtime markup field?

Yes. The php for that field is Availability.php, which is in instance_B, and calls mail as described above. Not sure what more info you want re "where and how". Abbreviated code for this script is below:

<?php namespace ProcessWire;
$headers = getallheaders();
$permittedNonPW = array_map('trim', array_map('strip_tags', explode(',', $page->bodyTop)));
$permittedPW = array_map('trim', array_map('strip_tags', explode(',', $page->bodyFoot)));
// If site is a PW site, then need to deal with the different instances
if (in_array($headers['Host'], $permittedPW)) {
    $site = $config->admin_site;
    $config->sitePages = $config->admin_site->pages;
} else {
    $site = wire();
    $config->sitePages = $pages;
// Process any form results:
// define variables and set to empty values
$name = $email_address = $phone = $fromToDate = $adults = $children = $pets = $provbooking = $message = $spambot = "";
$fromerror = $toerror = $radioerror = $propertyName = "";

function test_input($data) {
    return $data;

if (isset($_GET["submit"])) {
    $out = '';
    if ($_SERVER["REQUEST_METHOD"] == "POST") {
        $propertyName = test_input($_POST["property"]);
        //...... //fill variables
            $mail = wireMail();
            if($mail->className != 'WireMailSmtp') {
                wire()->log->save('debug', 'Could not get the right WireMail-Module (WireMailSmtp); found: ' . $mail->className);
            } else {
                    ->bodyHTML($email_body_top . $email_body);
                $numsent = $mail->send();
                if ($numsent > 0) {
                        $out .= '<script>alert("Your request has been submitted - you should receive an automated email acknowledgement shortly.")</script>';
    $url = strtok($_SERVER['REQUEST_URI'], '?');
    $out .= '<script>window.location.assign("' . $url . '");</script>';
    return $out;
/////////////// MAIN PAGE ////////////////////
$currentPath = $files->currentPath();
$out = ... // Fills the availability table ...
////////////////////Don't forget the form itself//////////////////////////////
if (in_array($headers['Host'], $permittedPW)){
    wire()->log->save('debug', 'Calling booking form sitePages = ' . $config->sitePages->get('/')->title . ', $headers["Host"] is ' . $headers["Host"]);
    $out .= $config->admin_site->files->render($currentPath . 'booking_form.php');
} else {
    $out .= wire()->files->render($config->paths->templates . 'RuntimeMarkup/booking_form.php');
//////////////////FINALLY RETURN THE OUTPUT!!!///////////////////////////
return $out;

This works fine for $permittedNonPW but not for $permittedPW.

Share this post

Link to post
Share on other sites

Yep, there are these line(s):

if (isset($_GET["submit"])) {
            $mail = wireMail();

This is very unspecific. You need to call explicitly a WireMail object from your desired instance! For example, if you are starting in your admin_instance, how do you fetch up your website_instance? 

You need to check if you really have an own instance of your $website_instance in your $admin_instance. If yes, pick up the $website_instance at that point above in the code and call the mail function of that instance: https://processwire.com/api/ref/wire-mail-tools/

As pseudo code:

if (isset($_GET["submit"])) {
       $myMailHandler = $myWebsiteInstance->wire('mail');  // or something like that


Also, in your code above you are using and overwriting(!) the predefined $mail variable, what should be omitted. Instead use your own name for that special instance mailhandler.

Share this post

Link to post
Share on other sites

Sorry - I forgot to say that I had tried various other things, including your suggestion. I've now done those things again (with $mailOwner rather than $mail - I'd forgotten that was predefined) and recorded the error in each case. These are reproduced below as a pair of lines - code followed by error:

$mailOwner = $config->admin_site->wire('mail');
Could not get the right WireMail-Module (WireMailSmtp); found: WireMailTools [My debugging line]
$mailOwner = $config->admin_site->mail->new();
 require_once(./WireMailSmtpAdaptor.php): failed to open stream: No such file or directory in M:\laragon\www\BawdHall\site\assets\cache\FileCompiler\site\modules\WireMailSmtp\WireMailSmtp.module on line 290

The second of these seems to be calling the right module (WireMailSmtp) but can't find the file because $config is always for instance_A. This seems similar to the issue we had with Runtime Markup.

Share this post

Link to post
Share on other sites

Have you debugged $config->admin_site? What is it? Your PW instance object? What debug output does it show when you call $config->admin_site->wire('config')? Also I had understand that your WireMailSmtp is installed and configured in the website-instance, not the admin-instance? Can you clarify that, please?

Which instance is the current started (running)? I thought the admin_instance, is this right?

Where is the WireMailSmtp installed and configured? I thought in the website_instance, is this right?

Share this post

Link to post
Share on other sites
3 hours ago, horst said:

Have you debugged $config->admin_site? What is it? Your PW instance object?

Yes. It is used extensively elsewhere in Availability.php and works fine.

3 hours ago, horst said:

What debug output does it show when you call $config->admin_site->wire('config')?

Config ($config->admin_site outputs ProcessWire 3.0.153 dev #1)

3 hours ago, horst said:

Which instance is the current started (running)? I thought the admin_instance, is this right?

No the host page is in site-web, which I think you are calling website_instance.

3 hours ago, horst said:

Where is the WireMailSmtp installed and configured? I thought in the website_instance, is this right?

No. It is in admin_instance, where the runtime markup field with Availability.php is.

Share this post

Link to post
Share on other sites

I have a temporary work-round, although less than ideal. I capture the form details and save it as a page in admin_instance (that works fine, using $config->admin_site). Then a LazyCron in the admin site picks up new forms and sends the emails. (I tried to use a hook after Pages::added, but it seems that this is not triggered when the page is added from another instance.) When the LazyCron runs, it is of course running in the admin instance.

EDIT: Actually there are pros and cons of the work-round method, so I will stick with it for now. Thanks for the comments @horst.

  • Like 1

Share this post

Link to post
Share on other sites

I read through all 14 pages, hoping to find some solution to my problem.

I learned that I can no use my regular Gmail password, instead an App Password was generated for my account and I have that in place in the settings 😉 Thanks to whomever suggested that!

I've gone through and entered all relevant fields pertaining to using Googles Gmail SMTP for my localhost testing. This is being done on my laptop running Linux (PopOS).

smtp hostname = smtp.gmail.com
smtp port = 587
smtp user/password = my gmail credentials and the generated app password
start tls checked, use ssl checked

I submit/save settings but I see no where where it says "SUCCESS! SMTP settings appear to work correctly" 😞

I have the following in a template:

	$to = 'organizedfellow@gmail.com';
	$from = 'organizedfellow@gmail.com';
	$subject = 'email testes';
	$textBody = 'this is the body of the test email';

	$numSent = wireMail($to, $from, $subject, $textBody);


Share this post

Link to post
Share on other sites
13 hours ago, OrganizedFellow said:

start tls checked, use ssl checked

Not both! - either TLS or SSL

Share this post

Link to post
Share on other sites

hey @horst it's possible to override the smtp settings and use values on the fly while creating a wiremail instance? I have 3 different emails I need to use in my site. Thanks

Share this post

Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-07-03 -- SnipWire 0.8.7 (beta) released! Fixes some small bugs and adds an indicator for TEST mode 2020-04-06 -- SnipWire 0.8.6 (beta) released! Adds support for Snipcart subscriptions and also fixes some problems 2020-03-21 -- SnipWire 0.8.5 (beta) released! Improves SnipWires webhooks interface and provides some other fixes and additions 2020-03-03 -- SnipWire 0.8.4 (beta) released! Improves compatibility for Windows based Systems. 2020-03-01 -- SnipWire 0.8.3 (beta) released! The installation and uninstallation process has been heavily revised. 2020-02-08 -- SnipWire 0.8.2 (beta) released! Added a feature to change the cart and catalogue currency by GET, POST or SESSION param 2020-02-03 -- SnipWire 0.8.1 (beta) released! All custom classes moved into their own namespaces. 2020-02-01 -- SnipWire is now available via ProcessWire's module directory! 2020-01-30 -- SnipWire 0.8.0 (beta) first public release! (module just submitted to the PW modules directory) 2020-01-28 -- added Custom Order Fields feature (first SnipWire release version is near!) 2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Multi currency support Custom order and cart fields Process refunds and send customer notifications from within the ProcessWire backend Process Abandoned Carts + sending messages to customers from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  

      ---- INITIAL POST FROM 2019-05-25 ----
    • By Sten
      Till now I hacked something with the twig template but it works no more with new PW versions so I look forward to create a module. I am working on a site in multiple languages : French, English, Italian, German, Spanish, Portuguese, Hebrew, Russian. The new posts are entered in any language with a field for language. Till now, I got twig files to get the translations with constants defined for each part of the pages.
      So I'd like to create a module to include theses files added according to the url /fr/en/...
      Have you some observations to do before I begin about the direction to take ?
      Thank you
    • By ukyo
      Mystique Module for ProcessWire CMS/CMF
      Github repo : https://github.com/trk/Mystique
      Mystique module allow you to create dynamic fields and store dynamic fields data on database by using a config file.
      ProcessWire 3.0 or newer PHP 7.0 or newer FieldtypeMystique InputfieldMystique Installation
      Install the module from the modules directory:
      Via Composer:
      composer require trk/mystique Via git clone:
      cd your-processwire-project-folder/ cd site/modules/ git clone https://github.com/trk/Mystique.git Module in live reaction with your Mystique config file
      This mean if you remove a field from your config file, field will be removed from edit screen. As you see on youtube video.
      Using Mystique with your module or use different configs path, autoload need to be true for modules
      Default configs path is site/templates/configs/, and your config file name need to start with Mystique. and need to end with .php extension.
      Adding custom path not supporting anymore !
      // Add your custom path inside your module class`init` function, didn't tested outside public function init() { $path = __DIR__ . DIRECTORY_SEPARATOR . 'configs' . DIRECTORY_SEPARATOR; Mystique::add($path); } Mystique module will search site/modules/**/configs/Mystique.*.php and site/templates/Mystique.*.php paths for Mystique config files.
      All config files need to return a PHP ARRAY like examples.
      Usage almost same with ProcessWire Inputfield Api, only difference is set and showIf usage like on example.
      <?php namespace ProcessWire; /** * Resource : testing-mystique */ return [ 'title' => __('Testing Mystique'), 'fields' => [ 'text_field' => [ 'label' => __('You can use short named types'), 'description' => __('In file showIf working like example'), 'notes' => __('Also you can use $input->set() method'), 'type' => 'text', 'showIf' => [ 'another_text' => "=''" ], 'set' => [ 'showCount' => InputfieldText::showCountChars, 'maxlength' => 255 ], 'attr' => [ 'attr-foo' => 'bar', 'attr-bar' => 'foo' ] ], 'another_text' => [ 'label' => __('Another text field (default type is text)') ] ] ]; Example:
      site/templates/configs/Mystique.seo-fields.php <?php namespace ProcessWire; /** * Resource : seo-fields */ return [ 'title' => __('Seo fields'), 'fields' => [ 'window_title' => [ 'label' => __('Window title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'attr' => [ 'placeholder' => __('Enter a window title') ] ], 'navigation_title' => [ 'label' => __('Navigation title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'showIf' => [ 'window_title' => "!=''" ], 'attr' => [ 'placeholder' => __('Enter a navigation title') ] ], 'description' => [ 'label' => __('Description for search engines'), 'type' => Mystique::TEXTAREA, 'useLanguages' => true ], 'page_tpye' => [ 'label' => __('Type'), 'type' => Mystique::SELECT, 'options' => [ 'basic' => __('Basic page'), 'gallery' => __('Gallery'), 'blog' => __('Blog') ] ], 'show_on_nav' => [ 'label' => __('Display this page on navigation'), 'type' => Mystique::CHECKBOX ] ] ]; Searching data on Mystique field is limited. Because, Mystique saving data to database in json format. When you make search for Mystique field, operator not important. Operator will be changed with %= operator.
      Search example
      $navigationPages = pages()->find('my_mystique_field.show_on_nav=1'); $navigationPages = pages()->find('my_mystique_field.page_tpye=gallery');
    • By Robin S
      This is a module I made as an experiment a while ago and never got around to releasing publicly. At the time it was prompted by discussions around using Repeater fields for "page builder" purposes, where the depth feature could possibly be used for elements that would be nested inside other elements. I thought it would be useful to enforce some depth rules and translate the depth data into a multi-dimensional array structure.
      I'm not using this module anywhere myself but maybe it's useful to somebody.
      Repeater Depth Helper
      This module does two things relating to Repeater fields that have the "Item depth" option enabled:
      It enforces some depth rules for Repeater fields on save. Those rules are:
      The first item must have a depth of zero. Each item depth must not be more than one greater than previous item depth. It provides a RepeaterPageArray::getDepthStructure helper method that returns a nested depth structure for a Repeater field value.
      Helper method
      The module adds a RepeaterPageArray::getDepthStructure method that returns a multi-dimensional array where the key is the page ID and the value is an array of nested "child" items, or null if there are no nested children.

      The module doesn't make any assumptions about how you might want to use the depth structure array, but here is a way you might use it to output a nested unordered list.
      // Output a nested unordered list from a depth structure array function outputNestedList($depth_structure, $repeater_items) { $out = "<ul>"; foreach($depth_structure as $page_id => $nested_children) { $out .= "<li>" . $repeater_items->get("id=$page_id")->title; // Go recursive if there are nested children if(is_array($nested_children)) $out .= outputNestedList($nested_children, $repeater_items); $out .= "</li>"; } $out .= "</ul>"; return $out; } $repeater_items = $page->my_repeater; $depth_structure = $repeater_items->getDepthStructure(); echo outputNestedList($depth_structure, $repeater_items);
    • By MoritzLost
      Cacheable Placeholders
      This module allows you to have pieces of dynamic content inside cached output. This aims to solve the common problem of having a mostly cacheable site, but with pieces of dynamic output here and there.  Consider this simple example, where you want to output a custom greeting to the current user:
      <h1>Good morning, <?= ucfirst($user->name) ?></h1> This snippet means you can't use the template cache (at least for logged-in users), because each user has a different name. Even if 99% of your output is static, you can only cache the pieces that you know won't include this personal greeting. A more common example would be CSRF tokens for HTML forms - those need to be unique by definition, so you can't cache the form wholesale.
      This module solves this problem by introducing cacheable placeholders - small placeholder tokens that get replaced during every request. The replacement is done inside a Page::render hook so it runs during every request, even if the response is served from the template cache. So you can use something like this:
      <h1>Good morning, {{{greeting}}}</h1> Replacement tokens are defined with a callback function that produces the appropriate output and added to the module through a simple hook:
      // site/ready.php wire()->addHookAfter('CachePlaceholders::getTokens', function (HookEvent $e) { $tokens = $e->return; $tokens['greeting'] = [ 'callback' => function (array $tokenData) { return ucfirst(wire('user')->name); } ]; $e->return = $tokens; }); Tokens can also include parameters that are parsed and passed to the callback function. There are more fully annotated examples and step-by-step instructions in the README on Github!
      A simple and fast token parser that calls the appropriate callback and runs automatically. Tokens may include multiple named or positional parameters, as well as multi-value parameters. A manual mode that allows you to replace tokens in custom pieces of cached content (useful if you're using the $cache API). Some built-in tokens for common use-cases: CSRF-Tokens, replacing values from superglobals and producing random hexadecimal strings. The token format is completely customizable, all delimiters can be changed to avoid collisions with existing tag parsers or template languages. Links
      Github Repository & documentation Module directory If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
  • Create New...