LeKoala\Mailgun\MailgunAdmin
Allow you to see messages sent through the api key used to send messages
- Author: LeKoala <thomas@lekoala.be>
Synopsis
class MailgunAdmin
extends LeftAndMain
implements
PermissionProvider
{
- // constants
- const MESSAGE_CACHE_MINUTES = 5;
- const WEBHOOK_CACHE_MINUTES = 1440;
- const SENDINGDOMAIN_CACHE_MINUTES = 1440;
- // members
- private static string $menu_title = "Mailgun";
- private static string $url_segment = "mailgun";
- private static string $menu_icon = "lekoala/silverstripe-mailgun:images/mailgun-icon.png";
- private static string $url_rule = '/$Action/$ID/$OtherID';
- private static array $allowed_actions = ;
- private static boolean $cache_enabled = true;
- protected Exception $lastException;
- protected ViewableData $currentMessage;
- private static array $dependencies = ;
- public LoggerInterface $logger;
- public CacheInterface $cache;
- // methods
- public void init()
- public void index()
- public void settings()
- public Session getSession()
- protected GridFieldDataColumns getGridFieldDataColumns()
- public CMSForm getEditForm()
- public LoggerInterface getLogger()
- public CacheInterface getCache()
- public boolean getCacheEnabled()
- protected array getCachedData()
- public array getParams()
- public mixed getParam()
- public void SearchFields()
- public void SearchForm()
- public void doSearch()
- public ArrayList|string Messages()
- public array providePermissions()
- protected string MessageHelper()
- protected string ButtonHelper()
- public bool IsAdmin()
- public bool canView()
- public bool CanConfigureApi()
- public array WebhookInstalled()
- public ArrayData WebhookDetails()
- public FormField WebhookTab()
- public string WebhookUrl()
- public FormField InstallHookForm()
- public void doInstallHook()
- public FormField UninstallHookForm()
- public void doUninstallHook()
- public bool SendingDomainInstalled()
- public FormField DomainTab()
- public string InboundUrl()
- public boolean|string getDomainFromHost()
- public boolean|string getDomainFromEmail()
- public boolean|string getDomain()
- public FormField InstallDomainForm()
- public void doInstallDomain()
- public FormField UninstallDomainForm()
- public void doUninstallDomain()
Hierarchy
Extends
- SilverStripe\Admin\LeftAndMain
Implements
- SilverStripe\Security\PermissionProvider
Constants
Name | Value |
---|---|
MESSAGE_CACHE_MINUTES | 5 |
WEBHOOK_CACHE_MINUTES | 1440 |
SENDINGDOMAIN_CACHE_MINUTES | 1440 |
Members
private
- $allowed_actions
- $cache_enabled — boolean
- $dependencies
—
array
Inject public dependencies into the controller - $url_rule
- $url_segment
protected
- $currentMessage — SilverStripe\View\ViewableData
- $lastException — Exception
public
Methods
protected
- ButtonHelper() — Button helper
- MessageHelper() — Message helper
- getCachedData() — A simple cache helper
- getGridFieldDataColumns()
public
- CanConfigureApi()
- DomainTab() — Get content of the tab
- InboundUrl()
- InstallDomainForm() — Install domain form
- InstallHookForm() — Install hook form
- IsAdmin() — A template accessor to check the ADMIN permission
- Messages() — List of messages events
- SearchFields()
- SearchForm()
- SendingDomainInstalled() — Check if sending domain is installed
- UninstallDomainForm() — Uninstall domain form
- UninstallHookForm() — Uninstall hook form
- WebhookDetails() — Hook details for template
- WebhookInstalled() — Check if webhook is installed
- WebhookTab() — Get content of the tab
- WebhookUrl()
- canView() — Check the permission for current user
- doInstallDomain()
- doInstallHook()
- doSearch()
- doUninstallDomain()
- doUninstallHook()
- getCache() — Get the cache
- getCacheEnabled()
- getDomain() — Get domain
- getDomainFromEmail() — Get domain from admin email
- getDomainFromHost() — Get domain name from current host
- getEditForm() — Returns a GridField of messages
- getLogger() — Get logger
- getParam() — Get a raw value for a single param Useful for retrieving values as set by user
- getParams() — Values are mixed with default values and formatted for api usage
- getSession()
- index()
- init()
- providePermissions() — Provides custom permissions to the Security section
- settings()