Jump to content
LexSanchez

Module: Video or Social Post Embed

Recommended Posts

Video or Social Post Embed

Based on the TextformatterVideoEmbed module developed by Ryan Cramer, we have added the possibility to embed publications of the main social networks Facebook, Twitter and Instagram.

ProcessWire Textformatter module that enables translation of YouTube, Vimeo, Instagram, Facebook, Twitter or Issuu URLs to full embed codes, resulting in a viewable video or social post in textarea fields you apply it to.

How to install

  • Download or Clone from Github: https://github.com/lexsanchez/VideoOrSocialPostEmbed

  • Copy the VideoOrSocialPostEmbed.module file to your /site/modules/ directory (or place it in /site/modules/VideoOrSocialPostEmbed/).

  • Click check for new modules in ProcessWire Admin Modules screen. Click install for the module labeled: "Video or Social Post Embed".

  • Now you will be on the module config screen. Please make note of the config options and set as you see fit.

How to use

  • Edit your body field in Setup > Fields (or whatever field(s) you will be placing videos in). On the details tab, find the Text Formatters field and select "Video or Social Post Embed". Save.

  • Edit a page using the field you edited and paste in YouTube, Vimeo, Facebook, Twitter, Instagram and/or Issuu URLs each on their own paragraph.

Example

How it might look in your editor (like TinyMCE):

Here are two videos about ProcessWire

http://www.youtube.com/watch?v=Wl4XiYadV_k

http://www.youtube.com/watch?v=XKnG7sikE-U

And here is a great video I watched earlier this week:

http://vimeo.com/18280328

Embed social post and Issuu Presentation:

https://www.instagram.com/p/BeA8p9AhA3b/

https://twitter.com/rpc_radio/status/954315569838411776

https://www.facebook.com/TNTLA/videos/10155549598252758/

https://issuu.com/madsoundsmagazine/docs/mad_sounds_issue_no._17_issuu

How it works

This module uses YouTube, Vimeo, Instagram, Facebook, Twitter and Issuu oEmbed services to generate the embed codes populated in your content. After these services are queried the first time, the embed code is cached so that it doesn't need to be pulled again.

Configuration

You may want to update the max width and max height settings on the module's configuration screen. You should make these consistent with what is supported by your site design.

If you change these max width / max height settings you may also want to check the box to clear cache, so that YouTube/Vimeo/Facebook/Twitter/Instagram/Issuu oembed services will generate new embed codes for you.

Using with Markdown, Textile or other LML

This text formatter is looking for a YouTube, Vimeo, Instagram, Facebook, Twitter or Issuu video URL surrounded by paragraph tags. As a result, if you are using Markdown or Textile (or something else like it) you want that text formatter to run before this one. That ensures that the expected paragraph tags will be present when VideoOrSocialPostEmbed runs. You can control the order that text formatters are run in by drag/drop sorting in the field editor.


Copyright 2018 by Ryan Cramer / Updated by Lex Sanchez

  • Like 18
  • Haha 1

Share this post


Link to post
Share on other sites

Thank you.

There is a problem here with 

https://www.instagram.com/p/BeA8p9AhA3b/

 

Error: Exception: SQLSTATE[22001]: String data, right truncated: 1406 Data too long for column 'embed_code' at row 1 (in /home/theo/public_html/pwdev/site/modules/VideoOrSocialPostEmbed/TextformatterVideoOrSocialPostEmbed.module line 113)

#0 /home/theo/public_html/pwdev/site/modules/VideoOrSocialPostEmbed/TextformatterVideoOrSocialPostEmbed.module(113): PDOStatement->execute()
#1 /home/theo/public_html/pwdev/site/modules/VideoOrSocialPostEmbed/TextformatterVideoOrSocialPostEmbed.module(337): TextformatterVideoOrSocialPostEmbed->getEmbedCode('://api.instagra...', 'ig-BeA8p9AhA3b')
#2 /home/theo/public_html/pwdev/site/modules/VideoOrSocialPostEmbed/TextformatterVideoOrSocialPostEmbed.module(152): TextformatterVideoOrSocialPostEmbed->embedInstagram('<p>https://www....')
#3 /home/theo/public_html/pwdev/wire/core/Textformatter.php(60): TextformatterVideoOrSocialPostEmbed->format('<p>https://www....


 

Share this post


Link to post
Share on other sites

Hello Theo:

Thanks for your comment; I have made an update to the module that solves this error, please uninstall the module replace with the new version.

