Skip to content

Add-IvantiEmailNote

SYNOPSIS

Add an email note to a business object in Ivanti ITSM.

SYNTAX

ParentRecID (Default)

Add-IvantiEmailNote -parentRecID <String> -mailFrom <String> -mailTo <String> -subject <String>
 -emailBody <String> -category <String> [-publishtoWeb <Boolean>] [-timeSpent <Int32>] [<CommonParameters>]

serviceReqNumber

Add-IvantiEmailNote -serviceReqNumber <Int32> -mailFrom <String> -mailTo <String> -subject <String>
 -emailBody <String> -category <String> [-publishtoWeb <Boolean>] [-timeSpent <Int32>] [<CommonParameters>]

incidentNumber

Add-IvantiEmailNote -incidentNumber <Int32> -mailFrom <String> -mailTo <String> -subject <String>
 -emailBody <String> -category <String> [-publishtoWeb <Boolean>] [-timeSpent <Int32>] [<CommonParameters>]

DESCRIPTION

The `Add-EmailNote` function allows you to add an email note to a business object in Ivanti ITSM. You can specify the business object using various parameters such as service request number, incident number, or parent record ID. The function also accepts parameters for the email's body, subject, and other details.

EXAMPLES

EXAMPLE 1

Add-EmailNote -serviceReqNumber 12345 -noteSubject 'Follow-up' -noteCategory 'General' -noteBody 'Follow-up on the service request' -timeSpent 30

Adds an email note to the service request with the number 12345.

EXAMPLE 2

Add-EmailNote -incidentNumber 67890 -noteSubject 'Resolution' -noteCategory 'Technical' -noteBody 'Resolved the incident' -timeSpent 45

Adds an email note to the incident with the number 67890.

EXAMPLE 3

Add-EmailNote -parentRecID 'abc123' -noteSubject 'Meeting Notes' -noteCategory 'Meeting' -noteBody 'Notes from the meeting' -timeSpent 60

Adds an email note to the business object with the record ID 'abc123'.

PARAMETERS

-serviceReqNumber

The service request number of the business object to which the email note will be added. This parameter is mandatory when using the 'serviceReqNumber' parameter set.

Type: Int32
Parameter Sets: serviceReqNumber
Aliases: SR

Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-incidentNumber

The incident number of the business object to which the email note will be added. This parameter is mandatory when using the 'incidentNumber' parameter set.

Type: Int32
Parameter Sets: incidentNumber
Aliases: Incident

Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-parentRecID

The record ID of the parent business object to which the email note will be added. This parameter is mandatory when using the 'ParentRecID' parameter set.

Type: String
Parameter Sets: ParentRecID
Aliases: RecID

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-mailFrom

{{ Fill mailFrom Description }}

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-mailTo

{{ Fill mailTo Description }}

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-subject

{{ Fill subject Description }}

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-emailBody

{{ Fill emailBody Description }}

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-category

{{ Fill category Description }}

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-publishtoWeb

{{ Fill publishtoWeb Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: True
Accept pipeline input: False
Accept wildcard characters: False

-timeSpent

{{ Fill timeSpent Description }}

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 1
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

This function is useful for adding email notes to various business objects in Ivanti ITSM.

https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Configure/API/Create-a-Business-Object.htm