Class SendGridProvider

Implementation of the SendGrid provider for sending and receiving messages.

Remarks

SendGrid is a transactional email service. This provider supports:

Sending single messages
Sending to multiple recipients (via engine)

It does NOT support:

Fetching messages (no inbox access)
Forwarding messages
Replying to messages
Creating drafts

Example

// Using environment credentials (default)
await engine.SendSingleMessage('SendGrid', 'Standard Email', message);

// Using per-request credentials
await engine.SendSingleMessage('SendGrid', 'Standard Email', message, undefined, false, {
    apiKey: 'SG.customer-specific-key'
});

Hierarchy (View Summary)

BaseCommunicationProvider
- SendGridProvider

Index

Constructors

constructor

new SendGridProvider(): SendGridProvider
Returns SendGridProvider
Inherited from BaseCommunicationProvider.constructor

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
Inherited from BaseCommunicationProvider.ProviderName
- Defined in base-types/dist/BaseProvider.d.ts:687

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
Inherited from BaseCommunicationProvider.ArchiveMessage
- Defined in base-types/dist/BaseProvider.d.ts:747

CreateDraft

CreateDraft(
params: CreateDraftParams,
credentials?: SendGridCredentials,
): Promise<CreateDraftResult>
Creates a draft message using the provider.
Parameters
- params: CreateDraftParams
- Optionalcredentials: SendGridCredentials
Returns Promise<CreateDraftResult>
Remarks
SendGrid does not support creating drafts (no mailbox access).
Overrides BaseCommunicationProvider.CreateDraft
- Defined in providers/sendgrid/src/SendGridProvider.ts:242

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
Inherited from BaseCommunicationProvider.DeleteMessage
- Defined in base-types/dist/BaseProvider.d.ts:715

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
Inherited from BaseCommunicationProvider.DownloadAttachment
- Defined in base-types/dist/BaseProvider.d.ts:771

ForwardMessage

ForwardMessage(
params: ForwardMessageParams,
credentials?: SendGridCredentials,
): Promise<ForwardMessageResult>
Forwards a message to another client using the provider.
Parameters
- params: ForwardMessageParams
- Optionalcredentials: SendGridCredentials
Returns Promise<ForwardMessageResult>
Remarks
SendGrid does not support forwarding messages.
Overrides BaseCommunicationProvider.ForwardMessage
- Defined in providers/sendgrid/src/SendGridProvider.ts:220

GetMessages

GetMessages(
params: GetMessagesParams,
credentials?: SendGridCredentials,
): Promise<GetMessagesResult>
Fetches messages from the provider.
Parameters
- params: GetMessagesParams
- Optionalcredentials: SendGridCredentials
Returns Promise<GetMessagesResult>
Remarks
SendGrid does not support fetching messages (no inbox access).
Overrides BaseCommunicationProvider.GetMessages
- Defined in providers/sendgrid/src/SendGridProvider.ts:209

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
Inherited from BaseCommunicationProvider.GetSingleMessage
- Defined in base-types/dist/BaseProvider.d.ts:707

getSupportedOperations

getSupportedOperations(): ProviderOperation[]
Returns the list of operations supported by the SendGrid provider. SendGrid is a transactional email service (send-only) and does not support mailbox operations like fetching messages, folders, or attachments.

Returns ProviderOperation[]
Overrides BaseCommunicationProvider.getSupportedOperations
- Defined in providers/sendgrid/src/SendGridProvider.ts:80

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
Inherited from BaseCommunicationProvider.ListAttachments
- Defined in base-types/dist/BaseProvider.d.ts:763

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
Inherited from BaseCommunicationProvider.ListFolders
- Defined in base-types/dist/BaseProvider.d.ts:731

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
Inherited from BaseCommunicationProvider.MarkAsRead
- Defined in base-types/dist/BaseProvider.d.ts:739

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
Inherited from BaseCommunicationProvider.MoveMessage
- Defined in base-types/dist/BaseProvider.d.ts:723

ReplyToMessage

ReplyToMessage(
params: ReplyToMessageParams,
credentials?: SendGridCredentials,
): Promise<ReplyToMessageResult>
Replies to a message using the provider.
Parameters
- params: ReplyToMessageParams
- Optionalcredentials: SendGridCredentials
Returns Promise<ReplyToMessageResult>
Remarks
SendGrid does not support replying to messages.
Overrides BaseCommunicationProvider.ReplyToMessage
- Defined in providers/sendgrid/src/SendGridProvider.ts:231

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
Inherited from BaseCommunicationProvider.SearchMessages
- Defined in base-types/dist/BaseProvider.d.ts:755

SendSingleMessage

SendSingleMessage(
message: ProcessedMessage,
credentials?: SendGridCredentials,
): Promise<MessageResult>
Sends a single message using SendGrid.
Parameters
- message: ProcessedMessage
  The processed message to send
- Optionalcredentials: SendGridCredentials
  Optional SendGrid credentials override
Returns Promise<MessageResult>
Overrides BaseCommunicationProvider.SendSingleMessage
- Defined in providers/sendgrid/src/SendGridProvider.ts:94

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
Inherited from BaseCommunicationProvider.supportsOperation
- Defined in base-types/dist/BaseProvider.d.ts:699

Class SendGridProvider

Remarks

Example

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns SendGridProvider

Accessors

ProtectedProviderName

Returns string

Methods

ArchiveMessage

Parameters

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

CreateDraft

Parameters

Returns Promise<CreateDraftResult>

Remarks

DeleteMessage

Parameters

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

DownloadAttachment

Parameters

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

ForwardMessage

Parameters

Returns Promise<ForwardMessageResult>

Remarks

GetMessages

Parameters

Returns Promise<GetMessagesResult>

Remarks

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>>>

ReplyToMessage

Parameters

Returns Promise<ReplyToMessageResult>

Remarks

SearchMessages

Parameters

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

SendSingleMessage

Parameters

Returns Promise<MessageResult>

supportsOperation

Parameters

Returns boolean

Settings

On This Page

`Protected`ProviderName