Regards,

  • Like 1

Share this post


Link to post
Share on other sites

Thanks, would be interesting to see how your example looks like on the frontend. Maybe you have a screenshot? :)

  • Like 2

Share this post


Link to post
Share on other sites

Hi Bernhard:

Sorry for answering something late, I attached 2 images of how it is shown in social network content.

Captura01.JPG

Captura02.JPG

Captura03.JPG

  • Like 1

Share this post


Link to post
Share on other sites

Is there a way to get this module to work with CKeditor? For me it is not working :( Only the links are visible in frontend.

Share this post


Link to post
Share on other sites

Got it. The URL has to be pain text instead of a link.

Share this post


Link to post
Share on other sites

Hello,

When I try to install Video or Social Post Embed in ProcessWire 3.0.102, I have an error page with:

Error

Class '\VideoOrSocialPostEmbed' not found

and

File: /home/********/public_html/wire/core/Modules.php:535

525:                    ProcessWire::setCurrentInstance($wire2);
526:                } else {
527:                    $wire1 = null;
528:                }
529:            } else {
530:                $wire1 = null;
531:                $wire2 = null;
532:            }
533:            
534:            try {
535:                $module = $this->wire(new $className());
536:            } catch(\Exception $e) {
537:                $this->error(sprintf($this->_('Failed to construct module: %s'), $className) . " - " . $e->getMessage());
538:                $module = null;
539:            }

In version 2.8.62, the class wasn't found as well.

If I disable Tracy Debugger, I see:

Fatal error: Uncaught Error: Class '\VideoOrSocialPostEmbed' not found in /home/********/public_html/wire/core/Modules.php:535 Stack trace: #0 /home/********/public_html/wire/core/Modules.php(1704): ProcessWire\Modules->newModule('\\VideoOrSocialP...') #1 /home/********/public_html/wire/core/Wire.php(386): ProcessWire\Modules->___install('VideoOrSocialPo...', Array) #2 /home/********/public_html/wire/core/WireHooks.php(723): ProcessWire\Wire->_callMethod('___install', Array) #3 /home/********/public_html/wire/core/Wire.php(442): ProcessWire\WireHooks->runHooks(Object(ProcessWire\Modules), 'install', Array) #4 /home/********/public_html/wire/modules/Process/ProcessModule/ProcessModule.module(262): ProcessWire\Wire->__call('install', Array) #5 /home/********/public_html/wire/core/Wire.php(380): ProcessWire\ProcessModule->___execute() #6 /home/********/public_html/wire/core/WireHooks.php(723): ProcessWire\Wire->_callMethod('___execute', Array) #7 /home/********/public_html/wire/core/Wire.php(442): ProcessWire\WireHooks->runH in /home/********/public_html/wire/core/Modules.php on line 535

and

Error: Uncaught Error: Class '\VideoOrSocialPostEmbed' not found in /home/********/public_html/wire/core/Modules.php:535
Stack trace:
#0 /home/********/public_html/wire/core/Modules.php(1704): ProcessWire\Modules->newModule('\\VideoOrSocialP...')
#1 /home/********/public_html/wire/core/Wire.php(386): ProcessWire\Modules->___install('VideoOrSocialPo...', Array)
#2 /home/********/public_html/wire/core/WireHooks.php(723): ProcessWire\Wire->_callMethod('___install', Array)
#3 /home/********/public_html/wire/core/Wire.php(442): ProcessWire\WireHooks->runHooks(Object(ProcessWire\Modules), 'install', Array)
#4 /home/********/public_html/wire/modules/Process/ProcessModule/ProcessModule.module(262): ProcessWire\Wire->__call('install', Array)
#5 /home/********/public_html/wire/core/Wire.php(380): ProcessWire\ProcessModule->___execute()
#6 /home/********/public_html/wire/core/WireHooks.php(723): ProcessWire\Wire->_callMethod('___execute', Array)
#7 /home/********/public_html/wire/core/Wire.php(442): ProcessWire\WireHooks->runH (line 535 of /home/********/public_html/wire/core/Modules.php) 

This error message was shown because: site is in debug mode. ($config->debug = true; => /site/config.php). Error has been logged.

