Class BaseCommunicationProvider`Abstract`

Base class for all communication providers. Each provider sub-classes this base class and implements functionality specific to the provider.

Remarks

All methods accept an optional credentials parameter that allows per-request credential overrides. When credentials are provided, they take precedence over environment variables. Set credentials.disableEnvironmentFallback = true to disable environment variable fallback.

Each provider defines its own credential interface that extends ProviderCredentialsBase. For example, SendGridCredentials, MSGraphCredentials, etc.

Example

// Use environment credentials (default behavior)
await provider.SendSingleMessage(message);

// Override with request credentials
await provider.SendSingleMessage(message, { apiKey: 'SG.xxx' });

// Require explicit credentials (no env fallback)
await provider.SendSingleMessage(message, {
    apiKey: 'SG.xxx',
    disableEnvironmentFallback: true
});

Hierarchy (View Summary)

BaseCommunicationProvider

Index

Constructors

constructor

new BaseCommunicationProvider(): BaseCommunicationProvider
Returns BaseCommunicationProvider

Accessors

`Protected`ProviderName

get ProviderName(): string
Returns the name of this provider for use in error messages. Override in subclasses to provide a more descriptive name.

Returns string
- Defined in Communication/base-types/src/BaseProvider.ts:809

Methods

ArchiveMessage

ArchiveMessage(
params: ArchiveMessageParams,
credentials?: ProviderCredentialsBase,
): Promise<ArchiveMessageResult<Record<string, any>>>
Archives a message. Override in subclasses that support this operation.
Parameters
- params: ArchiveMessageParams
  Parameters for archiving the message
- Optionalcredentials: ProviderCredentialsBase
  Optional credentials override for this request
Returns Promise<ArchiveMessageResult<Record<string, any>>>
Promise - Result of the archive operation
- Defined in Communication/base-types/src/BaseProvider.ts:923

`Abstract`CreateDraft

CreateDraft(
params: CreateDraftParams,
credentials?: ProviderCredentialsBase,
): Promise<CreateDraftResult<Record<string, any>>>
Creates a draft message using the provider. Providers that don't support drafts should return Success: false with an appropriate error message.
Parameters
- params: CreateDraftParams
  Parameters for creating the draft
- Optionalcredentials: ProviderCredentialsBase
  Optional credentials override for this request
Returns Promise<CreateDraftResult<Record<string, any>>>
Promise - Result containing draft ID if successful
- Defined in Communication/base-types/src/BaseProvider.ts:795

DeleteMessage

DeleteMessage(
params: DeleteMessageParams,
credentials?: ProviderCredentialsBase,
): Promise<DeleteMessageResult<Record<string, any>>>
Deletes a message. Override in subclasses that support this operation.
Parameters
- params: DeleteMessageParams
  Parameters for deleting the message
- Optionalcredentials: ProviderCredentialsBase
  Optional credentials override for this request
Returns Promise<DeleteMessageResult<Record<string, any>>>
Promise - Result of the delete operation
- Defined in Communication/base-types/src/BaseProvider.ts:855

DownloadAttachment

DownloadAttachment(
params: DownloadAttachmentParams,
credentials?: ProviderCredentialsBase,
): Promise<DownloadAttachmentResult<Record<string, any>>>
Downloads an attachment from a message. Override in subclasses that support this operation.
Parameters
- params: DownloadAttachmentParams
  Parameters for downloading the attachment
- Optionalcredentials: ProviderCredentialsBase
  Optional credentials override for this request
Returns Promise<DownloadAttachmentResult<Record<string, any>>>
Promise - The attachment content
- Defined in Communication/base-types/src/BaseProvider.ts:974

`Abstract`ForwardMessage

ForwardMessage(
params: ForwardMessageParams,
credentials?: ProviderCredentialsBase,
): Promise<ForwardMessageResult<Record<string, any>>>
Forwards a message to another client using the provider
Parameters
- params: ForwardMessageParams
  Parameters for forwarding the message
