Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SendClean

Hierarchy

  • SendClean

Index

Constructors

Properties

Methods

Constructors

constructor

  • Create a new SendClean Client

    example
    const { SendClean } = require('sendclean');

    const sendclean_client = new SendClean({
    token: "YOUR_SENDCLEAN_TOKEN",
    owner_id: "YOUR_SENDCLEAN_USERID"
    })

    Parameters

    Returns SendClean

Properties

Private owner_id

owner_id: string

The User's Id For Requests.

memberof

SendClean

Private token

token: string

The User's API Token For Requests.

Methods

addSendingDomain

  • addSendingDomain(domain: string): Promise<void>

  • Add a new Sending Domain

    async

    Parameters

    • domain: string

    Returns Promise<void>

addSmtpUser

addTrackingDomain

  • addTrackingDomain(domain: string): Promise<void>

  • Add a new tracking domain

    async

    Parameters

    • domain: string

    Returns Promise<void>

addWebhook

  • addWebhook(url: string, events?: ValidEvents, description?: string, store_log?: string): Promise<void>

  • Add a new webhook

    Parameters

    • url: string
    • Optional events: ValidEvents
    • Optional description: string
    • Optional store_log: string

    Returns Promise<void>

checkSendingDomain

checkTrackingDomain

composeMail

deleteSendingDomain

  • deleteSendingDomain(domain: string): Promise<void>

  • Delete a Sending Domain

    async

    Parameters

    • domain: string

    Returns Promise<void>

deleteTrackingDomain

  • deleteTrackingDomain(domain: string): Promise<void>

  • Delete a tracking domain

    Parameters

    • domain: string

    Returns Promise<void>

deleteWebhook

  • deleteWebhook(webhook_id: string): Promise<void>

editWebhook

  • editWebhook(webhook_id: string, url: string, events?: ValidEvents, description?: string, store_log?: string): Promise<void>

  • Edit a webhook

    Parameters

    • webhook_id: string
    • url: string
    • Optional events: ValidEvents
    • Optional description: string
    • Optional store_log: string

    Returns Promise<void>

getUserInfo

getWebhookInfo

  • getWebhookInfo(webhook_id: string): Promise<WebhookInfo>

keyResetWebhook

  • keyResetWebhook(webhook_id: string): Promise<string>

  • Reset the key for a webhook

    Parameters

    • webhook_id: string

    Returns Promise<string>

listSendingDomains

listSmtpUsers

listTrackingDomains

listWebhooks

resetSmtpPassword

  • resetSmtpPassword(smtp_user_name: string): Promise<string>

  • Reset Smtp Password

    async

    Parameters

    • smtp_user_name: string

    Returns Promise<string>

sendTemplate

updateSmtpUser

verifySendingDomain

  • verifySendingDomain(domain: string): Promise<void>

  • Verify Sending Domain

    async

    Parameters

    • domain: string

    Returns Promise<void>

Generated using TypeDoc