Member Junction
    Preparing search index...

    Args for SendToAudience. Kept separate from Message because the audience layer adds its own dimensions (source, field mapping) that don't belong on the underlying transport-level Message type.

    interface SendToAudienceParams {
        ContextUser: UserInfo;
        Credentials?: ProviderCredentialsBase;
        FullNameField?: string;
        Message: Message;
        PreviewOnly?: boolean;
        Provider?: IMetadataProvider;
        ProviderMessageTypeName: string;
        ProviderName: string;
        RecipientField: string;
        Source: ListSource;
    }
    Index

    Properties

    ContextUser: UserInfo

    Context user — required, used for authorization on the underlying provider.

    Optional per-request credentials override. Forwarded to SendMessages.

    FullNameField?: string

    Optional name of a "full name" field, used to populate MessageRecipient.FullName.

    Message: Message

    Base message — From, subject/body, etc. To is overwritten per recipient.

    PreviewOnly?: boolean

    When true, resolve + build recipient list but don't actually send.

    Optional multi-provider scope. Forwarded to the resolver + RunView.

    ProviderMessageTypeName: string

    Provider message type name (e.g. 'SingleEmail').

    ProviderName: string

    Provider name (e.g. 'SendGrid'). Same value the underlying SendMessages takes.

    RecipientField: string

    Name of the field on the audience entity that holds the recipient address (e.g. 'Email' for Contacts, 'PhoneNumber' for SMS). Records that don't have a non-empty value for this field are skipped and surfaced in Skipped so the UI can show them to the sender.

    Source: ListSource

    Where the audience comes from — a List, View, or ad-hoc filter.