- Optionalcredentials: ProviderCredentialsBase
  Optional credentials override for this request
Returns Promise<ForwardMessageResult<Record<string, any>>>
Promise - Result of the forward operation
- Defined in Communication/base-types/src/BaseProvider.ts:771

`Abstract`GetMessages

GetMessages(
params: GetMessagesParams,
credentials?: ProviderCredentialsBase,
): Promise<GetMessagesResult<Record<string, any>>>
Fetches messages using the provider
Parameters
- params: GetMessagesParams
  Parameters for fetching messages
- Optionalcredentials: ProviderCredentialsBase
  Optional credentials override for this request
Returns Promise<GetMessagesResult<Record<string, any>>>
Promise - Retrieved messages
- Defined in Communication/base-types/src/BaseProvider.ts:760

GetSingleMessage

GetSingleMessage(
params: GetSingleMessageParams,
credentials?: ProviderCredentialsBase,
): Promise<GetSingleMessageResult<Record<string, any>>>
Gets a single message by ID. Override in subclasses that support this operation.
Parameters
- params: GetSingleMessageParams
  Parameters for retrieving the message
- Optionalcredentials: ProviderCredentialsBase
  Optional credentials override for this request
Returns Promise<GetSingleMessageResult<Record<string, any>>>
Promise - The retrieved message
- Defined in Communication/base-types/src/BaseProvider.ts:838

getSupportedOperations

getSupportedOperations(): ProviderOperation[]
Returns the list of operations supported by this provider. Override in subclasses to accurately reflect capabilities. Default implementation returns only the core abstract methods.

Returns ProviderOperation[]
- Defined in Communication/base-types/src/BaseProvider.ts:818

ListAttachments

ListAttachments(
params: ListAttachmentsParams,
credentials?: ProviderCredentialsBase,
): Promise<ListAttachmentsResult<Record<string, any>>>
Lists attachments on a message. Override in subclasses that support this operation.
Parameters
- params: ListAttachmentsParams
  Parameters for listing attachments
- Optionalcredentials: ProviderCredentialsBase
  Optional credentials override for this request
Returns Promise<ListAttachmentsResult<Record<string, any>>>
Promise - The list of attachments
- Defined in Communication/base-types/src/BaseProvider.ts:957

ListFolders

ListFolders(
params: ListFoldersParams,
credentials?: ProviderCredentialsBase,
): Promise<ListFoldersResult<Record<string, any>>>
Lists folders/mailboxes available in the provider. Override in subclasses that support this operation.
Parameters
- params: ListFoldersParams
  Parameters for listing folders
- Optionalcredentials: ProviderCredentialsBase
  Optional credentials override for this request
Returns Promise<ListFoldersResult<Record<string, any>>>
Promise - The list of folders
- Defined in Communication/base-types/src/BaseProvider.ts:889

MarkAsRead

MarkAsRead(
params: MarkAsReadParams,
credentials?: ProviderCredentialsBase,
): Promise<MarkAsReadResult<Record<string, any>>>
Marks message(s) as read or unread. Override in subclasses that support this operation.
Parameters
- params: MarkAsReadParams
  Parameters for marking messages
- Optionalcredentials: ProviderCredentialsBase
  Optional credentials override for this request
Returns Promise<MarkAsReadResult<Record<string, any>>>
Promise - Result of the operation
- Defined in Communication/base-types/src/BaseProvider.ts:906

MoveMessage

MoveMessage(
params: MoveMessageParams,
credentials?: ProviderCredentialsBase,
): Promise<MoveMessageResult<Record<string, any>>>
Moves a message to a different folder. Override in subclasses that support this operation.
Parameters
- params: MoveMessageParams
  Parameters for moving the message
- Optionalcredentials: ProviderCredentialsBase
  Optional credentials override for this request
Returns Promise<MoveMessageResult<Record<string, any>>>
Promise - Result of the move operation
- Defined in Communication/base-types/src/BaseProvider.ts:872

