EmailArchivingJob Class Reference

Inheritance diagram for EmailArchivingJob:
ImapBaseJob BaseJob

Public Member Functions

 saveEmailMessage (ImapMessage $message)

Static Public Member Functions

static getDisplayName ()
static getType ()
static getRecommendedRunFrequencyContent ()

Protected Member Functions

 processMessage (ImapMessage $message)
 getLastImapDropboxCheckTime ()
 setLastImapDropboxCheckTime ($time)
 resolveImapObject ()
 resolveMessageSubjectAndContentAndSendSystemMessage ($messageType, $originalMessage)
 createEmailMessageSender ($senderInfo, $userCanAccessContacts, $userCanAccessLeads, $userCanAccessAccounts)
 createEmailMessageRecipient ($recipientInfo, $userCanAccessContacts, $userCanAccessLeads, $userCanAccessAccounts)
 createEmailAttachment ($attachment)

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.

Reimplemented from BaseJob.

Definition at line 45 of file EmailArchivingJob.php.

static getType (  )  [static]
Returns:
The type of the NotificationRules

Reimplemented from BaseJob.

Definition at line 53 of file EmailArchivingJob.php.

static getRecommendedRunFrequencyContent (  )  [static]
Returns:
string content specifying how often this job should be run as a scheduled task.

Reimplemented from BaseJob.

Definition at line 58 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.

createEmailMessageSender ( senderInfo,
userCanAccessContacts,
userCanAccessLeads,
userCanAccessAccounts 
) [protected]

Create EmailMessageSender

Parameters:
array $senderInfo
boolean $userCanAccessContacts
boolean $userCanAccessLeads
boolean $userCanAccessAccounts
Returns:
EmailMessageSender

Definition at line 150 of file EmailArchivingJob.php.

createEmailMessageRecipient ( recipientInfo,
userCanAccessContacts,
userCanAccessLeads,
userCanAccessAccounts 
) [protected]

Create EmailMessageRecipient

Parameters:
array $recipientInfo
boolean $userCanAccessContacts
boolean $userCanAccessLeads
boolean $userCanAccessAccounts
Returns:
EmailMessageRecipient

Definition at line 182 of file EmailArchivingJob.php.

createEmailAttachment ( attachment  )  [protected]

Create FileModel

Parameters:
array $attachment
Returns:
FileModel

Definition at line 213 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 242 of file EmailArchivingJob.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Fri Apr 28 07:10:24 2017