EQdkp Plus Navigation:   Home  |   Forum  |   Wiki  |   Translate  |   Bugtracker  |   WebSVN  |  USVN

Newsletter

From EQdkp Plus Wiki

Newsletter
Logo NL-plugin.png
Author GodMod
Former Version 2006-2009 WalleniuM
Last Version 2.0.3
Last stable Version 2.0.3

Contents

About this plugin

With this plugin newsletter can be sent to users. User can subscribe to different newsletters. But even classes or single users can be selected as recipients. HTML-Emails, an archive and Email-Templats are just some features of this great plugin. Users can play for a variety of newsletters. But even in classes or individual users can send e-mails sent. HTML-mails, an archives and email templates are just some features of this plugin.

Known Bugs

No known Bugs!

Installation

Just copy the content of the archive into the "plugins"-folder of you EQdkp. Install the plugin via the administration-panel as usual.

Update

Important: please make a Backup of your files on your Webspace and of your Database before updating a plugin or the EQdkp-Version.

After the backup just copy the new files over the old ones in the folder "../plugins/newsletter". Then go to an administration-page of this plugin. If a database-backup is neccessary, there will be a hint. Simply follow the instructions. Information about specific updates will be published here in the WIKI.

Rights

Current used IDs: 571 - 572

Admin-Rights

Manage Newsletter

With this right you can manage and send newsletters.

User-Rights

View

User can subscribe to newsletters and make Usersettings

User-Pages

Subscribe to Newsletters

Subscribe to Newsletters

Here you can find all Newsletters that are public or a user can apply for, or the user has subscribed. Simply check the checkbox for the newsletter you want to subscribe and save the form.

Newsletter-Archive

All mails from a newsletter are shown in this public archive. But the user can only see public newsletter or newsletters he has subscribed.

Usersettings

In the usersettings, a user can select if he wants to receive HTML-Mails oder normal Text-Mails.

Admin-Pages

Send Newsletter

Send Newsletter

First, select the recipients: a newsletter, and/or Classes (where you can select if you want to have only active members) and/or Users. By selecting the checkboxes, you can select more Classes/Users.

In order to make sending a newsletter easier, you can load an Email-Template, which is done with AJAX (without page-reload). You've several possibilities for formating the message: BB-Codes and Placeholders. The Legend under the message-field explains the placeholders.

To make creating a newsletter more easier, there's a link below the message-field called "Insert next Raids/News/Allvatar-News". The Link opens a new windows with different tabs. If the raidplaner is installed, you see the next raids. Select the raids you want to insert and hit the button. Now they are - formatted - in the message-field. It's the same procedure with the news and news from Allvatar.com - Your MMO-Community.

Furthermore, there are another Settings:

  • Add Signature: the signature (which can be edit at the plugin-settings) is added automaticly to the newsletter. S
  • Email-Format: Text or HTML. Standard is HTML. The Usersettings override this settings.
  • Send as: Email oder SMS: If you have an SMS-Account, you can send the newsletter as SMS. But only a text-version is sent, because SMS does not support HTML.
  • Save this mail into Archive: You can resend the Mail from the Archive.

Just submit the form...

Newsletter is sending...

While sending Emails, a progress-bar appeares. Don't close the window until all mails have been sent! But if you interrupt the sending-procedure, you'll get a message and a possibilty to send the unsent emails.

Manage Newslettes

Manage Newsletters

Here you can find all newsletters and you can edit them or create new ones. All subscribers of a newsletter are listed, and you've the possibility to move or copy them to another newsletter. Adding new subscribers is also easy.

Create new Newsletters

Create new newsletter
  • Newsletter-Permission
    • Public Newsletter: every User can subscribe to this newslettern
    • Application and approval required: every User can see this newsletter, you he has to aplly for it and an administrator has to approve him before he can receive emails from this newsletter
    • only after invitation by Administrator: only User that has subscribed a newsletter can see it. New Subscribers can only be added by Administrators.
  • Archive-Permission
    • Visible for users: User can see the newsletter in the public archive, if the newsletter is public or the user is a Subscriber
    • Not visible for Users: User can't see the newsletter in the archive, even he's a Subscriber

More Presettings can be set:

  • Email-Template
  • Save Emails into the archive
  • Send newsletter as Email or SMS

Archive

Admin-Archive

On top of this page there all newsletters listed. Underneath there are all mails they have been sent not to a newsletter. Clicking on a Newsletter will show all Mails sent from this newsletter. Selecting a mail will show following information:

  • Date
  • Recipients
  • Subject
  • Message

Use the Admin-Menu to delete or resend the Email.

Email-Templates

Email-Templates

In order to make sending newsletters easiere, you can create Email-Templates. Just fill in the Subject und the Message, and select whether the signature should be added or not and submit it. Now you can always select this template. For Formating you can use BB-Codes und Placeholders.

Settings

Email-Settings like Mail-Adress, Mailer like php or SMTP, and more have to be set at PLUS-Settings-> Libraries!

Common Settings:

Settings
  • User can subscribe to newsletters: when deactivated, User can't subscribe or unsubscribe from newsletters.w
  • Show public archive: when deactivated, Users can't access to the public archive
  • Signature: the Siganture is added to a newsletter
  • Email-Backgroundcolor: choose the background-color for HTML-Emails (not supported by all Email-Software)
  • Email-Fontcolor: choose the font-color for HTML-Emails (not supported by all Email-Software)

Extented Settings

  • CSS-Style: insert here your own CSS-Code (not supported by all Email-Software)
  • Enable check for new Plugin Versions: when a new version of this plugin is realeased, you'll get an message. Enabling this function is recommended, because Update can bring new features, bug- and security-fixes.
  • Force Datebase-Update: While using an unstable or unreleased version of this plugin, a database-update has to be forced manually.
  • Clear Mail-Queue: when clearing the mail-queue, all unsent emails get lost!!

Own BB-Codes

The WYSIWYG-Editor does not contain all BB-Codes. Here are some own:

  • [class=CLASSNAME]TEXT[/class] In Order to use your own CSS-Style. Will be recplaced as " TEXT "
  • [table][tr][td]Inhalt[/td][/tr][/table] To Create a table, just replace your HTML-Tags with BB-Codes. But rowspan or colspan is not supported!

Support

Please ask for Support in following sections of our Forum:

English Plugin-Section

Deutscher Plugin-Bereich

Please do not write unprompted private messages to me!!

If you like this plugin, you can donate here: Amazon-Wishlist Paypal

Licence

This Plugin is available under the Creative Commons Licence: Attribution-Noncommercial-Share Alike 3.0 Unported.