`Abstract`ReplyToMessage

ReplyToMessage(
params: ReplyToMessageParams,
credentials?: ProviderCredentialsBase,
): Promise<ReplyToMessageResult<Record<string, any>>>
Replies to a message using the provider
Parameters
- params: ReplyToMessageParams
  Parameters for replying to the message
- Optionalcredentials: ProviderCredentialsBase
  Optional credentials override for this request
Returns Promise<ReplyToMessageResult<Record<string, any>>>
Promise - Result of the reply operation
- Defined in Communication/base-types/src/BaseProvider.ts:782

SearchMessages

SearchMessages(
params: SearchMessagesParams,
credentials?: ProviderCredentialsBase,
): Promise<SearchMessagesResult<Record<string, any>>>
Searches messages using a query string. Override in subclasses that support this operation.
Parameters
- params: SearchMessagesParams
  Parameters for searching messages
- Optionalcredentials: ProviderCredentialsBase
  Optional credentials override for this request
Returns Promise<SearchMessagesResult<Record<string, any>>>
Promise - Messages matching the search criteria
- Defined in Communication/base-types/src/BaseProvider.ts:940

`Abstract`SendSingleMessage

SendSingleMessage(
message: ProcessedMessage,
credentials?: ProviderCredentialsBase,
): Promise<MessageResult>
Sends a single message using the provider
Parameters
- message: ProcessedMessage
  The processed message to send
- Optionalcredentials: ProviderCredentialsBase
  Optional credentials override for this request. Provider-specific credential interface (e.g., SendGridCredentials). If not provided, uses environment variables.
Returns Promise<MessageResult>
Promise - Result of the send operation
- Defined in Communication/base-types/src/BaseProvider.ts:749

supportsOperation

supportsOperation(operation: ProviderOperation): boolean
Checks if this provider supports a specific operation.
Parameters
- operation: ProviderOperation
  The operation to check
Returns boolean
true if the operation is supported
- Defined in Communication/base-types/src/BaseProvider.ts:827

Class BaseCommunicationProviderAbstract

Remarks

Example

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns BaseCommunicationProvider

Accessors

ProtectedProviderName

Returns string

Methods

ArchiveMessage

Parameters

Returns Promise<ArchiveMessageResult<Record<string, any>>>

AbstractCreateDraft

Parameters

Returns Promise<CreateDraftResult<Record<string, any>>>

DeleteMessage

Parameters

Returns Promise<DeleteMessageResult<Record<string, any>>>

DownloadAttachment

Parameters

Returns Promise<DownloadAttachmentResult<Record<string, any>>>

AbstractForwardMessage

Parameters

Returns Promise<ForwardMessageResult<Record<string, any>>>

AbstractGetMessages

Parameters

Returns Promise<GetMessagesResult<Record<string, any>>>

GetSingleMessage

Parameters

Returns Promise<GetSingleMessageResult<Record<string, any>>>

getSupportedOperations

Returns ProviderOperation[]

ListAttachments

Parameters

Returns Promise<ListAttachmentsResult<Record<string, any>>>

ListFolders

Parameters

Returns Promise<ListFoldersResult<Record<string, any>>>

MarkAsRead

Parameters

Returns Promise<MarkAsReadResult<Record<string, any>>>

MoveMessage

Parameters

Returns Promise<MoveMessageResult<Record<string, any>>>

AbstractReplyToMessage

Parameters

Returns Promise<ReplyToMessageResult<Record<string, any>>>

SearchMessages

Parameters

Returns Promise<SearchMessagesResult<Record<string, any>>>

AbstractSendSingleMessage

Parameters

Returns Promise<MessageResult>

supportsOperation

Parameters

Returns boolean

Settings

On This Page

Class BaseCommunicationProvider`Abstract`

`Protected`ProviderName

`Abstract`CreateDraft

`Abstract`ForwardMessage

`Abstract`GetMessages

`Abstract`ReplyToMessage

`Abstract`SendSingleMessage