Cmdlets for SuiteCRM

Build 24.0.9060

InboundEmail

Create, update, delete, and query SuiteCRM inbound emails

Table Specific Information

Select

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

SELECT * FROM [Inbound Email] WHERE [Monitored Folders] LIKE '%MANAGEMENT%' 

Insert

Create an Inbound Email by specifying any writable column.

INSERT INTO [Inbound Email] (Name, [Group Folder Id]) VALUES ('Fast replies', 'groupId123')

Update

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

UPDATE [Inbound Email] SET [Auto-Reply Template] = 'emailTemplateId2' WHERE Id = 'Test123' 

Delete

Delete an Inbound Email by specifying the Id.

DELETE FROM [Inbound Email] WHERE Id = '10003'

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier of the inbound email.

Auto-ReplyTemplate String False

The inbound email's auto-reply template

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.

DeleteReadEmailsAfterImport Bool False

Whether the emails are deleted after an import

Deleted Bool False

The record deletion indicator.

GroupFolderId String False

Id of the group's folder linked to the email

LBL_GROUP_ID String False

Group Id linked to the email

LBL_SERVICE String False

Service type of the inbound email

LBL_STORED_OPTIONS String False

Stored options of the inbound email

MailServerAddress String False

URL of the mail server to retrieve inbound emails from

MailServerProtocol Int False

Mail protocol of the mail server

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.

MonitoredFolders String False

Folders monitored from the mail server

Name String False

name of the inbound email

Password String False

Authentication password required to access the mail server

Personal Bool False

Whether the inbound email is personal

PossibleActions String False

The mail server's mailbox type

Status String False

Status of the inbound email

UserName String False

SMTP Username to connect to the mail server

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) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060