Member Junction
    Preparing search index...

    Class GmailProvider

    Base class for all communication providers. Each provider sub-classes this base class and implements functionality specific to the provider.

    All methods accept an optional credentials parameter that allows per-request credential overrides. When credentials are provided, they take precedence over environment variables. Set credentials.disableEnvironmentFallback = true to disable environment variable fallback.

    Each provider defines its own credential interface that extends ProviderCredentialsBase. For example, SendGridCredentials, MSGraphCredentials, etc.

    // Use environment credentials (default behavior)
    await provider.SendSingleMessage(message);

    // Override with request credentials
    await provider.SendSingleMessage(message, { apiKey: 'SG.xxx' });

    // Require explicit credentials (no env fallback)
    await provider.SendSingleMessage(message, {
        apiKey: 'SG.xxx',
        disableEnvironmentFallback: true
    });

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    MessageRetrieval ProviderName SupportsPush

    Methods

    ArchiveMessage CancelCalendarEvent CancelEvent CreateCalendarEvent CreateDraft CreateEvent CreateSubscription DeleteMessage DeleteSubscription DownloadAttachment FindMeetingTimes ForwardMessage GetEvent GetEvents GetFreeBusy GetMessages GetSingleMessage GetSubscriptionCapabilities getSupportedOperations ListAttachments ListFolders MarkAsRead MoveMessage ParseNotification RenewSubscription ReplyToMessage RespondToCalendarEvent SearchMessages SendSingleMessage supportsOperation SupportsOperation SyncEvents UpdateCalendarEvent UpdateEvent VerifyMailboxAccess

    Constructors

    Accessors

    • get ProviderName(): string

      Returns the name of this provider for use in error messages. Override in subclasses to provide a more descriptive name.

      Returns string

    • get SupportsPush(): boolean

      Convenience gate: true when this provider supports inbound push in ANY form (subscription-managed or inbound-parse), false otherwise. Lets callers cleanly short-circuit — if (provider.SupportsPush) { ... } — instead of probing individual operations.

      Derived from GetSubscriptionCapabilities so it stays in lockstep with actual capability: providers that support push return capabilities and thereby report SupportsPush === true for free; providers that don't return undefined and report false. Subclasses normally do NOT override this — override GetSubscriptionCapabilities instead.

      Returns boolean

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods