All Data Structures Functions Variables Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions
EmailArchivingJob Class Reference
Inheritance diagram for EmailArchivingJob:
ImapBaseJob BaseJob

Public Member Functions

 saveEmailMessage (ImapMessage $message)
 
- Public Member Functions inherited from ImapBaseJob
 run ()
 
- Public Member Functions inherited from BaseJob
 run ()
 
 getErrorMessage ()
 
 setMessageLogger (MessageLogger $messageLogger)
 
 getMessageLogger ()
 

Static Public Member Functions

static getDisplayName ()
 
static getType ()
 
static getRecommendedRunFrequencyContent ()
 
- Static Public Member Functions inherited from BaseJob
static shouldLoadJobQueueOnCleanupAndFallback ()
 
static getDisplayName ()
 
static getType ()
 
static resolveJobsForQueue ()
 
static loadJobQueue ()
 
static getRecommendedRunFrequencyContent ()
 
static getDefaultMessageLogger ()
 
static getRunTimeThresholdInSeconds ()
 
static showInJobManagerToRunManually ()
 
static jobExecutionInQueueDependsOnTime ()
 

Protected Member Functions

 processMessage (ImapMessage $message)
 
 getLastImapDropboxCheckTime ()
 
 setLastImapDropboxCheckTime ($time)
 
 resolveImapObject ()
 
 resolveMessageSubjectAndContentAndSendSystemMessage ($messageType, $originalMessage)
 
- Protected Member Functions inherited from ImapBaseJob
 resolveImapObject ()
 
 getLastImapDropboxCheckTime ()
 
 setLastImapDropboxCheckTime ($time)
 
 processMessage (ImapMessage $message)
 
 addDebugMessageBeforeFinishing ($numberOfProcessedMessages, $totalNumberOfMessages, $totalExecutionTime=null)
 

Additional Inherited Members

- Data Fields inherited from ImapBaseJob
const CONFIG_DEFAULT_BATCH_VALUE = 100
 
const MAX_EXECUTION_TIME = 1200
 
- Data Fields inherited from BaseJob
const JOB_QUEUE_PAGE_SIZE = 100
 
- Static Protected Member Functions inherited from ImapBaseJob
static reconnectToDatabase ()
 
- Protected Attributes inherited from ImapBaseJob
 $imapManager
 
- Protected Attributes inherited from BaseJob
 $errorMessage
 
- Static Protected Attributes inherited from BaseJob
static $loadJobQueueOnCleanupAndFallback = false
 

Detailed Description

A job for retrieving emails from dropbox(catch-all) folder

Definition at line 40 of file EmailArchivingJob.php.

Member Function Documentation

static getDisplayName ( )
static
Returns
Translated label that describes this job type.

Definition at line 45 of file EmailArchivingJob.php.

static getType ( )
static
Returns
The type of the NotificationRules

Definition at line 53 of file EmailArchivingJob.php.

resolveMessageSubjectAndContentAndSendSystemMessage (   $messageType,
  $originalMessage 
)
protected

Resolve system message to be sent, and send it

Parameters
string$messageType
ImapMessage$originalMessage
Returns
boolean
Exceptions
NotSupportedException

Definition at line 94 of file EmailArchivingJob.php.

saveEmailMessage ( ImapMessage  $message)

Save email message This method should be protected, but we made it public for unit testing, so don't call it outside this class.

Parameters
ImapMessage$message
Exceptions
NotSupportedException
Returns
boolean

Definition at line 149 of file EmailArchivingJob.php.


The documentation for this class was generated from the following file:
Generated on Mon Jan 27 2020 07:10:37