JDBC Driver for SuiteCRM

Build 22.0.8462

Emails

Create, update, delete, and query sent or received emails

Table Specific Information

Select

You can query the Emails table using any criteria in the WHERE clause. The driver will use the SuiteCRM API to filter the results.

SELECT * FROM Emails WHERE Intent LIKE '%Testing%' 

Insert

Create an Email by specifying any writable column.

INSERT INTO Emails (Name,From_Addr_Name,CC_Addrs_Names) VALUES ('Example','Contact','Included')

Update

You can update any Email column that is writable, by specifying the Id.

UPDATE Emails SET Flagged = True WHERE Id = 'Test123'

Delete

Delete an Email by specifying the Id.

DELETE FROM Emails WHERE Id = '10003'

Columns

Name Type ReadOnly Description
ID [KEY] String False

The unique identifier of the email.

Assignedto String True

The user name of the user assigned to the record.

AssignedUserId String False

The Id of the user assigned to the record.

bcc_addrs_names String True

The bcc addresses in the email.

CC_Addrs_names String True

The cc addresses in the email.

CreatedById String True

The Id of the user who created the record.

CreatedByName String True

The user name of the user who created the record.

DateCreated Datetime True

The date the record was created.

DateModified Datetime True

The date the record was last modified.

DateSent Datetime False

The date the email was sent.

Deleted Bool False

The record deletion indicator.

description String True

The description for the email.

description_html String True

The HTML description for the email.

EmailStatus String False

The status of the email.

Flagged Bool False

The flagged status of the email.

from_addr_name String True

The from address in the email.

Intent String False

The target of the action used in the Inbound Email assignment.

LBL_MAILBOX_ID String False

The Id of the mailbox associated with the email.

MessageID String False

The Id of the email item obtained from the email transport system.

ModifiedById String True

The Id of the user who last modified the record.

ModifiedByName String True

The user name of the user who last modified the record.

Name String False

The subject of the email.

Parent_ID String False

The Id of the Sugar module associated with the email. (Deprecated as of 4.2.)

Parent_Name String True

The name of the Sugar module associated with the email.

Parent_Type String False

The type of the Sugar module associated with the email. (Deprecated as of 4.2.)

raw_source String True

The raw source for the email.

ReplyToStatus Bool False

The reply-to status of the email. If you reply to an email then the reply-to status of original email is set.

reply_to_addr String True

The reply-to address in the email.

to_addrs_names String True

The to addresses in the email.

Type String False

The type of the email (e.g., draft).

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462