Hierarchy

Constructors

  • Parameters

    • gmail: string
    • gmailOptions: {
          clientId: string;
          clientSecret: string;
          refreshToken: string;
          username?: string;
      }
      • clientId: string
      • clientSecret: string
      • refreshToken: string
      • Optional username?: string
    • Optional debug: boolean

    Returns Mailer

Properties

data: null | {
    access_token: string;
    expiry_date: number;
    refresh_token: string;
    scope: string;
    token_type: string;
} = null

Type declaration

  • access_token: string
  • expiry_date: number
  • refresh_token: string
  • scope: string
  • token_type: string
debug?: boolean
gmail: string
gmailOptions: {
    clientId: string;
    clientSecret: string;
    refreshToken: string;
    username?: string;
}

Type declaration

  • clientId: string
  • clientSecret: string
  • refreshToken: string
  • Optional username?: string

Methods

  • Parameters

    • Rest ...args: unknown[]

    Returns Mailer

  • Parameters

    • emails: string | string[]
    • options: {
          html?: string;
          subject?: string;
          text?: string;
      }
      • Optional html?: string
      • Optional subject?: string
      • Optional text?: string

    Returns Promise<SentMessageInfo>

  • Returns Promise<null | {
        access_token: string;
        expiry_date: number;
        refresh_token: string;
        scope: string;
        token_type: string;
    }>

  • Returns Promise<Transporter<SentMessageInfo>>

  • Parameters

    • number: string
    • text: string
    • region: "us" | "canada" | "intl" = "us"
    • Optional carrier: "uscellular" | "sprint" | "cellone" | "telus" | "alaskacommunications" | "rogers" | "cricket" | "nex-tech" | "tmobile" | "att" | "westernwireless" | "freedommobile" | "verizon" | "republic" | "bluskyfrog" | "loopmobile" | "clearlydigital" | "comcast" | "corrwireless" | "cellularsouth" | "centennialwireless" | "carolinawestwireless" | "southwesternbell" | "fido" | "ideacellular" | "indianapaging" | "illinoisvalleycellular" | "alltel" | "centurytel" | "dobson" | "surewestcommunications" | "mobilcomm" | "clearnet" | "koodomobile" | "metrocall2way" | "boostmobile" | "onlinebeep" | "metrocall" | "mci" | "ameritechpaging" | "pcsone" | "qwest" | "satellink" | "threeriverwireless" | "bluegrasscellular" | "edgewireless" | "goldentelecom" | "publicservicecellular" | "westcentralwireless" | "houstoncellular" | "mts" | "suncom" | "bellmobilitycanada" | "northerntelmobility" | "uswest" | "unicel" | "virginmobilecanada" | "virginmobile" | "airtelchennai" | "kolkataairtel" | "delhiairtel" | "tsrwireless" | "swisscom" | "mumbaibplmobile" | "vodafonejapan" | "gujaratcelforce" | "movistar" | "delhihutch" | "digitextjamacian" | "jsmtelepage" | "escotel" | "sunrisecommunications" | "teliadenmark" | "itelcel" | "mobileone" | "m1bermuda" | "o2mmail" | "telenor" | "mobistarbelgium" | "mobtelsrbija" | "telefonicamovistar" | "nextelmexico" | "globalstar" | "iridiumsatellitecommunications" | "oskar" | "meteor" | "smarttelecom" | "sunrisemobile" | "o2" | "oneconnectaustria" | "optusmobile" | "mobilfone" | "southernlinc" | "teletouch" | "vessotel" | "ntelos" | "rek2" | "chennairpgcellular" | "safaricom" | "satelindogsm" | "scs900" | "sfrfrance" | "mobiteltanzania" | "comviq" | "emt" | "geldentelecom" | "pandtluxembourg" | "netcom" | "primtel" | "tmobileaustria" | "tele2lativa" | "umc" | "uraltel" | "vodafoneitaly" | "lmt" | "tmobilegermany" | "dttmobile" | "tmobileuk" | "simplefreedom" | "tim" | "vodafone" | "wyndtell" | "projectfi"

    Returns Promise<unknown[]>

Generated using TypeDoc