LeKoala\SparkPost\SparkPostHelper
This configurable class helps decoupling the api client from SilverStripe
Synopsis
class SparkPostHelper
{
- // constants
- const FROM_SITECONFIG = "SiteConfig";
- const FROM_ADMIN = "Admin";
- const FROM_DEFAULT = "Default";
- // members
- protected static SparkPostApiClient $client;
- // methods
- public static SwiftMailer getMailer()
- public static string getApiKey()
- public static SparkPostApiClient getClient()
- public static SparkPostApiClient getMasterClient()
- public static string getLogFolder()
- public static void init()
- public static void getEnvApiKey()
- public static void getEnvMasterApiKey()
- public static void getEnvSendingDisabled()
- public static void getEnvEnableLogging()
- public static void getEnvSubaccountId()
- public static void getEnvForceSender()
- public static SwiftMailer registerTransport()
- public static void forceAdminEmailOverride()
- public static boolean isEmailDomainReady()
- public static string resolveDefaultFromEmail()
- public static string resolveDefaultFromEmailType()
- public static string|false getSenderFromSiteConfig()
- public static boolean isAdminEmail()
- public static boolean isDefaultEmail()
- public static string resolveDefaultToEmail()
- public static string createDefaultEmail()
Hierarchy
Uses
- SilverStripe\Core\Config\Configurable
Constants
Name | Value |
---|---|
FROM_SITECONFIG | "SiteConfig" |
FROM_ADMIN | "Admin" |
FROM_DEFAULT | "Default" |
Members
protected
- $client
—
LeKoala\SparkPost\Api\SparkPostApiClient
Client instance
Methods
public
- createDefaultEmail() — Create a sensible default address based on domain name
- forceAdminEmailOverride() — Update admin email so that we use our config email
- getApiKey()
- getClient() — Get the api client instance
- getEnvApiKey()
- getEnvEnableLogging()
- getEnvForceSender()
- getEnvMasterApiKey()
- getEnvSendingDisabled()
- getEnvSubaccountId()
- getLogFolder() — Get the log folder and create it if necessary
- getMailer() — Get the mailer instance
- getMasterClient() — Get the api client instance
- getSenderFromSiteConfig()
- init() — Process environment variable to configure this module
- isAdminEmail()
- isDefaultEmail()
- isEmailDomainReady() — Check if email is ready to send emails
- registerTransport() — Register the transport with the client
- resolveDefaultFromEmail() — Resolve default send from address
- resolveDefaultFromEmailType() — Returns what type of default email is used
- resolveDefaultToEmail() — Resolve default send to address