onesec-api v1.0.2

OneSecAPI

Installation

Using npm

npm install onesec-api

Using yarn

yarn add onesec-api

Example

npm run test

const { OneSecMailbox } = require("../lib");

const oneSec = new OneSecMailbox("test", "esiix.com");

oneSec.getMail().then((mailbox) => {
  mailbox.forEach((msg, i) => {
    console.log(
      `Email #${i + 1} (of ${mailbox.length})\n` +
        ` From: ${msg.getSender()}\n` +
        ` Subject: ${msg.getSubject()}\n` +
        ` Body: ${msg.getTextBody()}\n` +
        ` Date: ${msg.getDate()}\n` +
        ` Attachment Count: ${msg.getAttachments().length}`
    );
  });
});

Documentation

• OneSecMailbox
  • Constructor
  • OneSecMailbox~getMail
  • OneSecMailbox.getDomains
• OneSecMessage
  • OneSecMessage~getID
  • OneSecMessage~getSender
  • OneSecMessage~getSubject
  • OneSecMessage~getDate
  • OneSecMessage~getAttachments
  • OneSecMessage~getBody
  • OneSecMessage~getTextBody
  • OneSecMessage~getHtmlBody
• OneSecMessageAttachment
  • OneSecMessageAttachment~getFileName
  • OneSecMessageAttachment~getFileURL
  • OneSecMessageAttachment~getFileSize
  • OneSecMessageAttachment~getContentType

OneSecMailbox

new OneSecMailbox(username: string, domain: string): OneSecMailbox;

Arguments

• Username - The username of the email
• Domain - The email domain (Not including the '@')
  • Valid Domains: 1secmail.com 1secmail.org 1setmail.net wwjmp.com esiix.com

Description

• Initializes a OneSecMailbox object

OneSecMailbox~getMail(): Promise<OneSecMessage[]>

Description

• Fetch list of OneSecMessage

OneSecMailbox.getDomains(): string[]

Description

• Returns list of valid domains

OneSecMessage

OneSecMessage~getID(): number

Description

• Returns the 1secMAIL ID

OneSecMessage~getSender(): string

Description

• Returns the mail body

OneSecMessage~getSubject(): string

Description

• Returns the mail plain text body

OneSecMessage~getDate(): Date

Description

• Returns the Date mail was received

OneSecMessage~getAttachments(): OneSecMessageAttachment[]

Description

• Returns a list of attachments

OneSecMessage~getBody(): string

Description

• Returns the mail body

OneSecMessage~getTextBody(): string

Description

• Returns the mail plain text body

OneSecMessage~getHtmlBody(): string

Description

• Returns the mail html body

OneSecMessageAttachment

OneSecMessageAttachment~getFileName(): string

Description

• Returns the attachment file name

OneSecMessageAttachment~getFileURL(): string

Description

• Returns the attachment download URL

OneSecMessageAttachment~getFileSize(): number

Description

• Returns the attachment file size

OneSecMessageAttachment~getContentType(): string

Description

• Returns the attachment content type