EDIT: I've just been able to install it via the backend (via the .zip URL from GitHub).
I had done it manually before. I had renamed the folder and the .module file VideoOrSocialPostEmbed (like in the documentation(s)). I hadn't done it again without renaming anything (or had I? I don't remember. Perhaps both, or the folder or the file) so I don't know if it was the reason (or one of them).
I've changed the PHP version from 7.1 to 7.2. Not sure it had an effect.

Edited by Christophe
Solved

Share this post


Link to post
Share on other sites

Hello again,

For YouTube videos, would it be possible to make it work with &rel=0 added at the end of the URL (like it is the case with Video Embed For YouTube/Vimeo).

It works with the Video embed for YouTube and Vimeo module.

Thanks in advance for considering it.

Or if anyone knows how to enable it properly.

Edited by Christophe

Share this post


Link to post
Share on other sites

Nice module.

You should add this:

 $embedCode = utf8_encode($data['html']);


When fetching data from providers, and set the data tables to mb4. Otherwise the output gets chewed up and throws errors. 

Test with instagram embed where there is an emoji in the title, e.g. https://www.instagram.com/p/BjXM8mInfN-/

Thanks for the module. 

  • Like 1

Share this post


Link to post
Share on other sites

Tried to install via zip and class, in both cases I got empty settings page:

pw.PNG

Share this post


Link to post
Share on other sites

Managed to install.

It is not working in ANY editor. Neither youtube, nore twitter, nor facebook, nothing. I can write exact same non-working module for like 1 sec and less.

Please, someone delete this module.

Share this post


Link to post
Share on other sites

Quick YouTube test... 

651815502_2019-04-0819_52_22.thumb.png.1f594f3cb9231d781cb0f02d6dfb7bf7.png

ProcessWire 3.0.123
VideoOrSocialPostEmbed 1.2.1

So... you might want to check your setup and settings.

Share this post


Link to post
Share on other sites

Module works fine with YouTube and Vimeo Links, but all other (Instagram, Twitter,Facebook, ...) do not work. My  core-version is 3.0.98, module-version is 1.2.2.

Share this post


Link to post
Share on other sites

tested with 3.0.155 all embed works after two changes:

1- Find textformatter_video_or_social_embed table change embed_code collation to utf8mb4 if not  // changed to utf8mb4_unicode_ci

2- https://github.com/lexsanchez/VideoOrSocialPostEmbed/blob/57c254e64ae3c03139e2bb5119ffc676d92af39c/TextformatterVideoOrSocialPostEmbed.module#L103

update this line 

$embedCode = utf8_encode($data['html']);

 

 

Untitled-1.jpg

Share this post


Link to post
Share on other sites

I am having difficulty implementing the fix that fliwire suggests above. Can someone share with me the proper syntax for the first step "1- Find textformatter_video_or_social_embed table change embed_code collation to utf8mb4 if not  // changed to utf8mb4_unicode_ci" I understand the need to change the characterset but don't know how as I'm very new to processwire, php and this forum so thanks in advance to anyone who can help. 

Share this post


Link to post
Share on other sites
5 hours ago, Benjamin said:

I am having difficulty implementing the fix that fliwire suggests above. Can someone share with me the proper syntax for the first step "1- Find textformatter_video_or_social_embed table change embed_code collation to utf8mb4 if not  // changed to utf8mb4_unicode_ci" I understand the need to change the characterset but don't know how as I'm very new to processwire, php and this forum so thanks in advance to anyone who can help. 

Hi Benjamin:

I have made the update indicated by Fliwire, update the module, it is an excellent recommendation Fliwire thanks. 

Share this post


Link to post
Share on other sites

Thanks MedcomPanama for doing the updates suggested by Fliwire. The module is working well for me now. It's great to have such a fast and helpful reply. 

Share this post


Link to post
Share on other sites

Hi,

Just installed this amazing module. All works fine but I am not able to embed FB videos. I get this error on the page:

Video Unavailable
This video may no longer exist, or you don't have permission to view it.
 
Is there a solution for this?
 
Thanks.
 
Gideon

Share this post


Link to post
Share on other sites

Hi,

I have a strange question. I embed twitter link without problem, but the rendering is in spanish (and I tried many links with the same result). Believe me, I have absolutely nothing set to this language on my computer (either PW, or twitter cookie or anything). Have an idea how to revert back this to my language?

image.png.748b3a2d020a010a377b735945e2f301.png

Thanks

Mel

Share this post


Link to post
Share on other sites

I've just noticed from today that YouTube video urls don't appear to be working. Vimeo and Twitter examples worked fine but I can't seem to get any Youtube URL to work now.

