| 1 |
// $Id: README.txt,v 1.24 2007/04/26 16:43:31 somebodysysop and KarenS Exp $ |
// $Id: README.txt,v 2.00 2008/06/09 16:43:31 somebodysysop and KarenS Exp $ |
| 2 |
|
|
| 3 |
views_mail |
views_mail |
| 4 |
|
|
| 49 |
Gunzip and untar the Views Mail tarball and place it into your modules |
Gunzip and untar the Views Mail tarball and place it into your modules |
| 50 |
folder. Navigate to Admin->Modules and click on Views Mail to intstall. |
folder. Navigate to Admin->Modules and click on Views Mail to intstall. |
| 51 |
|
|
| 52 |
Simplenws Settings |
Access Control Permissions |
| 53 |
------------------ |
-------------------------- |
| 54 |
|
Assign the user you wish to be able to configure Views Mail the 'administer views mail' |
| 55 |
|
permission. |
| 56 |
|
|
| 57 |
|
In order to unsubscribe from a newsletter sent by Views Mail, the anonymous user role |
| 58 |
|
must have the 'subscribe to newsletters' permission in Simplenews. |
| 59 |
|
|
| 60 |
|
In order to create a newsletter, the role must have the "create newsletter" permission |
| 61 |
|
in Simplenews. |
| 62 |
|
|
| 63 |
|
If you wish a role to be able to send *any* Views Mail newsletter, assign it the |
| 64 |
|
'send views mail' permission. |
| 65 |
|
|
| 66 |
|
If you wish a role to send only Views Mail newsletters that are created by the user, |
| 67 |
|
then assign it only the 'send own views mail' permission. |
| 68 |
|
|
| 69 |
|
Simplenews Settings |
| 70 |
|
------------------- |
| 71 |
Admin-> Content Managment -> Newsletters -> Newsletters Tab -> Add Newsletter Link |
Admin-> Content Managment -> Newsletters -> Newsletters Tab -> Add Newsletter Link |
| 72 |
|
|
| 73 |
Add a Newsletter type that you will use for creating newsletter issues that |
Add a Newsletter type that you will use for creating newsletter issues that |
| 74 |
will be used with Views Mail. |
will be used with Views Mail. This will be referred to as your Views Mail |
| 75 |
|
newsletter type. |
| 76 |
|
|
| 77 |
Views Mail Settings |
Views Mail Settings |
| 78 |
------------------- |
------------------- |
| 83 |
Select the default newsletter type which will contain the |
Select the default newsletter type which will contain the |
| 84 |
newsletter issues you will send with Views Mail. This |
newsletter issues you will send with Views Mail. This |
| 85 |
default newsletter type should have been created in the |
default newsletter type should have been created in the |
| 86 |
Simplenews Settings step above. |
Simplenews Settings step above. It is your default "Views Mail |
| 87 |
|
newsletter type". |
| 88 |
|
|
| 89 |
Force group e-mail opt-in: |
Force group e-mail opt-in: |
| 90 |
|
|
| 95 |
screen. User can uncheck the option after |
screen. User can uncheck the option after |
| 96 |
registration is completed. |
registration is completed. |
| 97 |
|
|
| 98 |
|
Format the subject line of emails? |
| 99 |
|
|
| 100 |
|
When a newsletter is created, the subject line of the resulting email |
| 101 |
|
will be prepended with the name of the newsletter group. Simplenews |
| 102 |
|
does this by default. Uncheck this box if you want the subject of |
| 103 |
|
the email to only contain the title of the saved newsletter. |
| 104 |
|
|
| 105 |
|
Create Views Mail link? |
| 106 |
|
|
| 107 |
|
When you create a Views Mail newsletter, do you wish |
| 108 |
|
to display a link on the bottom of this newsletter |
| 109 |
|
which will take you to the Views Mail view you have created? |
| 110 |
|
|
| 111 |
|
Views Mail link URL: |
| 112 |
|
|
| 113 |
|
Enter the URL to the Views Mail view you have created. |
| 114 |
|
Do NOT include the ending '/'. Examples: |
| 115 |
|
|
| 116 |
|
myviewsmailview |
| 117 |
|
og/emailmembersbyrole |
| 118 |
|
http://mywebsite.org/viewsmailview |
| 119 |
|
|
| 120 |
|
Note that you need to have already created this view in order |
| 121 |
|
to have the view URL. |
| 122 |
|
|
| 123 |
|
Views Mail link title: |
| 124 |
|
|
| 125 |
|
Enter the title of the link. |
| 126 |
|
|
| 127 |
Subscribe all new signups to newsletter: |
Subscribe all new signups to newsletter: |
| 128 |
|
|
| 129 |
Enter here a newsletter id if |
Enter here a newsletter id if |
| 141 |
"Email test mode" - Click this on if you want to run |
"Email test mode" - Click this on if you want to run |
| 142 |
in test mode (i.e., no actual emails sent). |
in test mode (i.e., no actual emails sent). |
| 143 |
|
|
| 144 |
|
Views Mail Views |
| 145 |
|
---------------- |
| 146 |
|
Admin -> Site Building - > Views - > Default Views |
| 147 |
|
|
| 148 |
|
Views Mail creates a default view: |
| 149 |
|
|
| 150 |
|
View Name : ViewsMailOptOut |
| 151 |
|
View Title: Views Mail Opt Out |
| 152 |
|
|
| 153 |
|
This is a view of users who have opted out of Views Mail by clicking on |
| 154 |
|
the "unsubscribe" link in a newsletter they have received. |
| 155 |
|
|
| 156 |
|
This view comes from the "views_mail_optout" table which contains only two |
| 157 |
|
columns: |
| 158 |
|
|
| 159 |
|
Email address of user who has opted out |
| 160 |
|
Node ID of newsletter from which the user clicked on unsubscribe link |
| 161 |
|
|
| 162 |
|
Any email address on this list will NOT be sent a newsletter via Views Mail |
| 163 |
|
until it is removed this list. See http://drupal.org/node/270450 for more |
| 164 |
|
details. |
| 165 |
|
|
| 166 |
USING VIEWS_MAIL |
USING VIEWS_MAIL |
| 167 |
|
================ |
| 168 |
|
|
| 169 |
1. Create the message you wish to send using Simplenews. |
1. Create the message you wish to send using Simplenews. |
| 170 |
|
|
| 171 |
Create Content -> Newsletter. |
Create Content -> Newsletter issue |
| 172 |
|
|
| 173 |
|
or |
| 174 |
|
|
| 175 |
|
Create Newsletter issue |
| 176 |
|
|
| 177 |
Save it as the newsletter type you selected for Views Mail. |
Save it as the newsletter type you selected for Views Mail (see "Simplenews Settings" |
| 178 |
|
above). This means that on the node submission form in the "Newsletter:" pulldown menu, |
| 179 |
|
you select the Views Mail newsletter type you have previously created. |
| 180 |
|
|
| 181 |
|
If you have not created a Views Mail newsletter type in "Simplenews Settings", you must |
| 182 |
|
first do that. You must also save this newsletter type as the "Default Newsletter" |
| 183 |
|
in "Views Mail Settings". |
| 184 |
|
|
| 185 |
|
|
| 186 |
2. Go to views and create a view of the users you wish to send the message to. You can |
2. Go to views and create a View of the users you wish to send the message to. You can |
| 187 |
add exposed filters if you wish end-users to be able to customize the view. |
add exposed filters if you wish end-users to be able to customize the view. |
| 188 |
|
|
| 189 |
Admin -> Views -> Add View. Don't forget to: |
Admin -> Views -> Add View. Don't forget to: |
| 190 |
|
|
| 191 |
a) Select "Views mail" as the Views Type. |
a) Select "Views mail" as the Views Type. "Nodes per Page" should be set to "0" |
| 192 |
|
(No Paging). |
| 193 |
b) Select at least one field that contains the e-mail address you wish the message |
b) Select at least one field that contains the e-mail address you wish the message |
| 194 |
to. Otherwise, the message will be sent to the e-mail address of the node |
to. Otherwise, the message will be sent to the e-mail address of the node |
| 195 |
author. |
author. |
| 196 |
c) Save the view. |
c) Save the view. When the view is saved, you can use the URL from this view |
| 197 |
|
if you wish to create a Views Mail link (see instructions above). |
| 198 |
|
|
| 199 |
3. Go to the view you created in Step 2. Click on the "Send Mail" link to open the |
3. Go to the view you created in Step 2. Click on the "Send Mail" link to open the |
| 200 |
Views Mail window. You will see these options for sending your email: |
Views Mail window. You will see these options for sending your email: |
| 201 |
|
|
| 202 |
Recipient name : Select the View field to use for the recipient's name. |
Recipient name : Select the View field to use for the recipient's name. |
| 203 |
Recipient email : Select the View field to use for the recipient's email address. |
Recipient email : Select the View field to use for the recipient's email address. |
| 204 |
Subject : Enter the text to be used as the email subject line. |
Subject : This is automatically created from newsletter subject line. |
| 205 |
Newsletter to |
Newsletter to |
| 206 |
send to this |
send to this |
| 207 |
group : Select the Simplenews newsletter you created in Step 1 that |
group : Select the Simplenews newsletter you created in Step 1 that |
| 219 |
|
|
| 220 |
4. Once you have completed entering the "Send Mail" options in the Views Mail window, click |
4. Once you have completed entering the "Send Mail" options in the Views Mail window, click |
| 221 |
on the "Send" button at the bottom of this window. You will then be given a summary |
on the "Send" button at the bottom of this window. You will then be given a summary |
| 222 |
view of all the elments you selected in Step 3 for verification. If all is correct, |
view of all the elments you selected in Step 3 for verification. |
| 223 |
|
|
| 224 |
|
The "Recipient List" is a list of all the email addresses to which Views Mail will |
| 225 |
|
attempt to send the selected newsletter. |
| 226 |
|
|
| 227 |
|
If you see a "Reject List", this contains the email addresses of users from the |
| 228 |
|
view who have previously unsubscribed from Views Mail. Their email addresses |
| 229 |
|
are in the "views_mail_optout" table which you can also view using the default |
| 230 |
|
"ViewsMailOptOut" view. Email can not be sent to these addresses until they |
| 231 |
|
are removed from this table. |
| 232 |
|
|
| 233 |
|
If all is correct, |
| 234 |
then click on "Confirm" to send/schedule the email. If not, go back and correct. |
then click on "Confirm" to send/schedule the email. If not, go back and correct. |
| 235 |
|
|
| 236 |
|
|
| 239 |
There currently is no documentation other then this README.txt file and the original |
There currently is no documentation other then this README.txt file and the original |
| 240 |
discussions we had on creation of the module here: http://drupal.org/node/134931 |
discussions we had on creation of the module here: http://drupal.org/node/134931 |
| 241 |
|
|
| 242 |
|
You may also wish to review the issue queue here: http://drupal.org/project/issues/views_mail |
| 243 |
|
|
| 244 |
-------------- IMPORTANT -------------------------------------------------- |
-------------- IMPORTANT -------------------------------------------------- |
| 245 |
-------------- IMPORTANT -------------------------------------------------- |
-------------- IMPORTANT -------------------------------------------------- |
| 246 |
|
|
| 257 |
- set up userreference and nodereference fields to use the name and email |
- set up userreference and nodereference fields to use the name and email |
| 258 |
of the userreference and nodereference uid |
of the userreference and nodereference uid |
| 259 |
- incorporate Token module to handle substitutions |
- incorporate Token module to handle substitutions |
| 260 |
|
- figure out how to filter views using views_mail_optout table |
| 261 |
|
|
| 262 |
|
|
| 263 |
CREDITS |
CREDITS |
| 264 |
|
|
| 265 |
Huge kudos to KarenS for creating this module! |
Huge kudos to KarenS for creating the original version of this module! |
Parent Directory
| 
Revision Log
| 
Revision Graph
| 
Patch