EmailBuddy

(Difference between revisions)
Jump to: navigation, search
(BETA KNOWN ISSUES)
(Fixed spelling - from "Check our the" to "Check out the" - Extra Customizations Policies)
(13 intermediate revisions by 4 users not shown)
Line 1: Line 1:
==BETA KNOWN ISSUES==
+
[[File:Emailbuddy-thumb.png|right]]
 +
==Description==
 +
EmailBuddy is an email newsletter solution for WordPress. This plugin allows you to place subscription forms around your site where visitors can subscribe to receive email updates. All of the information that is submitted to the subscription forms around the site is stored in organized lists that are groups or events.
  
Major Issues:
 
* None reported.
 
  
Minor Issues:
+
==Groups==
* Licenses are not sticking.
+
Groups are used to store subscribers information. Then if you can use EmailBuddy to easily a mass email to everyone in that group. Since you can create multiple groups of email subscribers you can create more specific emails that you only send to certain groups.
* Events cannot be set to not repeat.
+
 
 +
 
 +
==Events==
 +
Events are similar to groups since they are another way to store email subscribers. But events have the ability to schedule a date and time for when an event is going to happen. Since it is an event EmailBuddy has a feature that allows you to schedule email reminders that occur a set amount of time before the time that the event is scheduled for. The reminder emails can be scheduled for anywhere from an hour before the event to years before the event. Events allow for scheduling up to three reminders per event.
 +
 
 +
 
 +
==Messages==
 +
EmailBuddy has a built in system that  allows you to easily create text-based emails. This system has a feature that allows you to access a list of predefined variables that you can easily add to your emails.
 +
Here is a list of those variables:
 +
* User's email address. {email_address}
 +
* Date and time when message is sent. {datetime}
 +
* URL to this site. {siteurl}
 +
* Unsubscribe link. {unsubscribe}
 +
* Name of blog. {blogname}
 +
* Subject of email. {title}
 +
* Custom field* Name. {custom_name}
 +
The text wrapped in {} above are what will be added to the email then later will be changed to the variable that it is supposed to reference.
 +
 
 +
 
 +
==Subscription Forms==
 +
The subscription forms allow users to easily subscribe to your email newsletter. EmailBuddy adds the ability to add email subscription forms to posts, pages, and widgets.
 +
====Adding a subscription form to post or page====
 +
When the EmailBuddy plugin is activated on your site it adds a shortcode button to the posts and page editors.
 +
 
 +
[[File:Emailbuddyshort.png|368px]]
 +
 
 +
If you want to add a email subscription form to a post or page all you have to do is click that button and a popup form will ask for all of the information needed to customize that form.
 +
 
 +
[[File:Emailbuddyform.png|368px]]
 +
 
 +
Here is a list of the different form fields and the details for what each field is asking for.
 +
<br />'''List to subscribe to''' - This is a drop-down option that has a list of groups and events to choose which list the subscription form will add the subscribers to.
 +
<br />'''Submit button text''' - Set what the text on the submit button says.
 +
<br />'''Confirmation text or redirect URL''' - This option allows you to set what the confirmation message is when a visitor submits a subscription form.
 +
<br />'''Input form text (optional)''' - This text will be the default text in the input box that asks for the visitors email.
 +
<br />'''Custom form inputs(Your Name)''' - If this box is checked then the submission form will add a field asking for the subscribers name.
 +
 
 +
 
 +
==Adding a subscription form to a widget area==
 +
Navigate to the Widgets area under Appearance in the WordPress Admin area. Drag the EmailBuddy widget into the widget area that you would like for it to display in and fill out the form with the information for the subscription form that you would like to add. A description of information that should be added to the form fields is provided in the adding a subscription form to a post or page section above.
 +
 
 +
 
 +
==Tools==
 +
The tools in EmailBuddy have been designed to try and help with any challenges with operating a newsletter system. The tools section of EmailBuddy has four different tabs Emailing, Import Emails, Export Emails, and Scheduled Activity.
 +
====Emailing tools====
 +
This section of the tools are meant to help with any troubleshooting emails.
 +
<br />'''Email Queue'''- The queue will show if there are any emails that are currently queued up to be sent but haven't been sent yet. There are two buttons, "Force Send Queue Now" and "Clear Queue", that will allow you to manually control the queued emails.
 +
<br />'''Send Test Message''' - This feature allows for sending a test email to any email address that you specify so that you can easily test if emailing is working correctly.
 +
<br />'''Unsubscribe User from All Lists''' - Using this feature will unsubscribe a user from all groups and events.
 +
====Import Emails====
 +
This tool allows you to import email addresses by adding one at a time by using the text input box or by importing a text file that is a list of email addresses. If you are importing a text file that is a list of emails it is important to only put one email address per line in order for the email addresses to be imported correctly.
 +
====Export Emails====
 +
This tool adds the ability to create a list of all of your subscribers email addresses and write them to a text file that can be downloaded.
 +
====Scheduled Activity====
 +
The scheduled activity tool lists the different tasks that have been scheduled by EmailBuddy and gives an array of information for each task.
  
==Features==
 
