Type alias GetMessagesParams<T>

GetMessagesParams<T>: {
    ContextData?: T;
    Identifier?: string;
    IncludeHeaders?: boolean;
    NumMessages: number;
    UnreadOnly?: boolean;
}

Type Parameters

  • T = Record<string, any>

Type declaration

  • Optional ContextData?: T

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

  • Optional 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.

  • Optional IncludeHeaders?: boolean

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

  • NumMessages: number

    The number of messages to return

  • Optional UnreadOnly?: boolean

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

Settings

Member Visibility

Theme