Member Junction
    Preparing search index...

    Type Alias GetMessagesParams<T>

    type GetMessagesParams<T = Record<string, any>> = {
        ContextData?: T;
        Identifier?: string;
        IncludeHeaders?: boolean;
        NumMessages: number;
        UnreadOnly?: boolean;
    }

    Type Parameters

    • T = Record<string, any>
    Index

    Properties

    ContextData? Identifier? IncludeHeaders? NumMessages UnreadOnly?

    Properties

    ContextData?: T

    Optional, any provider-specific parameters that are needed to get messages

    Identifier?: string

    The identifier to get messages for - an email address, mailbox ID, in the case of SMS, could be a phone number. In the case of other systems could be a User ID for FB Messenger/WhatsApp, etc.

    This is optional if the provider supports getting messages based on credentials alone as some credentials/providers can be scoped to a specific mailbox/user.

    IncludeHeaders?: boolean

    Optional, include the headers in the response (defaults to false)

    NumMessages: number

    The number of messages to return

    UnreadOnly?: boolean

    Optional. If true, only messages not marked as read will be returned

    Settings

    Member Visibility

    On This Page

    Properties