Is anyone aware of what this could be. I've tried different urls in different fileds but am having no joy. Previous links that works have now just reverted to a line of text.

Any help or advice would be greatly appreciated.

Thanks

Share this post


Link to post
Share on other sites

Thank you for this module!

It was not working for me until I found out that the HTML created by CKEditor was something like

<p style="margin-left:0cm; margin-right:0cm">https://www.youtube.com/watch?v=Lh63JcccM7k</p>

So the <p> tag has a style attribute. The regex (line 180 in module php) does not cater for that.

$regex = '#<p>\s*(https?://(?:www\.)?youtu(?:.be|be.com)+/(?:watch/?\?v=|v/)?([^\s&<\'"]+))(&[-_,.=&;a-zA-Z0-9]*)?.*?</p>#';

I adjusted it, so that it also works  for paragraphs with attributes

$regex = '#<p.*>\s*(https?://(?:www\.)?youtu(?:.be|be.com)+/(?:watch/?\?v=|v/)?([^\s&<\'"]+))(&[-_,.=&;a-zA-Z0-9]*)?.*?</p>#';

@Lex Sanchez maybe you want to implement this in your module.

Share this post


Link to post
Share on other sites
On 10/16/2020 at 5:36 AM, Gideon So said:

All works fine but I am not able to embed FB videos. I get this error on the page:

Video Unavailable
This video may no longer exist, or you don't have permission to view it.

@Gideon So Unfortunately Facebook doesn't allow embedding content anymore (started on 24th October 2020) unless the site is authenticated. More here: https://developers.facebook.com/docs/plugins/oembed
This includes Facebook and Instagram

Share this post


Link to post
Share on other sites

