include/OutboundEmail/OutboundEmail.php

Show:

inherited

Classes
- \OutboundEmail

Table of Contents

\OutboundEmail
jump to top

Package: SugarCRM

Outbuound email management

Api

Properties


                 $db= ''

Necessary

Details

Type: n/a


                 $field_defs= 'array(
		'id',
		'name',
		'type',
		'user_id',
		'mail_sendtype',
		'mail_smtptype',
		'mail_smtpserver',
		'mail_smtpport',
		'mail_smtpuser',
		'mail_smtppass',
		'mail_smtpauth_req',
		'mail_smtpssl',
	)'

Default value

array(
		'id',
		'name',
		'type',
		'user_id',
		'mail_sendtype',
		'mail_smtptype',
		'mail_smtpserver',
		'mail_smtpport',
		'mail_smtpuser',
		'mail_smtppass',
		'mail_smtpauth_req',
		'mail_smtpssl',
	)

Details

Type: n/a


                 $id= ''

Columns

Details

Type: n/a


                 $mail_sendtype= ''

Details

Type: n/a


                 $mail_smtpauth_req= ''

Details

Type: n/a


                 $mail_smtpdisplay= ''

Details

Type: n/a


                 $mail_smtppass= ''

Details

Type: n/a


                 $mail_smtpport= '25'

Default value25Details

Type: n/a


                 $mail_smtpserver= ''

Details

Type: n/a


                 $mail_smtpssl= ''

Details

Type: n/a


                 $mail_smtptype= ''

Details

Type: n/a


                 $mail_smtpuser= ''

Details

Type: n/a


                 $name= ''

Details

Type: n/a


                 $new_with_id= 'FALSE'

Default valueFALSEDetails

Type: n/a


                 $type= ''

Details

Type: n/a


                 $user_id= ''

Details

Type: n/a

Methods

OutboundEmail(
          
          )
        
        :
          void

Sole constructor

_getOutboundServerDisplay(
           $smtptype,  $smtpserver
          )
        
        :
          void

Parameters

Name	Type	Description
$smtptype
$smtpserver

createUserSystemOverrideAccount(
          string $user_id, string $user_name
              =
              "", string $user_pass
              =
              ""
          )
        
        :
          void

Duplicate the system account for a user, setting new parameters specific to the user.

Parameters

Name	Type	Description
$user_id	string
$user_name	string
$user_pass	string

delete(
          
          )
        
        :
          void

Deletes an instance

doesUserOverrideAccountRequireCredentials(
          \unknown_type $user_id
          )
        
        :
          \unknown

Determines if a user needs to set their user name/password for their system override account.

Parameters

Name	Type	Description
$user_id	\unknown_type

Returns

Type	Description
\unknown

getAssociatedInboundAccounts(
          \SugarBean $user
          )
        
        :
          array

Retrieve an array containing inbound emails ids for all inbound email accounts which have their outbound account set to this object.

Parameters

Name	Type	Description
$user	\SugarBean

Returns

Type	Description
array

getInboundMailerSettings(
          object $user, string $mailer_id
              =
              '',  $ieId
              =
              ''
          )
        
        :
          object

Retrieves a cascading mailer set

Parameters

Name	Type	Description
$user	object	user
$mailer_id	string	mailer_id
$ieId

Returns

Type	Description
object

getMailerByName(
          \User $user, string $name
          )
        
        :
          \OutboundEmail | false

Get mailer for current user by name

Parameters

Name	Type	Description
$user	\User
$name	string

Returns

Type	Description
\OutboundEmail \| false

getSystemMailerSettings(
          
          )
        
        :
          void

Retrieves the system's Outbound options

getUserMailerSettings(
          object $user, string $mailer_id
              =
              '',  $ieId
              =
              ''
          )
        
        :
          object

Retrieves a cascading mailer set

Parameters

Name	Type	Description
$user	object	user
$mailer_id	string	mailer_id
$ieId

Returns

Type	Description
object

getUserMailers(
           $user
          )
        
        :
          void

Retrieves name value pairs for opts lists

Parameters

Name	Type	Description
$user

getUsersMailerForSystemOverride(
          String $user_id
          )
        
        :
          void

Retrieves the mailer for a user if they have overriden the username and password for the default system account.

Parameters

Name	Type	Description
$user_id	String

isAllowUserAccessToSystemDefaultOutbound(
          
          )
        
        :
          void

Determine if the user is allowed to use the current system outbound connection.

populateFromPost(
          
          )
        
        :
          void

removeUserOverrideAccounts(
          
          )
        
        :
          void

Remove all of the user override accounts.

retrieve(
          string $id
          )
        
        :
          object

Populates this instance

Parameters

Name	Type	Description
$id	string

Returns

Type	Description
object	$this

saves an instance

saveSystem(
          
          )
        
        :
          void

Saves system mailer. Presumes all values are filled.

updateUserSystemOverrideAccounts(
          
          )
        
        :
          void

Update the user system override accounts with the system information if anything has changed.

include/OutboundEmail/OutboundEmail.php

\OutboundEmailjump to top

Properties

Methods

\OutboundEmail
jump to top