Cmdlets for SuiteCRM

Build 22.0.8462

EmailTemplates

Create, update, delete, and query email templates to be used for emails

Table Specific Information

Select

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

SELECT * FROM [Email Templates] WHERE Published = True 

Insert

Create an Email Template by specifying any writable column.

INSERT INTO [Email Templates] (Name,Description) VALUES ('Example','Creating an example email')

Update

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

UPDATE [Email Templates] SET [Text Only] = True WHERE Id = 'Test123' 

Delete

Delete an Email Template 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 template.

AssignedUserId String False

The Id of the user assigned to the record.

AssignedUserName String False

The user name of the user assigned to the record.

Body String False

Plaintext body of the resulting email.

CreatedById String True

The Id of the user who created the record.

CreatedByName String True

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

Deleted Bool False

The record deletion indicator.

Description String False

The description for the email template.

ModifiedById String True

The Id of the user who last modified the record.

ModifiedByName String True

The name of the user who last modified the record.

Name String False

The name of the email template.

PlainText String False

The HTML-formatted body of the resulting email.

Published Bool False

The published status of the record.

Subject String False

The subject of the resulting email.

TextOnly Bool False

Whether the email template is to be sent in text only.

Type String False

The type of the email template.

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