Class GmailProvider

Implementation of the Gmail provider for sending and receiving messages

Hierarchy (View Summary)

BaseCommunicationProvider
- GmailProvider

Index

Constructors

constructor

new GmailProvider(): GmailProvider
Returns GmailProvider
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?: GmailCredentials,
): Promise<ArchiveMessageResult>
Archives a message (removes INBOX label in Gmail)
Parameters
- params: ArchiveMessageParams
  Parameters for archiving the message
- Optionalcredentials: GmailCredentials
  Optional credentials override for this request
Returns Promise<ArchiveMessageResult>
Overrides BaseCommunicationProvider.ArchiveMessage
- Defined in providers/gmail/src/GmailProvider.ts:1030

CreateDraft

CreateDraft(
params: CreateDraftParams,
credentials?: GmailCredentials,
): Promise<CreateDraftResult>
Creates a draft message in Gmail
Parameters
- params: CreateDraftParams
  Parameters for creating a draft
- Optionalcredentials: GmailCredentials
  Optional credentials override for this request. If not provided, uses environment variables. Set credentials.disableEnvironmentFallback = true to require explicit credentials.
Returns Promise<CreateDraftResult>
Overrides BaseCommunicationProvider.CreateDraft
- Defined in providers/gmail/src/GmailProvider.ts:682

DeleteMessage

DeleteMessage(
params: DeleteMessageParams,
credentials?: GmailCredentials,
): Promise<DeleteMessageResult>
Deletes a message from Gmail
Parameters
- params: DeleteMessageParams
  Parameters for deleting the message
- Optionalcredentials: GmailCredentials
  Optional credentials override for this request
Returns Promise<DeleteMessageResult>
Overrides BaseCommunicationProvider.DeleteMessage
- Defined in providers/gmail/src/GmailProvider.ts:809

DownloadAttachment

DownloadAttachment(
params: DownloadAttachmentParams,
credentials?: GmailCredentials,
): Promise<DownloadAttachmentResult>
Downloads an attachment from a message
Parameters
- params: DownloadAttachmentParams
  Parameters for downloading the attachment
- Optionalcredentials: GmailCredentials
  Optional credentials override for this request
Returns Promise<DownloadAttachmentResult>
Overrides BaseCommunicationProvider.DownloadAttachment
- Defined in providers/gmail/src/GmailProvider.ts:1186

ForwardMessage

ForwardMessage(
params: ForwardMessageParams,
credentials?: GmailCredentials,
): Promise<ForwardMessageResult>
Forward a message using Gmail API
Parameters
- params: ForwardMessageParams
  Parameters for forwarding a message
- Optionalcredentials: GmailCredentials
  Optional credentials override for this request. If not provided, uses environment variables. Set credentials.disableEnvironmentFallback = true to require explicit credentials.
Returns Promise<ForwardMessageResult>
Overrides BaseCommunicationProvider.ForwardMessage
- Defined in providers/gmail/src/GmailProvider.ts:542

GetMessages

GetMessages(
params: GetMessagesParams,
credentials?: GmailCredentials,
): Promise<GetMessagesResult>
Gets messages from Gmail
Parameters
- params: GetMessagesParams
  Parameters for fetching messages
- Optionalcredentials: GmailCredentials
  Optional credentials override for this request. If not provided, uses environment variables. Set credentials.disableEnvironmentFallback = true to require explicit credentials.
Returns Promise<GetMessagesResult>
Overrides BaseCommunicationProvider.GetMessages
- Defined in providers/gmail/src/GmailProvider.ts:357

GetSingleMessage

GetSingleMessage(
params: GetSingleMessageParams,
credentials?: GmailCredentials,
): Promise<GetSingleMessageResult>
Gets a single message by ID
Parameters
- params: GetSingleMessageParams
  Parameters for retrieving the message
- Optionalcredentials: GmailCredentials
  Optional credentials override for this request
Returns Promise<GetSingleMessageResult>
Overrides BaseCommunicationProvider.GetSingleMessage
- Defined in providers/gmail/src/GmailProvider.ts:766

getSupportedOperations

getSupportedOperations(): ProviderOperation[]
Returns the list of operations supported by the Gmail provider. Gmail supports all operations through its label-based system.

Returns ProviderOperation[]
Overrides BaseCommunicationProvider.getSupportedOperations
- Defined in providers/gmail/src/GmailProvider.ts:742

ListAttachments

ListAttachments(
params: ListAttachmentsParams,
credentials?: GmailCredentials,
): Promise<ListAttachmentsResult>
Lists attachments on a message
Parameters
- params: ListAttachmentsParams
  Parameters for listing attachments
- Optionalcredentials: GmailCredentials
  Optional credentials override for this request
