Documentation

Once installation is completed, the plugin has added a new:

• CB Invites Tab. You can change its position and display type as needed.
• Field invite_code that is set to show on registration and provides the registration invite code when the invited user has used the received link.
• A component button “Invites” that lets you keep track, monitor and administer all your website invitations from backend administration page.
• A button "New Invite" on user's profile as well as a list with invitations and their state.

 Go to CB Plugin Manager publish it and configure as follow.

Global (tab)

The Global tab of your CB Conditional plugin configuration has the following parameters:

• Publish:
  Select the state (published/unpublished)
• Access Level:
  Only users with this access level will be able to see the plugin and any tabs or fields associated with it.
• Ordering:
  Order determines what order the plugin will load in.

Parameters (tab)

The Parameters tab has a number of sub-tabs.

General (sub tab)

This tab has the following parameters:

• Template: 
  Is set to Default. Select template to be used for all of CB Invites. If template is incomplete then missing files will be used from the default template. Template files can be located at the following location: components/com_comprofiler/plugin/user/plug_cbinvites/templates/.
• Class:
  Optionally add a class suffix to surrounding DIV encasing all of CB Invites.

Invites (sub tab)

• Create Access:
  Select invite create access. Access determines who can send invites. The group selected as well as those above it will have access (e.g. Registered will also be accessible to Author). Moderators are exempt from this configuration.
• Create Limit:
  Input number of invites each individual user is limited to have active at any given time (accepted invites do not count towards this limit). If blank allow unlimited invites. Moderators are exempt from this configuration.
• Resend Delay:
  Input number of days after invite sent to allow resending (accepted invites do not permit resending). If blank disable resending invites. Moderators are exempt from this configuration. Default is 7
• Multiple Invites:
  Enable or disable the usage of multiple emails in a single invite using a comma separated list (e.g. email1@domain.com, email2@domain.com, email3@domain.com). Moderators are exempt from this configuration.
• Duplicate Invites:
  Enable or disable the usage of duplicate invites to the same address. Moderators are exempt from this configuration.
• Connection:
  Select connection method from inviter to invitee. Options are: Disabled / Pending / Auto Connection
• Editor:
  Select invite body editor. Options are: Plain text / HTML Text / WYSIWYG (editor)
• Captcha:
  Enable or disable usage of captcha on invites. Requires latest CB AntiSpam to be installed and published. Moderators are exempt from this configuration.

Email (sub tab)

• From Name:
  Input a substitution supported from name to be sent with all invites (e.g. My Awesome CB Site!). If left blank will default to users name. If specified a replyto name will be added as the users name.
• From Address:
  Input a substitution supported from address to send all invites from (e.g. general@domain.com). If left blank will default to users email. If specified a replyto address will be added as the users email.

Important Note: It's possible your mailer won't allow outbound emails from external domains and you'll need to configure that. (Global Configuration – Server – Mail System)

• CC Address:
  Input a substitution supported CC address (e.g. ); multiple addresses supported with comma separated list (e.g. email1@domain.com, email2@domain.com, email3@domain.com).
• BCC Address:
  Input a substitution supported BCC address (e.g. ); multiple addresses supported with comma separated list (e.g. email1@domain.com, email2@domain.com, email3@domain.com).
• Subject Prefix:
  Input substitution supported prefix of invite email subject.
  Additional substitutions supported: [site], [sitename], [path], [itemid], [register], [profile], [code], and [to].
• Body Header:
  Input substitution supported header of invite email body.
  Additional subsitutions supported: [site], [sitename], [path], [itemid], [register], [profile], [code], and [to].
• Body footer:
  Input substitution supported footer of invite email body.
  Additional subsitutions supported: [site], [sitename], [path], [itemid], [register], [profile], [code], and [to].
• Attachment:
  Input a substitution supported Attachment address (e.g. [cb_myfile]); multiple addresses supported with comma separated list (e.g. /home/username/public_html/images/file1.zip,[path]/file2.zip, http://www.domain.com/file3.zip).
  Additional substitutions supported: [site], [sitename], [path], [itemid], [register], [profile], [code], and [to].