lcOpenInviterPlugin - 0.9.2

A contact grabber plugin.

You are currently browsing
the website for symfony 1

Visit the Symfony2 website


« Back to the Plugins Home

Signin


Forgot your password?
Create an account

Tools

Stats

advanced search
Information Readme Releases Changelog Contribute
Show source

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 more than 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)

Plugin Requirements

Get a username and private key (both required for the installation task) by signing up in www.openinviter.com.

It's quick and easy.

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

  • Configure the plugin by running the plugin task:

    $ symfony open-inviter:install --username=your-username  --key=your-private-key
    
  • example:

    $ symfony open-inviter:install --username=elieandraos  --key=ee7968edc9580e1578c6bd7ad54fad4a
    

this task sets the username and private key you entered and checks your sever configuration (php version, curl installation, DOM Element installation, cookie path ...) if everything is okay, a log file will be written.

make sure to enter the right username and key because it's not yet validated with openinviter servers

  • 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

  • integrate the hosted solutions provided by openinviter for better performance and less load on the server
  • integrate the stats: how many users have imported contacts, how many contacts were imported or how many messages were sent
  • i18n forms translation
  • check if the username and key are valid in the installation-task
  • ajax form