forked from hildende/smtp-mailing-queue
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
150 lines (98 loc) · 4.91 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
=== SMTP Mailing Queue ===
Contributors: hildende
Tags: mail, smtp, phpmailer, mailing queue, wp_mail, email
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=KRBU2JDQUMWP4
Requires at least: 3.9
Tested up to: 4.4
Stable tag: 1.0.6
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Add emails to a mailing queue instead of sending immediately to speed up sending forms for the website visitor and lower server load.
== Description ==
This plugin adds emails to a mailing queue instead of sending immediately. This speeds up sending forms for the website visitor and lowers the server load.
Emails are stored as files which are deleted after emails are sent.
You can send all outgoing emails via an SMTP server or (the WordPress standard) PHP function [mail](http://php.net/manual/en/function.mail.php), and either use [wp_cron](https://codex.wordpress.org/Function_Reference/wp_cron) or a cronjob (if your server/hoster supports this) to process the queue.
Plugin requires PHP 5.4 or above.
Tools:
* You can send test mails to test your setup.
* You can process the mailing queue manually instead of waiting for cronjob.
* You can display the mailing queue in the backend to see emails that will be sent with next processing.
Coming soon:
* Logging of mails and errors.
* Archive of sent mail.
* Storing mailing data in database instead of files.
* Using plugin for SMTP mails without using mailing queue.
Feel free to suggest features or send feedback in the [support section](https://wordpress.org/support/plugin/smtp-mailing-queue), via [email](mailto:[email protected]) or by creating a pull request on [github](https://github.com/hildende/smtp-mailing-queue).
== Installation ==
1. Upload the files to the `/wp-content/plugins/smtp-mailing-queue/` directory
2. Activate the \"SMTP Mailing Queue\" plugin through the \"Plugins\" admin page in WordPress
3. Go to \"SMTP Mailing Queue\" settings page in WordPress admin settings section (you can simply click the \"Settings\" link for this plugin in the \"Plugin\" page
= SMTP =
Enter the SMTP credentials you got from your mail provider.
**Common mail providers:**
**gmail**
* Host: smtp.gmail.com
* Port: 465
* Encryption: ssl
* Use authentication: yes
* Username: your full email address
**yahoo**
* Host: smtp.mail.yahoo.com
* Port: 465
* Encryption: ssl
* Use authentication: yes
* Username: your full email address
**office365**
* Host: smtp.office365.com
* Port: 587
* Encryption: tls
* Use authentication: yes
* Username: your full email address
If you have another mail provider you will most likely get the SMTP settings on their website or by asking them.
= Advanced =
* queue limit: Set the amount of mails sent per cronjob processing
* secret key: Set a key needed to start queue manually or via cronjob
* don't use wp_cron: Use a real cronjob instead of wp_cron.
Call http://www.example.org**?smqProcessQueue&key=MySecretKey** in cronjob to start processing queue.
* wp_cron interval: Choose how often wp_cron is started (in seconds)
= Additional =
For apache a .htaccess file with `deny from all` is generated in mail storage dir.
For all systems that cannot read .htaccess you should deny access to `wp-content/uploads/smtp-mailing-queue/`.
= Usage =
After activation mails automatically queue to be processed by wp_cron or cronjob. SMTP will be used if settings set up.
Tools:
* Test Mail: Test your email settings by sendig directly or adding test mail into queue.
* Process Queue: Start queue processing manually. Your set queue limit will still be obeyed, if set.
* List Queue: Show all mails in mailing queue.
== Frequently Asked Questions ==
= Can this plugin be used to send emails via SMTP? =
Yes.
= Do I have to use SMTP? =
No (just leave SMTP settings empty)
= Can anyone read the mails in a browser =
Not if you followed the advanced installation.
= Can I just use the SMTP function and sent immediatly without queuing? =
Not at the moment, but this will be added in a future release.
= I like this plugin. Can I buy you a beer? =
Sure, just [head over here](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=KRBU2JDQUMWP4)
== Screenshots ==
1. SMTP Setting
2. Advanced Settings
3. Tools
== Changelog ==
= 1.0.6 =
* Bugfix: Emails that couldn't be sent now really don't stop the queue anymore.
= 1.0.5 =
* Feature/Bugfix: Added tools section for emails that couldn't be sent. Those emails will no longer stop the entire queue.
= 1.0.4 =
* Feature: Added advanced option to only queue mails if more than one recipient is set.
= 1.0.3 =
* Feature: Added warning on install if PHP version <5.4
* Bugfix: Use of WordPress URL instead of host name (Thanks to [mgoncharenko](https://github.com/mgoncharenko) for this fix)
= 1.0.2 =
* Bugfix: PHP warning for empty headers in list tool
* Bugfix: Wrong SMTP password stored at first save
= 1.0.1 =
* Bugfix: timeout at slow SMTP servers
= 1.0.0 =
* First commit of the plugin