SendGridEmailHelper Class Reference

Inheritance diagram for SendGridEmailHelper:

Public Member Functions
	init ()
	loadDefaultFromAndToAddresses ()
	setApiSettings ()
Public Member Functions inherited from ZurmoBaseEmailHelper
	processMessageAsFailure (EmailMessage $emailMessage, $useSQL=false)
	resolveFromAddressByUser (User $user)
	sendQueued ($count=null, $excludePausedCampaignMessages=true)
	send (EmailMessage &$emailMessage, $useSQL=false, $validate=true)
	resolveFromNameForSystemUser ($userToSendMessagesFrom)

Static Public Member Functions
static	resolveRecipientAddressesByType ($emailMessage)
Static Public Member Functions inherited from ZurmoBaseEmailHelper
static	resolveDefaultEmailAddress ($defaultEmailAddress)
static	resolveAndGetDefaultFromAddress ()
static	setDefaultFromAddress ($defaultFromAddress)
static	resolveAndGetDefaultTestToAddress ()
static	setDefaultTestToAddress ($defaultTestToAddress)

Data Fields
	$apiUsername
	$apiPassword
	$fromName
	$fromAddress
	$defaultFromAddress
	$defaultTestToAddress

Protected Member Functions
	loadApiSettings ()

Protected Attributes
	$settingsToLoad

Detailed Description

Helper class consisting of functions related to sending emails using sendgrid.

Definition at line 40 of file SendGridEmailHelper.php.

Member Function Documentation

init

(

)

Called once per page load, will load up outbound settings from the database if available. (non-PHPdoc)

See Also

CApplicationComponent::init()

Definition at line 93 of file SendGridEmailHelper.php.

loadDefaultFromAndToAddresses

(

)

Used to load defaultFromAddress and defaultTestToAddress

Definition at line 102 of file SendGridEmailHelper.php.

loadApiSettings ( )

protected

Loads api settings.

Returns

void

Definition at line 112 of file SendGridEmailHelper.php.

setApiSettings

(

)

Set api settings into the database.

Definition at line 142 of file SendGridEmailHelper.php.

static resolveRecipientAddressesByType (   $emailMessage )

static

Resolve recipient address by type.

Parameters

EmailMessage

$emailMessage

Returns

array

Definition at line 163 of file SendGridEmailHelper.php.

Field Documentation

$settingsToLoad

protected

Initial value:

= array(
            'apiUsername',
            'apiPassword'
        )

Definition at line 71 of file SendGridEmailHelper.php.

---

The documentation for this class was generated from the following file:

• /home/apizurmo/zurmo/app/protected/modules/sendGrid/components/SendGridEmailHelper.php