Mail818 SDK - v0.2.2
    Preparing search index...

    Interface NativeFormOptions

    Native form enhancement options

    interface NativeFormOptions {
        allowedOrigins?: string[];
        apiEndpoint?: string;
        apiKey?: string;
        apiToken?: string;
        apiUrl?: string;
        detectDelay?: number;
        fieldMappings?: { htmlField: string; mail818Field: string }[];
        formSelector?: string;
        listId?: string;
        offlineEnabled?: boolean;
        onError?: (error: Error) => void;
        onSuccess?: (data: Record<string, unknown>) => void;
        organizationKey?: string;
        replaceOnSuccess?: boolean;
        showLoadingState?: boolean;
        sourceId: string;
        successBehavior?: "message" | "redirect" | "callback";
        successCallbackFn?: string;
        successMessage?: string;
        successRedirectUrl?: string;
        validationRules?: ValidationRule[];
    }
    Index

    Properties

    allowedOrigins? apiEndpoint? apiKey? apiToken? apiUrl? detectDelay? fieldMappings? formSelector? listId? offlineEnabled? onError? onSuccess? organizationKey? replaceOnSuccess? showLoadingState? sourceId successBehavior? successCallbackFn? successMessage? successRedirectUrl? validationRules?

    Properties

    allowedOrigins?: string[]

    Allowed origins for CORS

    apiEndpoint?: string

    API endpoint for submission

    apiKey?: string

    API key for authentication (optional for native forms)

    apiToken?: string

    API token (alias for apiKey)

    apiUrl?: string

    API URL (defaults to production)

    detectDelay?: number

    Delay before detecting forms (ms)

    fieldMappings?: { htmlField: string; mail818Field: string }[]

    Field mappings (passed from API)

    formSelector?: string

    CSS selector to identify forms (optional)

    listId?: string

    List ID for the source

    offlineEnabled?: boolean

    Enable offline queue

    onError?: (error: Error) => void

    Custom error callback

    onSuccess?: (data: Record<string, unknown>) => void

    Custom success callback

    organizationKey?: string

    Organization key (ID)

    replaceOnSuccess?: boolean

    Replace form with success message

    showLoadingState?: boolean

    Show loading state during submission

    sourceId: string

    Source ID for the native form

    successBehavior?: "message" | "redirect" | "callback"

    Success behavior configuration

    successCallbackFn?: string

    Success callback function name

    successMessage?: string

    Success message to display

    successRedirectUrl?: string

    Success redirect URL

    validationRules?: ValidationRule[]

    Validation rules (passed from API) - empty array means no validation

    Settings

    Member Visibility

    On This Page

    Properties