include/SugarRouting/baseActions.php

Show:

inherited

Table of Contents

Functions

copy_mail(
          array $action,  $bean,  $ie,  $copy
              =
              true
          )
        
        :
          bool

Copies an email to a folder

Parameters

Name	Type	Description
$action	array	Array of options and criteria for the action current being processed
$bean
$ie
$copy

Returns

Type	Description
bool

delete_bean(
          array $action, object $bean
          )
        
        :
          bool

Logically deletes a SugarBean derivative

Parameters

Name	Type	Description
$action	array	Array of options and criteria for the action current being processed
$bean	object	SugarBean

Returns

Type	Description
bool

delete_file(
          array $action, string $file
          )
        
        :
          bool

unlinks a file in the cache directory

Parameters

Name	Type	Description
$action	array	Array of options and criteria for the action current being processed
$file	string	file Path to file

Returns

Type	Description
bool

delete_mail(
          array $action, object $bean, string $ie
          )
        
        :
          bool

Deletes mail from a mailserver

Parameters

Name	Type	Description
$action	array	Array of options and criteria for the action current being processed
$bean	object	ie InboundEmail instance fully retrieved
$ie	string	uid UID of email on mail server

Returns

Type	Description
bool

forward(
          array $action,  $bean,  $ie
          )
        
        :
          void

Marks an email Unread

Parameters

Name	Type	Description
$action	array	Array of options and criteria for the action current being processed
$bean
$ie

mark_flag(
          array $action,  $bean,  $ie, string $flag
          )
        
        :
          void

Generic flag-setting

Parameters

Name	Type	Description
$action	array	Array of options and criteria for the action current being processed
$bean
$ie
$flag	string	Flag to set

mark_flagged(
          array $action,  $bean,  $ie
          )
        
        :
          void

Marks an email Unread

Parameters

Name	Type	Description
$action	array	Array of options and criteria for the action current being processed
$bean
$ie

mark_read(
          array $action,  $bean,  $ie
          )
        
        :
          void

Marks an email Read

Parameters

Name	Type	Description
$action	array	Array of options and criteria for the action current being processed
$bean
$ie

mark_unread(
          array $action,  $bean,  $ie
          )
        
        :
          void

Marks an email Unread

Parameters

Name	Type	Description
$action	array	Array of options and criteria for the action current being processed
$bean
$ie

move_mail(
          array $action,  $bean, object $ie
          )
        
        :
          bool

Moves an email to a folder

Parameters

Name	Type	Description
$action	array	Array of options and criteria for the action current being processed
$bean
$ie	object	InboundEmail instance

Returns

Type	Description
bool

reply(
          array $action,  $bean,  $ie
          )
        
        :
          void

Marks an email Unread

Parameters

Name	Type	Description
$action	array	Array of options and criteria for the action current being processed
$bean
$ie