-
Backend
-
Behaviors
-
Classes
-
Controllers
-
Database
-
Seeds
-
-
Facades
-
FormWidgets
-
Helpers
-
Models
-
ReportWidgets
-
Skins
-
Traits
-
VueComponents
-
Widgets
- ServiceProvider
-
-
Cms
-
Classes
- Asset
- CmsCompoundObject
- CmsController
- CmsException
- CmsObject
- CmsObjectCollection
- CodeBase
- CodeParser
- ComponentBase
- ComponentHelpers
- ComponentManager
- ComponentPartial
- Content
- Controller
- EditorExtension
- Layout
- LayoutCode
- MediaLibrary
- MediaLibraryItem
- MediaViewHelper
- Meta
- ObjectMemoryCache
- Page
- PageCode
- Partial
- PartialCode
- PartialStack
- Router
- Theme
- ThemeManager
-
Components
-
Controllers
-
Facades
-
FormWidgets
-
Helpers
-
Models
-
ReportWidgets
-
Traits
-
Twig
- ComponentNode
- ComponentTokenParser
- ContentNode
- ContentTokenParser
- DebugExtension
- DefaultNode
- DefaultTokenParser
- Extension
- FlashNode
- FlashTokenParser
- FrameworkNode
- FrameworkTokenParser
- Loader
- PageNode
- PageTokenParser
- PartialNode
- PartialTokenParser
- PlaceholderNode
- PlaceholderTokenParser
- PutNode
- PutTokenParser
- ScriptsNode
- ScriptsTokenParser
- StylesNode
- StylesTokenParser
-
VueComponents
-
Widgets
- ServiceProvider
-
-
Editor
-
Behaviors
-
Classes
-
Controllers
-
VueComponents
- ServiceProvider
-
-
Media
-
Classes
-
Controllers
-
FormWidgets
-
Twig
-
Widgets
- ServiceProvider
-
-
System
-
Behaviors
-
Classes
-
Console
-
OctoberUtil
- ComposerScript
- OctoberDown
- OctoberFresh
- OctoberMigrate
- OctoberMirror
- OctoberPasswd
- OctoberUp
- OctoberUpdate
- OctoberUtil
- PluginCheck
- PluginDisable
- PluginEnable
- PluginInstall
- PluginList
- PluginRefresh
- PluginRemove
- ProjectSet
- ProjectSync
- ThemeCheck
- ThemeInstall
- ThemeList
- ThemeRemove
- ThemeSync
- ThemeUse
-
-
Controllers
-
Database
-
Facades
-
Helpers
-
Models
-
ReportWidgets
-
Traits
-
Twig
-
Widgets
- ServiceProvider
-
-
Events
-
backend
-
ajax
-
filter
-
form
-
list
-
menu
-
page
-
user
-
-
cms
-
ajax
-
block
-
combiner
-
component
-
object
-
page
-
resizer
-
router
-
template
-
theme
-
-
exception
-
halcyon
-
datasource
-
-
mailer
-
media
-
model
-
auth
-
form
-
relation
-
/docs/api/model/relation/add
-
/docs/api/model/relation/associate
- attach
-
/docs/api/model/relation/beforeadd
-
/docs/api/model/relation/beforeassociate
- beforeAttach
- beforeDetach
-
/docs/api/model/relation/beforedissociate
-
/docs/api/model/relation/beforeremove
- detach
-
/docs/api/model/relation/dissociate
-
/docs/api/model/relation/remove
-
- afterBoot
- afterCreate
- afterDelete
- afterFetch
- afterRestore
- afterSave
- afterUpdate
- afterValidate
- beforeCreate
- beforeDelete
- beforeFetch
- beforeGetAttribute
- beforeRestore
- beforeSave
- beforeSetAttribute
- beforeUpdate
- beforeValidate
- getAttribute
- saveInternal
- setAttribute
-
-
system
-
assets
-
console
-
mirror
-
theme
-
-
reportwidgets
-
resizer
-
settings
- extendConfigFile
-
-
translator
-
-
Library
-
Argon
-
Assetic
-
Asset
-
Cache
-
Exception
-
Factory
-
Filter
- BaseCssFilter
- CallablesFilter
- CssCacheBustingFilter
- CssImportFilter
- CssMinFilter
- CssRewriteFilter
- FilterCollection
- JavascriptImporter
- JSMinFilter
- JSMinPlusFilter
- JSqueezeFilter
- LessCompiler
- LessphpFilter
- MinifyCssCompressorFilter
- PackagerFilter
- PackerFilter
- ScssCompiler
- ScssphpFilter
- StylesheetMinify
-
Util
- README
- AssetManager
- AssetWriter
- FilterManager
-
-
Auth
-
Models
- AuthException
- Manager
-
-
Config
-
Database
-
Attach
-
Behaviors
-
Concerns
-
Connections
-
Connectors
-
Models
-
Relations
-
Schema
-
Traits
-
Updates
- README
- Builder
- Collection
- DatabaseServiceProvider
- DataFeed
- Dongle
- MemoryCache
- MigrationServiceProvider
- Model
- ModelBehavior
- ModelException
- MorphPivot
- NestedTreeScope
- Pivot
- QueryBuilder
- SortableScope
- TreeCollection
- Updater
-
-
Events
-
Exception
-
Extension
-
Filesystem
-
Flash
-
Foundation
-
Bootstrap
-
Console
-
Exception
-
Http
-
Middleware
- Kernel
-
-
Providers
- Application
- Maker
-
-
Halcyon
-
Datasource
-
Exception
-
Processors
-
Traits
- README
- Builder
- Collection
- HalcyonServiceProvider
- MemoryCacheManager
- MemoryRepository
- Model
-
-
Html
-
Mail
-
Network
-
Parse
-
Parsedown
-
Syntax
- Bracket
- Ini
- Markdown
- MarkdownData
- ParseServiceProvider
- Twig
- Yaml
-
-
Process
-
Resize
-
Router
-
Scaffold
-
Support
-
Translation
-
- Documentation
- API
- Library
- Transport
- SparkPostTransport
October\Rain\Mail\Transport\SparkPostTransport
Extends:
- Illuminate\Mail\Transport\Transport
Implements:
- Swift_Transport
Public properties
There are no public properties in the class.
Show inherited public properties
Inherited public properties
- public array $plugins - defined in Illuminate\Mail\Transport\Transport. The plug-ins registered with the transport.
Protected properties
protected GuzzleHttp\ClientInterface $client
Guzzle client instance.
protected string $key
The SparkPost API key.
protected array $options
The SparkPost transmission options.
Public methods
public void __construct(GuzzleHttp\ClientInterface $client, string $key, array $options=array())
Create a new SparkPost transport instance.
Parameters
- GuzzleHttp\ClientInterface $client
- string $key
- array $options
public string getEndpoint()
Get the SparkPost API endpoint.
public string getKey()
Get the API key being used by the transport.
public array getOptions()
Get the transmission options being used by the transport.
public void send($message, &$failedRecipients=NULL)
{@inheritdoc}
Parameters
- $message
- &$failedRecipients
public string setKey(string $key)
Set the API key being used by the transport.
Parameters
- string $key
public array setOptions(array $options)
Set the transmission options being used by the transport.
Parameters
- array $options
Inherited public methods
- public void isStarted() - defined in Illuminate\Mail\Transport\Transport. {@inheritdoc}.
- public void ping() - defined in Illuminate\Mail\Transport\Transport. {@inheritdoc}.
- public void registerPlugin(Swift_Events_EventListener $plugin) - defined in Illuminate\Mail\Transport\Transport. Register a plug-in with the transport.
- public void start() - defined in Illuminate\Mail\Transport\Transport. {@inheritdoc}.
- public void stop() - defined in Illuminate\Mail\Transport\Transport. {@inheritdoc}.
Protected methods
protected array getRecipients(Swift_Mime_SimpleMessage $message)
Get all the addresses this message should be sent to.
Note that SparkPost still respects CC, BCC headers in raw message itself.
Parameters
- Swift_Mime_SimpleMessage $message
protected string getTransmissionId(GuzzleHttp\Psr7\Response $response)
Get the transmission ID from the response.
Parameters
- GuzzleHttp\Psr7\Response $response
Show inherited protected methods
Inherited protected methods
- protected void beforeSendPerformed(Swift_Mime_SimpleMessage $message) - defined in Illuminate\Mail\Transport\Transport. Iterate through registered plugins and execute plugins' methods.
- protected int numberOfRecipients(Swift_Mime_SimpleMessage $message) - defined in Illuminate\Mail\Transport\Transport. Get the number of recipients.
- protected void sendPerformed(Swift_Mime_SimpleMessage $message) - defined in Illuminate\Mail\Transport\Transport. Iterate through registered plugins and execute plugins' methods.