Mail818 SDK - v0.2.2
Mail818
GitHub
Preparing search index...
Mail818Options
Interface Mail818Options
interface
Mail818Options
{
apiToken
:
string
;
cache
?:
{
enabled
:
boolean
;
storage
:
"localStorage"
|
"sessionStorage"
;
ttl
:
number
;
}
;
hostname
?:
string
;
listId
:
string
;
mockConfig
?:
ListConfig
;
offline
?:
{
enabled
:
boolean
;
queueSubmissions
:
boolean
;
retryOnReconnect
:
boolean
;
}
;
onConfigLoaded
?:
(
config
:
ListConfig
)
=>
void
;
onError
?:
(
error
:
Mail818Error
)
=>
void
;
onSuccess
?:
(
response
:
SubmissionResponse
)
=>
void
;
onValidationError
?:
(
errors
:
Record
<
string
,
string
>
)
=>
void
;
testMode
?:
boolean
;
}
Index
Properties
api
Token
cache?
hostname?
list
Id
mock
Config?
offline?
on
Config
Loaded?
on
Error?
on
Success?
on
Validation
Error?
test
Mode?
Properties
api
Token
apiToken
:
string
Optional
cache
cache
?:
{
enabled
:
boolean
;
storage
:
"localStorage"
|
"sessionStorage"
;
ttl
:
number
;
}
Optional
hostname
hostname
?:
string
list
Id
listId
:
string
Optional
mock
Config
mockConfig
?:
ListConfig
Optional
offline
offline
?:
{
enabled
:
boolean
;
queueSubmissions
:
boolean
;
retryOnReconnect
:
boolean
;
}
Optional
on
Config
Loaded
onConfigLoaded
?:
(
config
:
ListConfig
)
=>
void
Optional
on
Error
onError
?:
(
error
:
Mail818Error
)
=>
void
Optional
on
Success
onSuccess
?:
(
response
:
SubmissionResponse
)
=>
void
Optional
on
Validation
Error
onValidationError
?:
(
errors
:
Record
<
string
,
string
>
)
=>
void
Optional
test
Mode
testMode
?:
boolean
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
api
Token
cache
hostname
list
Id
mock
Config
offline
on
Config
Loaded
on
Error
on
Success
on
Validation
Error
test
Mode
Documentation
API Reference
Mail818
GitHub
Mail818 SDK - v0.2.2
Loading...