modules/SNIP/SugarSNIP.php

Show:

inherited

Classes
- \SugarSNIP

Table of Contents

\SugarSNIP
jump to top

Package: SugarCRM

SNIP data handling implementation

Constants

 
                SNIP_USER
                = 'SNIPuser'

 
                OAUTH_KEY
                = 'SNIPOAuthKey'

 
                DEFAULT_URL
                = 'http://ease.sugarcrm.com:20010/'

Properties

array
                 $config= ''

Sugar configuration

Details

Type: array

\SugarSNIP
                 $instance= ''

static

Singleton instance

Details

Type: \SugarSNIP

mixed
                 $last_result= ''

Last REST call result

Details

Type: mixed

\OAuthToken
                 $token= ''

SNIP OAuth token

Details

Type: \OAuthToken

\User
                 $user= ''

SNIP user

Details

Type: \User

Methods

__construct(
          
          )
        
        :
          void

assignUser(
          \Email $email, string $username
              =
              null
          )
        
        :
          void

Assign the email to proper user

Parameters

Name	Type	Description
$email	\Email
$username	string

assignUserTeam(
          \SugarBean $email, string $userid
          )
        
        :
          void

static

Assign user's private team to an email

Parameters

Name	Type	Description
$email	\SugarBean	Email object
$userid	string	User ID

callRest(
          string $name, string $params
              =
              array(), bool $json
              =
              false,  $connectionfailed
              =
              false
          )
        
        :
          bool

Generic REST call to SNIP instance

Parameters

Name	Type	Description
$name	string	function to call
$params	string	parameters
$json	bool	encode params as JSON in data var or send as query?
$connectionfailed

Returns

Type	Description
bool	Success?

createNote(
          array $data, \Email $email
          )
        
        :
          void

Create a new Note object

Parameters

Name	Type	Description
$data	array	Note data
$email	\Email	parent email

createObject(
          \Email $email
          )
        
        :
          void

Create objects from createdef definitions Example definition: $createdef['email@host.com']['Contacts'] = array( 'fields' => array( 'email1' => '{from_addr}', 'last_name' => '{from_name}', 'description' => 'created from {subject}', 'lead_source' => 'Email', ), ); Supported variables: - from - from_addr - from_name - subject - date - description - description_html - message_id - email_id

Parameters

Name	Type	Description
$email	\Email

createPurchaseURL(
           $snipuser
          )
        
        :
          string

Generate the url that the user can visit to purchase SNIP.

Parameters

Name	Type	Description
$snipuser

Returns

Type	Description
string	the generated url

createSnipToken(
          \User $user
          )
        
        :
          void

Create oauth token for the SNIP user

Parameters

Name	Type	Description
$user	\User

createSnipUser(
          
          )
        
        :
          \User

Create user to use for SNIP imports

Returns

Type	Description
\User

deleteSnipTokens(
          \User $user
          )
        
        :
          void

Create oauth token for the SNIP user

Parameters

Name	Type	Description
$user	\User

getInstance(
          
          )
        
        :
          \SugarSNIP

static

Get instance of the SNIP client

Returns

Type	Description
\SugarSNIP	SNIP client instance

getKey(
          
          )
        
        :
          void

getLastError(
          
          )
        
        :
          string

Returns last error that happened to SNIP

Returns

Type	Description
string

getLastResult(
          
          )
        
        :
          mixed

Get result of the last REST call

Returns

Type	Description
mixed

getSnipConsumer(
          
          )
        
        :
          \OAuthKey

Get consumer key belonging to SNIP

Returns

Type	Description
\OAuthKey

getSnipEmail(
          
          )
        
        :
          string

Get SNIP email address

Returns

Type	Description
string

getSnipToken(
          
          )
        
        :
          \OAuthToken

Get OAuth token for SNIP user

Returns

Type	Description
\OAuthToken

getSnipURL(
          
          )
        
        :
          string

Get SNIP instance URL

Returns

Type	Description
string

getSnipUser(
          
          )
        
        :
          \User

Get user used for SNIP imports

Returns

Type	Description
\User

getStatus(
          
          )
        
        :
          array

Get status of the SNIP installation

Returns

Type	Description
array	Returns an associative array ('status'=>string, 'message'=>string\|null), with 'status' as one of the following: - purchased (instance has snip license) - notpurchased (instance does not have snip license) - down (snip server unresponsive) - purchased_error (instance has snip license, server is not down, but server detects something is wrong). Iff 'status' is 'purchased_error', 'message' will be the error returned by the server. Otherwise $message will be NULL.

Type

Description

array

Returns an associative array ('status'=>string, 'message'=>string|null), with 'status' as one of the following: - purchased (instance has snip license) - notpurchased (instance does not have snip license) - down (snip server unresponsive) - purchased_error (instance has snip license, server is not down, but server detects something is wrong). Iff 'status' is 'purchased_error', 'message' will be the error returned by the server. Otherwise $message will be NULL.

getURL(
          
          )
        
        :
          string

Get instance callback URL

Returns

Type	Description
string

importEmail(
          array $email
          )
        
        :
          void

Imports an email from the SNIP serice

Parameters

Name	Type	Description
$email	array

isActive(
          
          )
        
        :
          bool

Check if SNIP interface is active

Returns

Type	Description
bool

processEmailAttachment(
           $data,  $email
          )
        
        :
          void

Save a snip email attachment and associated it to a parent email. Content is base64 encoded.

Parameters

Name	Type	Description
$data
$email

registerSnip(
          
          )
        
        :
          mixed

Returns

Type	Description
mixed	server response

relateRecords(
          \Email $e
          )
        
        :
          void

Relate records to this email

Parameters

Name	Type	Description
$e	\Email

setClient(
          \SugarHttpClient $client
          )
        
        :
          void

Set client to talk to SNIP

Parameters

Name	Type	Description
$client	\SugarHttpClient

setSnipEmail(
          string $email
          )
        
        :
          void

Set SNIP email address

Parameters

Name	Type	Description
$email	string

setSnipURL(
          string $url
          )
        
        :
          void

Set SNIP instance URL.

Parameters

Name	Type	Description
$url	string

splitEmailAddress(
          \Email $email, string $addr
          )
        
        :
          array

Split email address into name & address part

Parameters

Name	Type	Description
$email	\Email
$addr	string

Returns

Type	Description
array

unregisterSnip(
          
          )
        
        :
          mixed

Unregister SNIP from server

Returns

Type	Description
mixed	server response

modules/SNIP/SugarSNIP.php

\SugarSNIPjump to top

Constants

Properties

Methods

\SugarSNIP
jump to top