email_linkA panel that gives an user the ability to send the current wiki page through email
TypeXAR
Developed by

Guillaume Lerouge

Rating
Rate!
1 Votes
LicenseGNU Lesser General Public License 2.1
Installable with the Extension Manager

Description

Since 2.6, this functionality is provided as a platform feature as the Share by email menu entry.

This application uses the MailSender plugin's send HTML page method and the Show / hide DIV code snippet.

In order to work properly, it requires the following conditions to be met :

  • The MailSender plugin must be up & running on your wiki instance
  • You must have a SMTP server properly configured
  • The panel has to be saved by a user with programming rights.

It offers the ability to send any wiki page by email. The recipient's email can be typed in the recipient field. Clicking on the "more" button displays 3 additional fields : CC, BCC and COMMENT & 2 checkboxes : Include page comments and attachments. 

  • CC & BCC work as usual carbon copy & blank carbon copy fields. 
  • The comment field let an user add additional information that will be displayed on the top of the sent email along with the sender's name & the page's last modification date.
  • Ticking the "Include page comments" sends the page comments along with the page itself
  • Ticking the "Include page attachments" sends the page attachments along with the page

The email sent is the HTML version of the rendered content of the page the user is viewing. In case its email client does not support HTML emailing, the alt field is fed with the page's original wiki markup content. A page can be sent to several recipients provided their email addresses are comma-separated ([email protected],[email protected],...).

Images

The panel in its default state.

SmallPanel.png

The full panel displaying more options when opened.

IncludeStuff.png

The panel when the email has been sent properly.

Success.png

The panel when the email has not been sent.

Failure.png

The resulting HTML email.

HTMLEmail.png

The resulting HTML email when an image is attached to the page.

HTMLEmailWithImage.png

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

As this is a panel stored in a XAR, it can be easily installed using XWiki's Import feature.

Have you set up an Outgoing SMTP Server? Check it at Administration > Preferences > Registration > Outgoing SMTP Server. This setting requires to restart XWiki.
  1. Click on the Administration link at the top right of your wiki.
  2. Click on the "Import" tab.
  3. Upload the file.
  4. Click on the file name.
  5. Click on "Import".
  6. Go to the http:///xwiki/bin/view/Panels/SendPageByEmail page.
  7. Edit & Save the page with an user who has programming rights (XWiki's default Admin has them).
  8. Go to your wiki's Panel Wizard at http:///xwiki/bin/view/Panels/PanelWizard.
  9. Drag & drop the Send Page By Email panel where you want it to be displayed.
  10. Save the new layout.
  11. You're done !

Release Notes

v0.9

The first implementation of the Send Page By Email panel. It provides basic functionality that should be enough to meet most users needs.

Tags: mail
Created by Guillaume Lerouge on 2008/02/05 09:02
    

Get Connected