Returns Promise<ListAttachmentsResult>
Overrides BaseCommunicationProvider.ListAttachments
- Defined in providers/gmail/src/GmailProvider.ts:1142

ListFolders

ListFolders(
params: ListFoldersParams,
credentials?: GmailCredentials,
): Promise<ListFoldersResult>
Lists Gmail labels (Gmail's equivalent of folders)
Parameters
- params: ListFoldersParams
  Parameters for listing labels
- Optionalcredentials: GmailCredentials
  Optional credentials override for this request
Returns Promise<ListFoldersResult>
Overrides BaseCommunicationProvider.ListFolders
- Defined in providers/gmail/src/GmailProvider.ts:907

MarkAsRead

MarkAsRead(
params: MarkAsReadParams,
credentials?: GmailCredentials,
): Promise<MarkAsReadResult>
Marks messages as read or unread
Parameters
- params: MarkAsReadParams
  Parameters for marking messages
- Optionalcredentials: GmailCredentials
  Optional credentials override for this request
Returns Promise<MarkAsReadResult>
Overrides BaseCommunicationProvider.MarkAsRead
- Defined in providers/gmail/src/GmailProvider.ts:990

MoveMessage

MoveMessage(
params: MoveMessageParams,
credentials?: GmailCredentials,
): Promise<MoveMessageResult>
Moves a message to a different label (Gmail's equivalent of folders) In Gmail, moving is done by adding/removing labels
Parameters
- params: MoveMessageParams
  Parameters for moving the message
- Optionalcredentials: GmailCredentials
  Optional credentials override for this request
Returns Promise<MoveMessageResult>
Overrides BaseCommunicationProvider.MoveMessage
- Defined in providers/gmail/src/GmailProvider.ts:851

ReplyToMessage

ReplyToMessage(
params: ReplyToMessageParams,
credentials?: GmailCredentials,
): Promise<ReplyToMessageResult>
Reply to a message using Gmail API
Parameters
- params: ReplyToMessageParams
  Parameters for replying to a message
- Optionalcredentials: GmailCredentials
  Optional credentials override for this request. If not provided, uses environment variables. Set credentials.disableEnvironmentFallback = true to require explicit credentials.
Returns Promise<ReplyToMessageResult>
Overrides BaseCommunicationProvider.ReplyToMessage
- Defined in providers/gmail/src/GmailProvider.ts:473

SearchMessages

SearchMessages(
params: SearchMessagesParams,
credentials?: GmailCredentials,
): Promise<SearchMessagesResult>
Searches messages using Gmail's search syntax
Parameters
- params: SearchMessagesParams
  Parameters for searching messages
- Optionalcredentials: GmailCredentials
  Optional credentials override for this request
Returns Promise<SearchMessagesResult>
Overrides BaseCommunicationProvider.SearchMessages
- Defined in providers/gmail/src/GmailProvider.ts:1066

SendSingleMessage

SendSingleMessage(
message: ProcessedMessage,
credentials?: GmailCredentials,
): Promise<MessageResult>
Sends a single message using the Gmail API
Parameters
- message: ProcessedMessage
  The message to send
- Optionalcredentials: GmailCredentials
  Optional credentials override for this request. If not provided, uses environment variables. Set credentials.disableEnvironmentFallback = true to require explicit credentials.
Returns Promise<MessageResult>
Overrides BaseCommunicationProvider.SendSingleMessage
- Defined in providers/gmail/src/GmailProvider.ts:280

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 GmailProvider

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns GmailProvider

Accessors

ProtectedProviderName

Returns string

Methods

ArchiveMessage

Parameters

Returns Promise<ArchiveMessageResult>

CreateDraft

Parameters

Returns Promise<CreateDraftResult>

DeleteMessage

Parameters

Returns Promise<DeleteMessageResult>

DownloadAttachment

Parameters

Returns Promise<DownloadAttachmentResult>

ForwardMessage

Parameters

Returns Promise<ForwardMessageResult>

GetMessages

Parameters

Returns Promise<GetMessagesResult>

GetSingleMessage

Parameters

Returns Promise<GetSingleMessageResult>

getSupportedOperations

Returns ProviderOperation[]

ListAttachments

Parameters

Returns Promise<ListAttachmentsResult>

ListFolders

Parameters

Returns Promise<ListFoldersResult>

MarkAsRead

Parameters

Returns Promise<MarkAsReadResult>

MoveMessage

Parameters

Returns Promise<MoveMessageResult>

ReplyToMessage

Parameters

Returns Promise<ReplyToMessageResult>

SearchMessages

Parameters

Returns Promise<SearchMessagesResult>

SendSingleMessage

Parameters

Returns Promise<MessageResult>

supportsOperation

Parameters

Returns boolean

Settings

On This Page

`Protected`ProviderName