* Two types of lists: Events & Groups. Subscribers to each list may be auto-subscribed to another type of list.
 
* Events:
 
** Events allows you to schedule reminder emails for one-time or recurring events. Up to three email reminders may be sent per scheduled event.
 
** Events may repeat on a regular basis (ie. daily, weekly, monthly, yearly)
 
* Groups:
 
** Groups function as containers of subscribers. This is useful for collecting groups of users for later sending broadcasts to. Groups can be used for newsletter or simply organization. For example, you may wish all users that subscribe to a certain event also be entered into a group to later send newsletters to.
 
* Send mass mails & newsletters.
 
* Manage user subscriptions.
 
* Create & manage email messages to be sent.
 
** Messages support detailed variables for customization such as (but not limited to):
 
*** User's email address.
 
*** Date/time
 
*** URL to site
 
*** Unsubscribe link
 
*** Name of blog
 
*** Title of this list
 
* Import/export email addresses
 
* Easily post subscription forms on your site using one of the available methods:
 
** Widgets
 
** Shortcodes to use anywhere in your posts
 
** Easily insert via a button on the Add Posts page to add anywhere in your posts
 
* Simple Style Manager for styling widgets, confirmation response, and subscription form.
 
* Send user to any page of your site upon subscribing (or back to the same page)
 
* Slide-down subscription confirmation for non-obtrusive stylish confirmation of their action.
 
* Classes available for all components for advanced styling above the Simple Style Manager
 
  
 
==Postponed Features==
 
==Postponed Features==
Line 45: Line 73:
 
==Misc.==
 
==Misc.==
 
Shortcode Format Example: [emailbuddy type="event" list="0" button="Subscribe" confirmation="Thank you for subscribing!" ]
 
Shortcode Format Example: [emailbuddy type="event" list="0" button="Subscribe" confirmation="Thank you for subscribing!" ]
 +
 +
==Customize EmailBuddy==
 +
 +
====Extra Customizations Policies====
 +
