lcOpenInviterPlugin
0.9.0beta
for sf 1.2 MIT
the plug-in is fully working but still in beta version, awaiting for feedbacks and bugs reporting
Third party libraries:
the classes were taken from the open source project openinviter
Developers
| Name |
Status |
Email |
Elie Andraos |
lead |
moc.docstel <<ta>> soardna.eile
|
License
Copyright (c) LetsCod (www.letscod.com)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
lcOpenInviterPlugin
The lcOpenInviterPlugin is a symfony plugin that allows users to grab their contacts from different e-mail providers (gmail, hotmail, yahoo ...) and social sites (facebook, hi5, flickr ...) then send them e-mails and messages.
The total of available providers and social sites is 86
This plugin is developed by LetsCod.
Server Requirements
- CURL extension for php
- DOM Element support for php
If you're on windows OS, you should create an empty folder "tmp" for cookie storage. (for example, if you're using wamp, create the folder C:\tmp)
Installation
Install the plugin
$ symfony plugin:install --stability=beta lcOpenInviterPlugin
Publish the plugin assets (css and js):
$ symfony plugin:publish-assets
Clear you cache
$ symfony cc
Configuring your plugin
this task checks your sever configuration (php version, curl
installation, DOM Element installation, cookie path ...)
if everything is okay, a log file will be written
Enable the module and helper in your application settings.yml
[yml]
all:
.settings:
enabled_modules: [openInviter]
standard_helpers: [openInviter]
Configure the e-mail text and providers in your application app.yml
[yml]
all:
lcOpenInviter:
wish-list:
providers: ["hotmail","gmail", "aol", "facebook", "flickr", "hi5","indiatimes", "operamail", "tagged", "yahoo"]
message:
subject: "is inviting you to join letscod developers"
body: "Check our recruitment page"
footer: "LetsCod"
The user wishlist
If the wish list is not set, a default wish list of "Gmail, hotmail and yahoo" is provided
If the wishlist is set to all, it will return all the available providers
[yml]
all:
lcOpenInviter:
wish-list:
providers: [all]
Displaying the form
[php]
<?
echo link_to("invite", "openInviterHome");
Available e-mail providers
- AOL
- Gmail
- Hotmail
- Indiatimes
- Operamail
- Yahoo Mail
- Doramail
- Fastmail
- inbox
- mail_com
- and many more...
Available social-sites
- Facebook
- Flickr
- hi5
- Tagged
- Twitter
- Linked in
- Myspace
- Friendfeed
- Faces
- Skyrock
- Friendster
- Xanga
- and many more...
The Auto-updates
As each service and provider updates their url of getting contacts for their own security reasons, a task has been created
to do update the plugin's classes.
$ symfony open-inviter:auto-update
You can run this task manually to get the updates, but the best way would be to make a cronjob that runs this task twice a day
(every 12 hours) for the perfect balance between server load and autoupdate frequency.
I use it
If you do like the plugin, and think it helps the community, do not hesitate to click I use it , so it could be more trusted
and spreaded fast.
Feedback
Feel free to send your feedbacks, bug reports or suggestions to Elie Andraos at symfony-plugins@letscod.com
TODO
- i18n forms translation
- Enable the plugin user to have his own username and private key provided by the openInviter source project
- ajax form