@999design I have the same issue, even though the paragraph tags have no attributes in my case.
Tried it as links and as plain text between p tags, no luck.

  • Like 1

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 tcnet
      PageViewStatistic for ProcessWire is a module to log page visits of the CMS. The records including some basic information like IP-address, browser, operating system, requested page and originate page. Please note that this module doesn't claim to be the best or most accurate.
      Advantages
      One of the biggest advantage is that this module doesn't require any external service like Google Analytics or similar. You don't have to modify your templates either. There is also no Javascript or image required.
      Disadvantages
      There is only one disadvantage. This module doesn't record visits if the browser loads the page from its browser cache. To prevent the browser from loading the page from its cache, add the following meta tags to the header of your page:
      <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" /> <meta http-equiv="Pragma" content="no-cache" /> <meta http-equiv="Expires" content="0" /> How to use
      The records can be accessed via the Setup-menu of the CMS backend. The first dropdown control changes the view mode.

      Detailed records
      View mode "Detailed records" shows all visits of the selected day individually with IP-address, browser, operating system, requested page and originate page. Click the update button to see new added records.

      Cached visitor records
      View modes other than "Detailed records" are cached visitor counts which will be collected on a daily basis from the detailed records. This procedure ensures a faster display even with a large number of data records. Another advantage is that the detailed records can be deleted while the cache remains. The cache can be updated manually or automatically in a specified time period. Multiple visits from the same IP address on the same day are counted as a single visitor.

      Upgrade from older versions
      Cached visitor counts is new in version 1.0.8. If you just upgraded from an older version you might expire a delay or even an error 500 if you display cached visitor counts. The reason for this is that the cache has to be created from the records. This can take longer if your database contains many records. Sometimes it might hit the maximally execution time. Don't worry about that and keep reloading the page until the cache is completely created.
      Special Feature
      PageViewStatistic for ProcessWire can record the time a visitor viewed the page. This feature is deactivated by default. To activate open the module configuration page and activate "Record view time". If activated you will find a new column "S." in the records which means the time of view in seconds. With every page request, a Javascript code is inserted directly after the <body> tag. Every time the visitor switches to another tab or closes the tab, this script reports the number of seconds the tab was visible. The initial page request is recorded only as a hyphen (-).

      Settings
      You can access the module settings by clicking the Configuration button at the bottom of the records page. The settings page is also available in the menu: Modules->Configure->ProcessPageViewStat.
      IP2Location
      This module uses the IP2Location database from: http://www.ip2location.com. This database is required to obtain the country from the IP address. IP2Location updates this database at the begin of every month. The settings of ProcessPageViewStat offers the ability to automatically download the database monthly. Please note, that automatically download will not work if your webspace doesn't allow allow_url_fopen.
      Dragscroll
      This module uses DragScroll. A JavaScript available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability in view mode "Day" to drag the records horizontally with the mouse pointer.
      parseUserAgentStringClass
      This module uses the PHP class parseUserAgentStringClass available from: http://www.toms-world.org/blog/parseuseragentstring/. This class is required to filter out the browser type and operating system from the server request.
    • By Mike Rockett
      TextformatterTypographer
      A ProcessWire wrapper for the awesome PHP Typography class, originally authored by KINGdesk LLC and enhanced by Peter Putzer in wp-Typography. Like Smartypants, it supercharges text fields with enhanced typography and typesetting, such as smart quotations, hyphenation in 59 languages, ellipses, copyright-, trade-, and service-marks, math symbols, and more.
      It's based on the PHP-Typography library found over at wp-Typography, which is more frequently updated and feature rich that its original by KINGdesk LLC.
      The module itself is fully configurable. I haven't done extensive testing, but there is nothing complex about this, and so I only envisage a typographical bug here and there, if any.
    • By robert
      I often had the need for an overview of all used fields and their contents for a specific page/template while developing new websites without switching to the backend, so I made a small module which lists all the needed information in a readable manner (at least for me):
      Debug Page Fields
      https://github.com/robertweiss/ProcessDebugPageFields
      It adds two new properties to all pages:
      $page->debugFieldValues – returns an object with all (sub-)fields, their labels, fieldtypes and values $page->debugFieldTypes – returns an object with all fieldtypes and their corresponding fields // List all values of a pages $page->debugFieldValues // List a specific field $page->debugFieldValues->fieldname // List all used fieldtypes of a page $page->debugFieldTypes I recommend using it in combination with Tracy Debugger, Ray, Xdebug etc. as it returns an object and is only meant for developing/debugging uses. 
      For now, the fieldtype support includes mostly fieldtypes I use in my projects, but can easily be extended by adding a new FieldtypeFIELDNAME method to the module. I use it with five different client installations (all PW 3.0.*), but of course there might be some (or more) field configurations which are not covered correctly yet.
      Supported fieldtypes
      Button Checkbox Color Combo Datetime Email FieldsetPage * File FontIconPicker Functional Image ImageReference MapMarker Multiplier Mystique Options Page PageIDs PageTitle Radio Repeater * RepeaterMatrix * RockAwesome SeoMaestro Table Text Textarea Textareas Toggle URL * The fields with complete subfield-support also list their corresponding subfields.
      Installation
      Download the zip file at Github or clone the repo into your site/modules directory. If you downloaded the zip file, extract it in your sites/modules directory. In your admin, go to Modules > Refresh, then Modules > New, then click on the Install button for this module. As this is my first ›public‹ module, I hope I did not miss any important things to mention here.
    • By horst
      Wire Mail SMTP

      An extension to the (new) WireMail base class that uses SMTP-transport

      This module integrates EmailMessage, SMTP and SASL php-libraries from Manuel Lemos into ProcessWire. I use this continously evolved libraries for about 10 years now and there was never a reason or occasion not to do so. I use it nearly every day in my office for automated composing and sending personalized messages with attachments, requests for Disposition Notifications, etc. Also I have used it for sending personalized Bulkmails many times.

      The WireMailSmtp module extends the new email-related WireMail base class introduced in ProcessWire 2.4.1 (while this writing, the dev-branch only).
       
      Here are Ryans announcement.



      Current Version 0.6.0
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
      get it from the Modules Directory Install and Configure

      Download the module into your site/modules/ directory and install it.

      In the config page you fill in settings for the SMTP server and optionaly the (default) sender, like email address, name and signature.
      You can test the smtp settings directly there. If it says "SUCCESS! SMTP settings appear to work correctly." you are ready to start using it in templates, modules or bootstrap scripts.


      Usage Examples
      The simplest way to use it:
      $numSent = wireMail($to, $from, $subject, $textBody); $numSent = wireMail($to, '', $subject, $textBody); // or with a default sender emailaddress on config page This will send a plain text message to each recipient.
       
      You may also use the object oriented style:
      $mail = wireMail(); // calling an empty wireMail() returns a wireMail object $mail->to($toEmail, $toName); $mail->from = $yourEmailaddress; // if you don't have set a default sender in config // or if you want to override that $mail->subject($subject); $mail->body($textBody); $numSent = $mail->send(); Or chained, like everywhere in ProcessWire:
      $mail = wireMail(); $numSent = $mail->to($toEmail)->subject($subject)->body($textBody)->send(); Additionaly to the basics there are more options available with WireMailSmtp. The main difference compared to the WireMail BaseClass is the sendSingle option. With it you can set only one To-Recipient but additional CC-Recipients.
      $mail = wireMail(); $mail->sendSingle(true)->to($toEmail, $toName)->cc(array('person1@example.com', 'person2@example.com', 'person3@example.com')); $numSent = $mail->subject($subject)->body($textBody)->send(); The same as function call with options array:
      $options = array( 'sendSingle' => true, 'cc' => array('person1@example.com', 'person2@example.com', 'person3@example.com') ); $numSent = wireMail($to, '', $subject, $textBody, $options); There are methods to your disposal to check if you have the right WireMail-Class and if the SMTP-settings are working:
      $mail = wireMail(); if($mail->className != 'WireMailSmtp') { // Uups, wrong WireMail-Class: do something to inform the user and quit echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; return; } if(!$mail->testConnection()) { // Connection not working: echo "<p>Couldn't connect to the SMTP server. Please check the {$mail->className} modules config settings!</p>"; return; }  
      A MORE ADVANCED DEBUG METHOD!
      You can add some debug code into a template file and call a page with it:
      $to = array('me@example.com'); $subject = 'Wiremail-SMTP Test ' . date('H:i:s') . ' äöü ÄÖÜ ß'; $mail = wireMail(); if($mail->className != 'WireMailSmtp') { echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; } else { $mail->from = '--INSERT YOUR SENDER ADDRESS HERE --'; // <--- !!!! $mail->to($to); $mail->subject($subject); $mail->sendSingle(true); $mail->body("Titel\n\ntext text TEXT text text\n"); $mail->bodyHTML("<h1>Titel</h1><p>text text <strong>TEXT</strong> text text</p>"); $dump = $mail->debugSend(1); } So, in short, instead of using $mail->send(), use $mail->debugSend(1) to get output on a frontend testpage.
      The output is PRE formatted and contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection, like this one:
       
      Following are a ...


      List of all options and features


      testConnection () - returns true on success, false on failures


      sendSingle ( true | false ) - default is false

      sendBulk ( true | false ) - default is false, Set this to true if you have lots of recipients (50+)


      to ($recipients) - one emailaddress or array with multiple emailaddresses

      cc ($recipients) - only available with mode sendSingle, one emailaddress or array with multiple emailaddresses

      bcc ($recipients) - one emailaddress or array with multiple emailaddresses

       
      from = 'person@example.com' - emailaddress, can be set in module config (called Sender Emailaddress) but it can be overwritten here

      fromName = 'Name Surname' - optional, can be set in module config (called Sender Name) but it can be overwritten here


      priority (3) - 1 = Highest | 2 = High | 3 = Normal | 4 = Low | 5 = Lowest

      dispositionNotification () or notification () - request a Disposition Notification


      subject ($subject) - subject of the message

      body ($textBody) - use this one alone to create and send plainText emailmessages

      bodyHTML ($htmlBody) - use this to create a Multipart Alternative Emailmessage (containing a HTML-Part and a Plaintext-Part as fallback)

      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)

      attachment ($filename, $alternativeBasename = "") - add attachment file, optionally alternative basename


      send () - send the message(s) and return number of successful sent messages


      debugSend(1) - returns and / or outputs a (pre formatted) dump that contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection. (See above the example code under ADVANCED DEBUG METHOD for further instructions!)


      getResult () - returns a dump (array) with all recipients (to, cc, bcc) and settings you have selected with the message, the message subject and body, and lists of successfull addresses and failed addresses,


      logActivity ($logmessage) - you may log success if you want

      logError ($logmessage) - you may log warnings, too. - Errors are logged automaticaly
       
       
      useSentLog (true | false) - intended for usage with e.g. third party newsletter modules - tells the send() method to make usage of the sentLog-methods - the following three sentLog methods are hookable, e.g. if you don't want log into files you may provide your own storage, or add additional functionality here

      sentLogReset ()  - starts a new LogSession - Best usage would be interactively once when setting up a new Newsletter

      sentLogGet ()  - is called automaticly within the send() method - returns an array containing all previously used emailaddresses

      sentLogAdd ($emailaddress)  - is called automaticly within the send() method
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
       
       
×
×
  • Create New...