include/OutboundEmail/OutboundEmail.php
Package: SugarCRMOutbuound email management
- Api
-
Properties
$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 valuearray(
'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
Methods
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 |
|
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 |
|
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
getMailerByName(
\User $user, string $name
)
:
\OutboundEmail | false
Get mailer for current user by name
Parameters
Name |
Type |
Description |
$user |
\User |
|
$name |
string |
|
Returns
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
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 |
|
getValues(
array $keys
)
:
array
Generate values for saving into outbound_emails table
Parameters
Name |
Type |
Description |
$keys |
array |
|
Returns