[http://ithemes.com/codex/page/PluginBuddy#Extra_Customizations Check out the official policy and details on any Extra Customizations]
 +
 +
====Bigger TEXT BEFORE FORM and TEXT AFTER FORM Widget Fields====
 +
 +
The EmailBuddy Widget comes with the TEXT BEFORE FORM field and the TEXT AFTER FORM field, both of which allow you to enter any custom text in those fields.
 +
 +
[http://ithemes.com/forum/index.php?/topic/18753-bigger-widget-fields-for-text-before-form-and-the-text-after-form/ You can customize the space allotted to you in those fields by following the tip offered by our very own customer Jim].
 +
 +
Thanks Jim! :)
 +
 +
 +
==DB language fix==
 +
<p>The bugfix for emailbuddy will not be able to go in and fix existing tables, in short, it will only help with new installs, or if the user drops all of their emailbuddy tables and recreates them(deactivate plugin, drop tables, reactivate), so for those customers that already have an issue we will need to give them instructions on going into either cmd line or phpMyAdmin and running these alter statements for mySQL to update existing tables. Please rememeber to remind the customer to update any and all data before they do this just to be safe.</p>
 +
<pre>
 +
ALTER TABLE `wp_ebud_events` CONVERT TO CHARACTER SET utf8 COLLATE utf8_unicode_ci;
 +
ALTER TABLE `wp_ebud_groups` CONVERT TO CHARACTER SET utf8 COLLATE utf8_unicode_ci;
 +
ALTER TABLE `wp_ebud_messages` CONVERT TO CHARACTER SET utf8 COLLATE utf8_unicode_ci;
 +
ALTER TABLE `wp_ebud_queue` CONVERT TO CHARACTER SET utf8 COLLATE utf8_unicode_ci;
 +
ALTER TABLE `wp_ebud_subscribers` CONVERT TO CHARACTER SET utf8 COLLATE utf8_unicode_ci;
 +
ALTER TABLE `wp_ebud_subscriptions` CONVERT TO CHARACTER SET utf8 COLLATE utf8_unicode_ci;
 +
</pre>
  
 
==Additional Resources==
 
==Additional Resources==

Revision as of 11:41, October 13, 2011

Emailbuddy-thumb.png

Contents

Description

EmailBuddy is an email newsletter solution for WordPress. This plugin allows you to place subscription forms around your site where visitors can subscribe to receive email updates. All of the information that is submitted to the subscription forms around the site is stored in organized lists that are groups or events.


Groups

Groups are used to store subscribers information. Then if you can use EmailBuddy to easily a mass email to everyone in that group. Since you can create multiple groups of email subscribers you can create more specific emails that you only send to certain groups.


Events

Events are similar to groups since they are another way to store email subscribers. But events have the ability to schedule a date and time for when an event is going to happen. Since it is an event EmailBuddy has a feature that allows you to schedule email reminders that occur a set amount of time before the time that the event is scheduled for. The reminder emails can be scheduled for anywhere from an hour before the event to years before the event. Events allow for scheduling up to three reminders per event.


Messages

EmailBuddy has a built in system that allows you to easily create text-based emails. This system has a feature that allows you to access a list of predefined variables that you can easily add to your emails. Here is a list of those variables:

  • User's email address. {email_address}
  • Date and time when message is sent. {datetime}
  • URL to this site. {siteurl}
  • Unsubscribe link. {unsubscribe}
  • Name of blog. {blogname}
  • Subject of email. {title}
  • Custom field* Name. {custom_name}

The text wrapped in {} above are what will be added to the email then later will be changed to the variable that it is supposed to reference.


Subscription Forms

The subscription forms allow users to easily subscribe to your email newsletter. EmailBuddy adds the ability to add email subscription forms to posts, pages, and widgets.

Adding a subscription form to post or page

When the EmailBuddy plugin is activated on your site it adds a shortcode button to the posts and page editors.

Emailbuddyshort.png

If you want to add a email subscription form to a post or page all you have to do is click that button and a popup form will ask for all of the information needed to customize that form.

Emailbuddyform.png

Here is a list of the different form fields and the details for what each field is asking for.
List to subscribe to - This is a drop-down option that has a list of groups and events to choose which list the subscription form will add the subscribers to.
Submit button text - Set what the text on the submit button says.
Confirmation text or redirect URL - This option allows you to set what the confirmation message is when a visitor submits a subscription form.
Input form text (optional) - This text will be the default text in the input box that asks for the visitors email.
Custom form inputs(Your Name) - If this box is checked then the submission form will add a field asking for the subscribers name.


Adding a subscription form to a widget area

Navigate to the Widgets area under Appearance in the WordPress Admin area. Drag the EmailBuddy widget into the widget area that you would like for it to display in and fill out the form with the information for the subscription form that you would like to add. A description of information that should be added to the form fields is provided in the adding a subscription form to a post or page section above.


Tools

The tools in EmailBuddy have been designed to try and help with any challenges with operating a newsletter system. The tools section of EmailBuddy has four different tabs Emailing, Import Emails, Export Emails, and Scheduled Activity.

Emailing tools

This section of the tools are meant to help with any troubleshooting emails.
Email Queue- The queue will show if there are any emails that are currently queued up to be sent but haven't been sent yet. There are two buttons, "Force Send Queue Now" and "Clear Queue", that will allow you to manually control the queued emails.
Send Test Message - This feature allows for sending a test email to any email address that you specify so that you can easily test if emailing is working correctly.
Unsubscribe User from All Lists - Using this feature will unsubscribe a user from all groups and events.

Import Emails

This tool allows you to import email addresses by adding one at a time by using the text input box or by importing a text file that is a list of email addresses. If you are importing a text file that is a list of emails it is important to only put one email address per line in order for the email addresses to be imported correctly.

Export Emails

This tool adds the ability to create a list of all of your subscribers email addresses and write them to a text file that can be downloaded.

Scheduled Activity

The scheduled activity tool lists the different tasks that have been scheduled by EmailBuddy and gives an array of information for each task.


Postponed Features

Custom welcome email upon subscription or validation after double opt-in.

Styling

Classes emailbuddy_pretext emailbuddy_posttext

Misc.

Shortcode Format Example: [emailbuddy type="event" list="0" button="Subscribe" confirmation="Thank you for subscribing!" ]

Customize EmailBuddy

Extra Customizations Policies

Check out the official policy and details on any Extra Customizations

Bigger TEXT BEFORE FORM and TEXT AFTER FORM Widget Fields

The EmailBuddy Widget comes with the TEXT BEFORE FORM field and the TEXT AFTER FORM field, both of which allow you to enter any custom text in those fields.

You can customize the space allotted to you in those fields by following the tip offered by our very own customer Jim.

Thanks Jim! :)


DB language fix

The bugfix for emailbuddy will not be able to go in and fix existing tables, in short, it will only help with new installs, or if the user drops all of their emailbuddy tables and recreates them(deactivate plugin, drop tables, reactivate), so for those customers that already have an issue we will need to give them instructions on going into either cmd line or phpMyAdmin and running these alter statements for mySQL to update existing tables. Please rememeber to remind the customer to update any and all data before they do this just to be safe.

ALTER TABLE `wp_ebud_events` CONVERT TO CHARACTER SET utf8 COLLATE utf8_unicode_ci;
ALTER TABLE `wp_ebud_groups` CONVERT TO CHARACTER SET utf8 COLLATE utf8_unicode_ci;
ALTER TABLE `wp_ebud_messages` CONVERT TO CHARACTER SET utf8 COLLATE utf8_unicode_ci;
ALTER TABLE `wp_ebud_queue` CONVERT TO CHARACTER SET utf8 COLLATE utf8_unicode_ci;
ALTER TABLE `wp_ebud_subscribers` CONVERT TO CHARACTER SET utf8 COLLATE utf8_unicode_ci;
ALTER TABLE `wp_ebud_subscriptions` CONVERT TO CHARACTER SET utf8 COLLATE utf8_unicode_ci;

Additional Resources

  1. Plugin Store
  2. PluginBuddy Tutorials
  3. PluginBuddy.com
  4. Support Forums
Personal tools
Namespaces
Variants
Actions
iThemes Codex
Codex Navigation
Toolbox