6.0.0 • Published 3 years ago
@datafire/winning_email v6.0.0
@datafire/winning_email
Client library for Winning Email
Installation and Usage
npm install --save @datafire/winning_email
let winning_email = require('@datafire/winning_email').create({
internalApiKey: ""
});
.then(data => {
console.log(data);
});
Description
The Winning Email API allows you to access our services from your applications. Contact us if you need help with anything, or require access to something we don't yet offer. The API overview is available here.
Actions
emailBooster
With our API, you can access the same results available through the Winning Email website, but in a raw, JSON, format, that you can use however you wish in your application. Read more about Email Booster here.Input ParametersIf source provided, then all other inputs are ignored. Otherwise, subject AND one or both of html and text are required.
winning_email.emailBooster({}, context)
Input
- input
object
- subject
string
: email subject - html
string
: html body - text
string
: plain text body - source
string
: raw source
- subject
Output
- output
object
- message
string
- report Report
- status
integer
- message
rateLimitStatus
Check how many API queries you've used, and what your limit is.
winning_email.rateLimitStatus(null, context)
Input
This action has no parameters
Output
- output
object
- message
string
- services
array
- items Service
- status
integer
- message
status
Check the status of the Winning Email API.
winning_email.status(null, context)
Input
This action has no parameters
Output
- output
object
- message
string
- status
integer
- uptime
number
- message
Definitions
ErrorModel
- ErrorModel
object
- message required
string
- status required
integer
- message required
Report
- Report
object
- baseScore
integer
- report
object
- bodyReport
object
- address
object
- hasForm
integer
- hasJS
integer
- htmlLength
integer
- score
number
- textLength
integer
- address
- imageReport
object
- imagesNeedOptimization
integer
- imagesNoAlt
array
- optimization
array
- score
number
- imagesNeedOptimization
- linkReport
object
- errors
array
- score
number
- errors
- markupReport
object
- response
object
- errors
array
- groupedErrors
array
- tripleTree
array
- warnings
array
- errors
- score
number
- response
- spamassassinReport
object
- baseSpamScore
number
- isSpam
boolean
- responseCode
integer
- responseMessage
string
- score
number
- spamScore
number
- tests
array
- items
object
- desc
string
- name
string
- score
number
- desc
- items
- baseSpamScore
- spellReport
object
- html
array
- score
number
- subject
array
- text
array
- html
- subjectReport
object
- openrates
array
- overallOpenRate
string
- score
number
- subject
string
- subjectLength
integer
- openrates
- validateHTML
object
- errors
array
- items
object
- lastColumn
integer
- lastLine
integer
- message
string
- type
string
- lastColumn
- items
- score
number
- errors
- bodyReport
- score
number
- time
string
- baseScore
Service
- Service
object
- limit
integer
- name
string
- remaining
integer
- reset
integer
- used
integer
- limit