Jump to content
horst

WireMailSmtp

Recommended Posts

1 minute ago, adrian said:

Unfortunately this is probably a path to disaster these days - spam has made email painful and I think the only reliable option these days is to go with a transactional email service like MailGun, Postmark, SendInBlue etc. And be sure to spend the time to learn about and properly implement DKIM, SPF, and a DMARC policy.

ugh..ok.

but... it works fine from my localhost dev server though?!

Share this post


Link to post
Share on other sites
Just now, Jonathan Sachse Mikkelsen said:

ugh..ok.

but... it works fine from my localhost dev server though?!

I'll defer to horst on the troubleshooting of it actually sending. I am just talking about the deliverability issues you are likely to deal with. If the emails are only to site editors/staff you may be ok, but if they are being sent to site users then it's likely going to be an issue at least in my experience. Maybe others will disagree?

Share this post


Link to post
Share on other sites

pfffffff... ok everyone thanks for the replies!

but i think i just found the problem.

The client hadn't filled out the subject line field in the back-end, so i was trying to send emails with no subject lines.

so i guess all the send requests got filtered by a spam filter or something, or they were just invalid. But now they are being send.

Stupid mistake, which took way too many hours to correct! But that's web development for you i guess 😛 

  • Haha 1

Share this post


Link to post
Share on other sites

A great module that works absolutely fine out of the box but I am not happy having the SMTP password in plain text in the database. Is there maybe a reason I am just not getting why this is necessary?

  • Like 2

Share this post


Link to post
Share on other sites

Hi there,

I've been using Wire Mail for a while and now I would like to change its signature settings to send a signature along the email message "only when explicitly called via the API" (currently I have "automatically with every Message").

WireMail-signature-settings.png.a30ce971328a473dc13f39147919fcca.png

My questions are:

  1. How and where to call the signature API? That is, which code should I use and in which file should I add this code to have a "signature on demand"?
  2. I'm also using Form Builder and other PW modules that send emails with Wire Mail. How and where to set the signature via API for them, in particular for Form Builder?
  3. How to customise the signature if you don't want to use (and send) the Sender Signature set in Wire Mail module settings?

Share this post


Link to post
Share on other sites
On 3/3/2014 at 1:36 AM, horst said:

addSignature ( true | false ) - the default-behave is selectable in config screen, this can be overridden here
(only available if a signature is defined in the config screen)

Hi @LAPS,

current implementation only allows one signature, set in the config screen. The option only defines when it should be send: never everytime or defined via API.

Maybe it would be a nice addition to have a API method to pass in different signatures.

 

 

Edited by horst

Share this post


Link to post
Share on other sites

I've used this module a number of times and it works well. Now I am trying to use it in a multi-instance environment and am a bit stuck. Is this possible at all?

To explain: I have two sites (in a  PW multi-site setup - although I think the issue would be the same even if they were completely separate). "site" is a private admin site and "site-web" is a public website. "site-web" accesses "site" via an instance as described in https://processwire.com/blog/posts/multi-instance-pw3/.

"site" has a contact form which is accessed by "site-web" and has WireMailSmtp installed. When completed, an email is sent using $mail=wireMail(). This works fine when the public site is not a PW site. However, when it is a PW site (as "site-web" is), the context for WireMail is "site-web", not "site", so $mail returns a WireMail class, not a WireMailSmtp class. I cannot find a way to call WireMail in the right instance context. If I try and call WireMailSmtp directly, it is operating in the wrong context and fails.

I guess I could install a copy of WireMailSmtp on "site-web", but then I need to maintain the config on both sites. Besides it seems counter-intuitive that using a non-PW site for the public site should be easier than doing it in PW!

I'd be grateful for any ideas or insights.

Share this post


Link to post
Share on other sites

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 {
                $mail->to($to)
                    ->from($myemail)
                    ->subject($email_subject)
                    ->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:

<?php
	$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

My debuglog is shortified (see last line). What can I do to get the complete log?

array (size=1)
  'DEBUGLOG' => string '

Resolving SMTP server domain "smtp.mailtrap.io"...<br />
Connecting to SMTP server "34.192.182.255" port 587...<br />
Connected to SMTP server "smtp.mailtrap.io".<br />
S 220 mailtrap.io ESMTP ready<br />
C EHLO pw-basic.local<br />
S 250-mailtrap.io<br />
S 250-SIZE 5242880<br />
S 250-PIPELINING<br />
S 250-ENHANCEDSTATUSCODES<br />
S 250-8BITMIME<br />
S 250-DSN<br />
S 250-AUTH PLAIN LOGIN CRAM-MD5<br />
S 250 STARTTLS<br />
C MAIL FROM:<noreply@foo.bar><br />
C '... (length=625)

 

Share this post


Link to post
Share on other sites
2 hours ago, rjgamer said:

My debuglog is shortified (see last line). What can I do to get the complete log?

To be honest: I don't know. I don't know why you have this, and I don't know how to change this. 😞

Share this post


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

To be honest: I don't know. I don't know why you have this, and I don't know how to change this. 😞

Foud the solution:

ini_set("xdebug.var_display_max_children", '-1');
ini_set("xdebug.var_display_max_data", '-1');
ini_set("xdebug.var_display_max_depth", '-1');

Source: https://stackoverflow.com/a/34342948/2338829

  • Like 1

Share this post


Link to post
Share on other sites

Hi 

I can't get wiremail to work ..
Can you show me a solution
Thanks so much

 

array(1) 
{
  ["SETTINGS"]                       array(28) 
  {
    ["default_charset"]              string(5) "UTF-8"
    ["localhost"]                    string(23) "domain.com"
    ["smtp_host"]                    string(17) "smtp.xxxxxxxx.com"
    ["smtp_port"]                    int(587)
    ["smtp_ssl"]                     string(0) ""
    ["smtp_ssl_crypto_method"]       string(0) ""
    ["smtp_start_tls"]               int(1)
    ["smtp_tls_crypto_method"]       string(31) "STREAM_CRYPTO_METHOD_ANY_CLIENT"
    ["smtp_user"]                    string(25) "admin@domain.com"
    ["smtp_password"]                string(12) "RBxxxxxxxgEPlj"
    ["smtp_password2"]               string(0) ""
    ["clear_smtp_password"]          string(0) ""
    ["allow_without_authentication"] string(0) ""
    ["realm"]                        string(0) ""
    ["workstation"]                  string(0) ""
    ["authentication_mechanism"]     string(0) ""
    ["smtp_debug"]                   int(0)
    ["smtp_html_debug"]              int(0)
    ["sender_name"]                  string(16) "Vincenzo xxxxxxx"
    ["sender_email"]                 string(25) "admin@domain.com"
    ["sender_reply"]                 string(0) ""
    ["sender_errors_to"]             string(0) ""
    ["sender_signature"]             string(0) ""
    ["sender_signature_html"]        string(0) ""
    ["send_sender_signature"]        string(1) "1"
    ["extra_headers"]                array(0) 
    {
    }
    ["valid_recipients"]             array(0) 
    {
    }
    ["smtp_certificate"]             string(0) ""
  }
}
array(1) 
{
  ["RESULT"]             array(5) 
  {
    ["subject"]          string(14) "Debug Testmail"
    ["addSignature"]     string(1) "0"
    ["textbody"]         string(39) "This is a test message"
    ["recipients"]       array(1) 
    {
      [0]                array(3) 
      {
        ["emailaddress"] string(24) "angelo.xxxxxxxx@email.com"
        ["name"]         string(0) ""
        ["type"]         string(2) "to"
      }
    }
    ["send"]             string(0) ""
  }
}
array(1) 
{
  ["ERRORS"] array(1) 
  {
    [0]      string(69) "could not connect to the host "smtp.xxxxxxx.com": Connection refused"
  }
}
array(1) 
{
  ["DEBUGLOG"] string(144) "

Resolving SMTP server domain "smtp.xxxxx.com"...
Connecting to SMTP server "smtp.xxxxxx.com" port 587...
"
}

Share this post


Link to post
Share on other sites

Dear friends,
the failure of the module depends on the hosting (godaddy). Below is the question solved ..
 
Sending emails through other providers in Godaddy is not allowed, so you need to use the following settings:

Port: 25
SMTP authentication: False or None
SSL or secure connection: None
Server or Host: The relay server to use depends on the type of hosting and script you use. What type is my hosting account?

Linux (cPanel)
Use localhost, unless:

You use a PHP script and the mail () function.
You use a Perl script and the binary / usr / lib / sendmail.
In these cases, you will not need to specify any relay servers.

 

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 FireWire
      Hello community!

      I want to share a new module I've been working on that I think could be a big boost for multi-language ProcessWire sites.

      Some background, I was looking for a way for our company website to be efficiently translated as working with human translators was pretty laborious and a lack of updating content created a divergence between languages. I, and several other devs here, have talked about translation integrations and have recognized the power that DeepL has. DeepL is an AI deep learning powered service that delivers translation quality beyond any automated service available. After access to the API was opened up to the US, I built Fluency, a DeepL translation integration for ProcessWire.
      Fluency brings automated translation to every multi-language field in the admin, and also provides a translation tool allowing the user to translate their text to any language without it being inside a template's field. With Fluency you can:
      Translate any plain textarea or text input Translate any CKEditor content (yes, with markup) Translate page names for fully localized URLs on every page Translate your in-template translation function wrapped strings Translate modules DeepL offers translations to the following languages: English (US), English (UK), German, French, Spanish, Portuguese (EU), Portuguese (Brazil, Italian, Dutch, Polish, Russian, Japanese, Chinese (Simplified)
      Installation and usage is completely plug and play. Whether you're building a new multi-language site, need to update a site to multi-language, or simply want to stop manually translating a site and make any language a one-click deal, it could not be easier to do it. Fluency works by having you match the languages configured in ProcessWIre to DeepL's. You can have your site translating to any or all of the languages DeepL translates to in minutes (quite literally).
      Let's break out the screenshots...
      When the default language tab is shown, a message is displayed to let users know that translation is available. Clicking on each tab shows a link that says "Translate from English". Clicking it shows an animated overlay with the word "Translating..." cycling through each language and a light gradient shift. Have a CKEditor field? All good. Fluency will translated it and use DeepL's ability to translate text within HTML tags. CKEditor fields can be translated as easily and accurately as text/textarea fields.

      Repeaters and AJAX created fields also have translation enabled thanks to a JavaScript MutationObserver that searches for multi-language fields and adds translation as they're inserted into the DOM. If there's a multi-language field on the page, it will have translation added.

      Same goes for image description fields. Multi-language SEO friendly images are good to go.

      Creating a new page from one of your templates? Translate your title, and also translate your page name for native language URLs. (Not available for Russian, Chinese, or Japanese languages due to URL limitations). These can be changed in the "Settings" tab for any page as well so whether you're translating new pages or existing pages, you control the URLs everywhere.

      Language configuration pages are no different. Translate the names of your languages and search for both Site Translation Files (including all of your modules)

      Translate all of the static text in your templates as well. Notice that the placeholders are retained. DeepL is pretty good at recognizing and keeping non-translatable strings like that. If it is changed, it's easy to fix manually.

      Fluency adds a "Translate" item to the CMS header. When clicked this opens up a modal with a full translation tool that lets the user translate any language to any language. No need to leave the admin if you need to translate content from a secondary language back to the default ProcessWire language. There is also a button to get the current API usage statistics. DeepL account owners can set billing limitations via character count to control costs. This may help larger sites or sites being retrofitted keep an eye on their usage. This tool is available for all users with the page-edit permission.

      It couldn't be easier to add Fluency to your new or existing website. Simply add your API key and you're shown what languages are currently available for translation from/to as provided by DeepL. This list and all configuration options are taken live from the API so when DeepL releases new languages you can add them to your site without any work. No module updates, just an easy configuration. Just match the language you configured in ProcessWire to the DeepL language you want it to be associated with and you're done. Fluency also allows you to create a list of words/phrases that will not be translated which can prevent items such as brands and company names from being translated when they shouldn't

       
      Limitations:
      No "translate page" - Translating multiple fields can be done by clicking multiple translation links on multiple fields at once but engineering a "one click page translate" is not feasible from a user experience standpoint. The time it takes to translate one field can be a second or two, but cumulatively that may take much longer (CKEditor fields are slower than plain text fields). There may be a workaround in the future but it isn't currently on the roadmap. No "translate site" - Same thing goes for translating an entire website at once. It would be great, but it would be a very intense process and take a very (very) long time. There may be a workaround in the future but it isn't on the roadmap. No current support for Inline CKEditor fields - Handling for CKEditor on-demand hasn't been implemented yet, this is planned for a future release though and can be done. I just forgot about it because I've never really used that feature personally.. Alpha release - This module is in alpha. Releases should be stable and usable, but there may be edge case issues. Test the module thoroughly and please report any bugs via a Gitlab issue on the repository or respond here. Please note that the browser plugin for Grammarly conflicts with Fluency (as it does with many web applications). To address this issue it is recommended that you disable Grammarly when using Fluency, or open the admin to edit pages in a private window where Grammarly may not be loaded. This is an issue that may not have a resolution as creating a workaround may not be possible. If you have insight as to how this may be solved please visit the Gitlab page and file a bugfix ticket.
      Requirements:
      ProcessWire  3.0+ UIKit Admin Theme That's Fluency in a nutshell. A core effort in this module is to create it so that there is nothing DeepL related hard-coded in that would require updating it when DeepL offers new languages. I would like this to be a future-friendly module that doesn't require developer work to keep it up-to-date.
      It's Free
      This is my first real module and I want to give it back to the community as thanks. This is the best CMS I've worked with (thank you Ryan & contributors) and a great community (thank you dear reader). The only cost to use this is a subscription fee for the DeepL Pro API. Find out more and sign up here.
      Download & Feedback
      Download the latest version here
      https://gitlab.com/SkyLundy/fluency-processwire/-/archive/master/fluency-processwire-master.zip
      Gitlab repository:
      https://gitlab.com/SkyLundy/fluency-processwire
      File issues and feature requests here (your feedback and testing is greatly appreciated):
      https://gitlab.com/SkyLundy/fluency-processwire/-/issues
       
      Thank you! ¡Gracias! Ich danke Ihnen! Merci! Obrigado! Grazie! Dank u wel! Dziękuję! Спасибо! ありがとうございます! 谢谢你!

    • By horst
      ---------------------------------------------------------------------------------------------------------------------------------
        when working with PW version 2.6+, please use Pim2, not Pim!
        read more here  on how to change from the older to the newer version in existing sites
      ---------------------------------------------------------------------------------------------------------------------------------
      PageImage Manipulator, API for version 1 & 2

      The Page Image Manipulator is a module that let you in a first place do ImageManipulations with your PageImages. - And in a second place there is the possibility to let it work on any imagefile that exists in your servers filesystem, regardless if it is a 'known PW-image'.

      The Page Image Manipulator is a Toolbox for Users and Moduledevelopers. It is written to be as close to the Core ImageSizer as possible. Besides the GD-filterfunctions it contains resize, crop, canvas, rotate, flip, sharpen, unsharpMask and 3 watermark methods.



      How does it work?

      You can enter the ImageManipulator by calling the method pim2Load(). After that you can chain together how many actions in what ever order you like. If your manipulation is finished, you call pimSave() to write the memory Image into a diskfile. pimSave() returns the PageImage-Object of the new written file so we are able to further use any known PW-image property or method. This way it integrates best into the ProcessWire flow.

      The three examples above put out the same visual result: a grayscale image with a width of 240px. Only the filenames will slightly differ.

      You have to define a name-prefix that you pass with the pimLoad() method. If the file with that prefix already exists, all operations are skipped and only the desired PageImage-Object gets returned by pimSave(). If you want to force recreation of the file, you can pass as second param a boolean true: pim2Load('myPrefix', true).

      You may also want to get rid of all variations at once? Than you can call $pageimage->pim2Load('myPrefix')->removePimVariations()!

      A complete list of all methods and actions are at the end of this post.
       
      You may also visit the post with tips & examples for users and module developers.


      How to Install
      Download the module Place the module files in /site/modules/PageImageManipulator/ In your admin, click Modules > Check for new modules Click "install" for PageImageManipulator Done! There are no configuration settings needed, just install and use it. Download    (version 0.2.0)
      get it from the Modules Directory History of origins

      http://processwire.com/talk/topic/3278-core-imagemanipulation/


      ----------------------------------------------------------------------------------------------------------


      Page Image Manipulator - Methods

      * pimLoad  or  pim2Load, depends on the version you use!

      pimLoad($prefix, $param2=optional, $param3=optional)
      param 1: $prefix - (string) = mandatory! param 2: mixed, $forceRecreation or $options param 3: mixed, $forceRecreation or $options return: pim - (class handle) $options - (array) default is empty, see the next method for a list of valid options! $forceRecreation - (bool) default is false It check if the desired image variation exists, if not or if forceRecreation is set to true, it prepares all settings to get ready for image manipulation
      -------------------------------------------------------------------

      * setOptions

      setOptions(array $options)
      param: $options - (array) default is empty return: pim - (class handle) Takes an array with any number valid options / properties and set them by replacing the class-defaults and / or the global config defaults optionally set in the site/config.php under imageSizerOptions or imageManipulatorOptions.

      valid options are:
      quality = 1 - 100 (integer) upscaling = true | false (boolean) cropping = true | false (boolean) autoRotation =true | false (boolean) sharpening = 'none' | 'soft' | 'medium' | 'strong' (string) bgcolor = (array) css rgb or css rgba, first three values are integer 0-255 and optional 4 value is float 0-1, - default is array(255,255,255,0) thumbnailColorizeCustom = (array) rgb with values for colorize, integer -255 - 255 (this can be used to set a custom color when working together with Thumbnails-Module)
        outputFormat = 'gif' | 'jpg' | 'png' (Attention: outputFormat cannot be specified as global option in $config->imageManipulatorOptions!) set {singleOption} ($value)
      For every valid option there is also a single method that you can call, like setQuality(90), setUpscaling(false), etc.
      -------------------------------------------------------------------

      * pimSave

      pimSave()
      return: PageImage-Object If a new image is hold in memory, it saves the current content into a diskfile, according to the settings of filename, imagetype, targetFilename and outputFormat. Returns a PageImage-Object!
      -------------------------------------------------------------------

      * release

      release()
      return: void (nothing) if you, for what ever reason, first load image into memory but than do not save it, you should call release() to do the dishes! 😉 If you use pimSave() to leave the ImageManipulator, release() is called automatically.
      -------------------------------------------------------------------

      * getOptions

      getOptions()
      return: associative array with all final option values example:
      ["autoRotation"] bool(true) ["upscaling"] bool(false) ["cropping"] bool(true) ["quality"] int(90) ["sharpening"] string(6) "medium" ["targetFilename"] string(96) "/htdocs/site/assets/files/1124/pim_prefix_filename.jpg" ["outputFormat"] string(3) "jpg" get {singleOption} ()
      For every valid option there is also a single method that you can call, like getQuality(), getUpscaling(), etc. See method setOptions for a list of valid options!
      -------------------------------------------------------------------

      * getImageInfo

      getImageInfo()
      return: associative array with useful informations of source imagefile example:
      ["type"] string(3) "jpg" ["imageType"] int(2) ["mimetype"] string(10) "image/jpeg" ["width"] int(500) ["height"] int(331) ["landscape"] bool(true) ["ratio"] float(1.5105740181269) ["bits"] int(8) ["channels"] int(3) ["colspace"] string(9) "DeviceRGB" -------------------------------------------------------------------

      * getPimVariations

      getPimVariations()
      return: array of Pageimages Collect all pimVariations of this Pageimage as a Pageimages array of Pageimage objects. All variations created by the core ImageSizer are not included in the collection.
      -------------------------------------------------------------------

      * removePimVariations

      removePimVariations()
      return: pim - (class handle) Removes all image variations that was created using the PIM, all variations that are created by the core ImageSizer are left untouched!
      -------------------------------------------------------------------
      * width

      width($dst_width, $sharpen_mode=null)
      param: $dst_width - (integer) param: $auto_sharpen - (boolean) default is true was deleted with version 0.0.8, - sorry for breaking compatibility param: $sharpen_mode - (string) possible: 'none' | 'soft' | 'medium' | 'strong', default is 'soft' return: pim - (class handle) Is a call to resize where you prioritize the width, like with pageimage. Additionally, after resizing, an automatic sharpening can be done with one of the three modes.
      -------------------------------------------------------------------

      * height

      height($dst_height, $sharpen_mode=null)
      param: $dst_height - (integer) param: $auto_sharpen - (boolean) default is true was deleted with version 0.0.8, - sorry for breaking compatibility param: $sharpen_mode - (string) possible: 'none' | 'soft' | 'medium' | 'strong', default is 'soft' return: pim - (class handle) Is a call to resize where you prioritize the height, like with pageimage. Additionally, after resizing, an automatic sharpening can be done with one of the three modes.
      -------------------------------------------------------------------

      * resize

      resize($dst_width=0, $dst_height=0, $sharpen_mode=null)
      param: $dst_width - (integer) default is 0 param: $dst_height - (integer) default is 0 param: $auto_sharpen - (boolean) default is true was deleted with version 0.0.8, - sorry for breaking compatibility param: $sharpen_mode - (string) possible: 'none' | 'soft' | 'medium' | 'strong', default is 'soft' return: pim - (class handle) Is a call to resize where you have to set width and / or height, like with pageimage size(). Additionally, after resizing, an automatic sharpening can be done with one of the three modes.
      -------------------------------------------------------------------

      * stepResize

      stepResize($dst_width=0, $dst_height=0)
      param: $dst_width - (integer) default is 0 param: $dst_height - (integer) default is 0 return: pim - (class handle) this performs a resizing but with multiple little steps, each step followed by a soft sharpening. That way you can get better result of sharpened images.
      -------------------------------------------------------------------

      * sharpen

      sharpen($mode='soft')
      param: $mode - (string) possible values 'none' | 'soft'| 'medium'| 'strong' return: pim - (class handle) Applys sharpening to the current memory image. You can call it with one of the three predefined pattern, or you can pass an array with your own pattern.
      -------------------------------------------------------------------

      * unsharpMask

      unsharpMask($amount, $radius, $threshold)
      param: $amount - (integer) 0 - 500, default is 100 param: $radius - (float) 0.1 - 50, default is 0.5 param: $threshold - (integer) 0 - 255, default is 3 return: pim - (class handle) Applys sharpening to the current memory image like the equal named filter in photoshop.
      Credit for the used unsharp mask algorithm goes to Torstein Hønsi who has created the function back in 2003.
      -------------------------------------------------------------------

      * smooth

      smooth($level=127)
      param: $level - (integer) 1 - 255, default is 127 return: pim - (class handle) Smooth is the opposite of sharpen. You can define how strong it should be applied, 1 is low and 255 is strong.
      -------------------------------------------------------------------

      * blur

      blur()
      return: pim - (class handle) Blur is like smooth, but cannot called with a value. It seems to be similar like a result of smooth with a value greater than 200.
      -------------------------------------------------------------------

      * crop

      crop($pos_x, $pos_y, $width, $height)
      param: $pos_x - (integer) start position left param: $pos_y - (integer) start position top param: $width - (integer) horizontal length of desired image part param: $height - (integer) vertical length of desired image part return: pim - (class handle) This method cut out a part of the memory image.
      -------------------------------------------------------------------

      * canvas

      canvas($width, $height, $bgcolor, $position, $padding)
      param: $width = mixed, associative array with options or integer, - mandatory! param: $height = integer, - mandatory if $width is integer! param: $bgcolor = array with rgb or rgba, - default is array(255, 255, 255, 0) param: $position = one out of north, northwest, center, etc, - default is center param: $padding = integer as percent of canvas length, - default is 0 return: pim - (class handle) This method creates a canvas according to the given width and height and position the memory image onto it.
      You can pass an associative options array as the first and only param. With it you have to set width and height and optionally any other valid param. Or you have to set at least width and height as integers.
      Hint: If you want use transparency with rgba and your sourceImage isn't of type PNG, you have to define 'png' as outputFormat with your initially options array or, for example, like this: $image->pimLoad('prefix')->setOutputFormat('png')->canvas(300, 300, array(210,233,238,0.5), 'c', 5)->pimSave()
      -------------------------------------------------------------------

      * flip

      flip($vertical=false)
      param: $vertical - (boolean) default is false return: pim - (class handle) This flips the image horizontal by default. (mirroring)
      If the boolean param is set to true, it flips the image vertical instead.
      -------------------------------------------------------------------

      * rotate

      rotate($degree, $backgroundColor=127)
      param: $degree - (integer) valid is -360 0 360 param: $backgroundColor - (integer) valid is 0 - 255, default is 127 return: pim - (class handle) This rotates the image. Positive values for degree rotates clockwise, negative values counter clockwise. If you use other values than 90, 180, 270, the additional space gets filled with the defined background color.
      -------------------------------------------------------------------

      * brightness

      brightness($level)
      param: $level - (integer) -255 0 255 return: pim - (class handle) You can adjust brightness by defining a value between -255 and +255. Zero lets it unchanged, negative values results in darker images and positive values in lighter images.
      -------------------------------------------------------------------

      * contrast

      contrast($level)
      param: $level - (integer) -255 0 255 return: pim - (class handle) You can adjust contrast by defining a value between -255 and +255. Zero lets it unchanged, negative values results in lesser contrast and positive values in higher contrast.
      -------------------------------------------------------------------

      * grayscale

      grayscale()
      return: pim - (class handle) Turns an image into grayscale. Remove all colors.
      -------------------------------------------------------------------

      * sepia

      sepia()
      return: pim - (class handle) Turns the memory image into a colorized grayscale image with a predefined rgb-color that is known as "sepia".
      -------------------------------------------------------------------

      * colorize

      colorize($anyColor)
      param: $anyColor - (array) like css rgb or css rgba - but with values for rgb -255 - +255,  - value for alpha is float 0 - 1, 0 = transparent  1 = opaque return: pim - (class handle) Here you can adjust each of the RGB colors and optionally the alpha channel. Zero lets the channel unchanged whereas negative values results in lesser / darker parts of that channel and higher values in stronger saturisation of that channel.
      -------------------------------------------------------------------

      * negate

      negate()
      return: pim - (class handle) Turns an image into a "negative".
      -------------------------------------------------------------------

      * pixelate

      pixelate($blockSize=3)
      param: $blockSize - (integer) 1 - ??, default is 3 return: pim - (class handle) This apply the well known PixelLook to the memory image. It is stronger with higher values for blockSize.
      -------------------------------------------------------------------

      * emboss

      emboss()
      return: pim - (class handle) This apply the emboss effect to the memory image.
      -------------------------------------------------------------------

      * edgedetect

      edgedetect()
      return: pim - (class handle) This apply the edge-detect effect to the memory image.
      -------------------------------------------------------------------

      * getMemoryImage

      getMemoryImage()
      return: memoryimage - (GD-Resource) If you want apply something that isn't available with that class, you simply can check out the current memory image and apply your image - voodoo - stuff
      -------------------------------------------------------------------

      * setMemoryImage

      setMemoryImage($memoryImage)
      param: $memoryImage - (GD-Resource) return: pim - (class handle) If you are ready with your own image stuff, you can check in the memory image for further use with the class.
      -------------------------------------------------------------------

      * watermarkLogo

      watermarkLogo($pngAlphaImage, $position='center', $padding=2)
      param: $pngAlphaImage - mixed [systemfilepath or PageImageObject] to/from a PNG with transparency param: $position - (string) is one out of: N, E, S, W, C, NE, SE, SW, NW,
      - or: north, east, south, west, center, northeast, southeast, southwest, northwest
      default is 'center' param: $padding - (integer) 0 - 25, default is 5, padding to the borders in percent of the images length! return: pim - (class handle) You can pass a transparent image with its filename or as a PageImage to the method. If the watermark is bigger than the destination-image, it gets shrinked to fit into the targetimage. If it is a small watermark image you can define the position of it:
      NW - N - NE | | | W - C - E | | | SW - S - SE  
      The easiest and best way I have discovered to apply a big transparency watermark to an image is as follows:
      create a square transparent png image of e.g. 2000 x 2000 px, place your mark into the center with enough (percent) of space to the borders. You can see an example here! The $pngAlphaImage get centered and shrinked to fit into the memory image. No hassle with what width and / or height should I use?, how many space for the borders?, etc.
      -------------------------------------------------------------------

      * watermarkLogoTiled

      watermarkLogoTiled($pngAlphaImage)
      param: $pngAlphaImage - mixed [systemfilepath or PageImageObject] to/from a PNG with transparency return: pim - (class handle) Here you have to pass a tile png with transparency (e.g. something between 150-300 px?) to your bigger images. It got repeated all over the memory image starting at the top left corner.
      -------------------------------------------------------------------

      * watermarkText

      watermarkText($text, $size=10, $position='center', $padding=2, $opacity=50, $trueTypeFont=null)
      param: $text - (string) the text that you want to display on the image param: $size - (integer) 1 - 100, unit = points, good value seems to be around 10 to 15 param: $position - (string) is one out of: N, E, S, W, C, NE, SE, SW, NW,
      - or: north, east, south, west, center, northeast, southeast, southwest, northwest
      default is 'center' param: $padding - (integer) 0 - 25, default is 2, padding to the borders in percent of the images length! param: $opacity- (integer) 1 - 100, default is 50 param: $trueTypeFont - (string) systemfilepath to a TrueTypeFont, default is freesansbold.ttf (is GPL & comes with the module) return: pim - (class handle) Here you can display (dynamic) text with transparency over the memory image. You have to define your text, and optionally size, position, padding, opacity for it. And if you don't like the default font, freesansbold, you have to point to a TrueTypeFont-File of your choice.
      Please have a look to example output: http://processwire.com/talk/topic/4264-release-page-image-manipulator/page-2#entry41989
      -------------------------------------------------------------------





      PageImage Manipulator - Example Output


    • By d'Hinnisdaël
      Format Datetime fields as Carbon instances.
      You can find the latest release and the complete readme on Github.
      Installation
      composer require daun/datetime-carbon-format Usage
      All Datetime fields will now be formatted as Carbon instances instead of strings. Some examples:
      // $page->date is a Datetime field // Output format: j/n/Y echo $page->date; // 20/10/2020 echo $page->date->add('7 days'); // 27/10/2020 echo $page->date->format('l, F j'); // Monday, October 20 echo $page->date->year; // 2020 echo $page->date->diffForHumans(); // 28 minutes ago Frontend only
      The ProcessWire admin seems to expect datetime fields to be strings. This module will only return Carbon instances on frontend page views.
      Date output format
      When casting a Carbon instance to a string (usually when outputting the field in a template), the field's date output format will be respected.
      Links
      GitHub • Readme • Carbon docs
       
       
      PS. I remember reading about a Carbon module in a recent newsletter, but couldn't find it anywhere. Was that you, @bernhard?
    • By MoritzLost
      TrelloWire
      This is a module that allows you to automatically create Trello cards for ProcessWire pages and update them when the pages are updated. This allows you to setup connected workflows. Card properties and change handling behaviour can be customized through the extensive module configuration. Every action the module performs is hookable, so you can modify when and how cards are created as much as you need to. The module also contains an API-component that makes it easy to make requests to the Trello API and build your own connected ProcessWire-Trello workflows.
      Warning: This module requires ProcessWire 3.0.167 which is above the current stable master release at the moment.
      Features
      All the things the module can do for you without any custom code: Create a new card on Trello whenever a page is added or published (you can select applicable templates). Configure the target board, target list, name and description for new cards. Add default labels and checklists to the card. Update the card whenever the page is updated (optional). When the status of the card changes (published / unpublished, hidden / unhidden, trashed / restored or deleted), move the card to a different list or archive or delete it (configurable). You can extend this through hooks in many ways: Modifiy when and how cards are created. Modify the card properties (Target board & list, title, description, et c.) before they are sent to Trello. Create your own workflows by utilizing an API helper class with many convenient utility methods to access the Trello API directly. Feedback & Future Plans
      Let me know what you think! In particular:
      If you find any bugs report them here or on Github, I'll try to fix them. This module was born out of a use-case for a client project where we manage new form submissions through Trello. I'm not sure how many use-cases there are for this module. If you do use it, tell me about it! The Trello API is pretty extensive, I'll try to add some more helper methods to the TrelloWireApi class (let me know if you need anything in particular). I'll think about how the module can support different workflows that include Twig – talk to me if you have a use-case! Next steps could be a dashboard to manage pages that are connected to a Trello card, or a new section in the settings tab to manage the Trello connection. But it depends on whether there is any interest in this 🙂 Links
      Repository on Github Complete module documentation (getting started, configuration & API documentation) TrelloWire in the modules directory Module configuration

×
×
  • Create New...