puppeteer-email-provider-outlook v0.1.0

puppeteer-email-provider-outlook

Puppeteer email provider for Outlook.

Install

npm install --save puppeteer-email-provider-outlook

API

Table of Contents

• PuppeteerEmailProviderOutlook
  • name
  • signup
  • signin
  • signout
  • sendEmail
  • getEmails

PuppeteerEmailProviderOutlook

Extends: PuppeteerEmailProvider

Puppeteer email provider for Outlook.

Type: function ()

name

Email provider to automate.

Type: PuppeteerEmailProvider

signup

Creates a new email account.

Returns an email session with the authenticated puppeteer browser.

Type: function (user, opts)

• user object User info for the account to create
  • user.username string Username
  • user.password string Password
  • user.firstName string User's given name
  • user.lastName string User's family name
  • user.birthday object User's birthday
    • user.birthday.month string User's birthday month
    • user.birthday.day string User's birthday day
    • user.birthday.year string User's birthday year
• opts object Options
  • opts.browser Object Puppeteer browser instance to use

signin

Signs into an existing email account.

You must specify either user.username or user.email.

Returns an email session with the authenticated puppeteer browser.

Type: function (user, opts)

• user object User info for the account to sign into
  • user.username string? Username (implies email)
  • user.email string? Email (implies username)
  • user.password string Password
• opts object Options
  • opts.browser Object Puppeteer browser instance to use

signout

Signs out of an authenticated session.

Type: function (session): Promise

• session PuppeteerEmailSession

sendEmail

Sends an email from an authenticated session.

Type: function (session, email, opts): Promise

• session PuppeteerEmailSession
• email object TODO
• opts object? Options (optional, default {})

getEmails

Fetches emails from the inbox of an authenticated session.

Type: function (session, opts)

• session PuppeteerEmailSession
• opts object? Options (optional, default {})
  • opts.query object? Search query to narrow down results

Related

• puppeteer-email - Email automation driven by headless chrome.

License

MIT © Travis Fischer