Member Junction
    Preparing search index...

    Interface SendGridCredentials

    Credentials for SendGrid email provider.

    // Use with SendSingleMessage
    await provider.SendSingleMessage(message, {
        apiKey: 'SG.your-api-key'
    });

    // Disable environment fallback
    await provider.SendSingleMessage(message, {
        apiKey: 'SG.your-api-key',
        disableEnvironmentFallback: true
    });
    interface SendGridCredentials {
        apiKey?: string;
        disableEnvironmentFallback?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    apiKey? disableEnvironmentFallback?

    Properties

    apiKey?: string

    SendGrid API key. Typically starts with 'SG.' If not provided, falls back to COMMUNICATION_VENDOR_API_KEY__SENDGRID environment variable.

    disableEnvironmentFallback?: boolean

    When true, environment variable fallback is DISABLED for this request. If credentials are incomplete and this is true, the request will fail rather than falling back to environment variables.

    false (fallback enabled for backward compatibility)

    // With fallback (default) - uses env var if apiKey not provided
    await provider.SendSingleMessage(message, {});

    // Without fallback - fails if apiKey not provided
    await provider.SendSingleMessage(message, {
        disableEnvironmentFallback: true
    });

    Settings

    Member Visibility

    On This Page

    Properties