PHPMailer SMTP - Add Ludwig integration

Hi @sajosh, thanks for your interest.

Composer is a very efficient tool for including external libraries and managing dependencies. As it is now the standard for Drupal, there are no plans to support other installation methods for this module.

You can try to hack something together yourself but it would be convoluted and hard to maintain.

Best practice would be to install composer on a local development environment, build the site locally then upload it to your shared hosting hosting platform.

The best practice is to use Ludwig for situations not supporting Composer. That would require a ludwig.json specifying the requirements. You can produce one based on composer. Maybe there are alternatives to this module that are prepared to support it.

Ludwig is an alternative. Useful, but not necessarily "best practice". I can look into it, however.

Maybe there are alternatives to this module that are prepared to support it.

Maybe there are, nobody's forced to use any specific module. The aim here is to have a very lean, single focus module with some advanced config options.

I don't use Ludwig but I'm willing to accept a patch. If one isn't forthcoming I'll have a go at creating a ludwig.json but I'll need to understand its limitations.

Does it require an exact version of the library? Do I need to create a "libraries" sub folder? What else should I be aware of?

Im my opinion it is best practice for situations not supporting the use of Composer. It definitely beats manually messing with your installation to get things working. That might have worked for D7, but D8 being based on composer makes that a lot more difficult.

Glad to hear you are willing to look into supporting those that can't use Composer. Haven't found a lot of information on producing a ludwig.json. Suggest to use Composer to assist you in creating one. Make a project with drupal/core and then require your module. Produce the ludwig.json based on the packages installed by that require. The information you need can be found in the composer.lock for each package installed. Suggest to use the distribution url, not the source. The structure is a 'require' with a list of packages, for each package its version and url. Similar to the repository structure.

Obviously, the user must adjust the ludwig.json to his situation. Ludwig won't assist them doing dependency management like Composer does.The versions of packages used are determined at that moment in time. It is a given that things change in time. You might want to remind them about that in your README.

Your ludwig.json should be:

{ "require": {
	"phpmailer/phpmailer": {
	       "version": "6.1.5",
                "url": "https://api.github.com/repos/PHPMailer/PHPMailer/zipball/a8bf068f64a580302026e484ee29511f661b2ad3"
	},
	"drupal/phpmailer_smtp": {
	       "version": "1.4.0",
	       "url": "https://ftp.drupal.org/files/projects/phpmailer_smtp-8.x-1.4.zip"
	}
  }
}

The module itself doesn't need to be in ludwig.json. Patch contains the below code. Please test and let me know if it works.

{
    "require": {
        "phpmailer/phpmailer": {
            "version": "v6.1.5",
            "url": "https://github.com/PHPMailer/PHPMailer/archive/v6.1.5.zip"
        }
    }
}

Thanks @sajosh and @mmjvb. This is now in the dev version.

#10

Right now i'm debugging why the views_send module isn't sending with phpmailer_smtp

Make sure the "Formatter" in "Mail System" is set to something which can handle attachments, such as MIME Mail.

@imclean Indeed my mistake, it is clearly documented only dependencies need to be required. Thanks for reporting.
@sajosh Thanks for confirmation and reporting the actions to be done.

Thanks for using and supporting Ludwig. With more than 5000 sites reporting that they are using Ludwig, consider it justified.

Can somebody make Ludwig work on phpmailer_smtp v 8.x-1.4 ?

Indeed, it should work for 8.x-1.4, however the ludwig.json needs to be created yourself. It is not part of that distribution.

This is included in 8.x-1.5.

@sajosh: I tried and it was succesfull!

Thanks a lot all, #10 (@sajosh) did it for me.
Only that for the current version (20201110, PHPMailer-6.1.7) I put the library files in modules/contrib/smtp/lib/phpmailer-phpmailer/^6.1.7

It should be smtp/lib/phpmailer-phpmailer/6.1.7
depending on the value of version in ludwig.json, which should not be ^6.1.7 but either 6.1.7 or v6.1.7

Actually, the only requirement is that the value of version is a valid folder name. Obviously, it is convenient to put the correct version in there. However, that is not a requirement. It is only used to find the dependency and detect it is there. As long as that folder is mentioned in version, ludwig is happy.

I'm hoping someone on here can help, I previously had this module set up using Ludwig and phpmailer v6.1.5 - After upgrading the SMTP module to v8.x-1.0 Drupal doesn't recognize the phpmailer v6.1.5 library - I can update it via Ludwig at /admin/reports/packages but then I get the following error:

Fatal error: require(): Failed opening required '/code/modules/smtp/lib/phpmailer-phpmailer/v6.1.5/src/SMTP.php' (include_path='/code/vendor/pear/archive_tar:/code/vendor/pear/console_getopt:/code/vendor/pear/pear-core-minimal/src:/code/vendor/pear/pear_exception:.:/usr/share/pear:/usr/share/php') in /code/vendor/symfony/class-loader/ApcClassLoader.php on line 112

Thanks much in advance.

@Beezer75

Try to manually update SMTP module library dependancy in SMTP module ludwig.json file to "v6.1.7" as well.

Like this:

{
  "require": {
    "phpmailer/phpmailer": {
      "version": "v6.1.7",
      "url": "https://github.com/PHPMailer/PHPMailer/archive/v6.1.7.zip"
    }
  }
}

Please note that current "^" version prefix in SMTP module ludwig.json file could be problematic. It should be "v6.1.7" in both ludwig.json files.

And don't forget to rebuild caches after ludwig.json file is updated and again after all missing libraries are downloaded by Ludwig.

@Beezer75, this is the issue queue for the PHPMailer SMTP module. It looks like your question belongs in the SMTP module issue queue.