Set AvmTamMarkMessage - Gincules/avmtools GitHub Wiki

Set-AvmTamMarkMessage

Synopsis

Action: MarkMessage
Available on: ✅ FRITZ!Box / đŸšĢ FRITZ!Repeater
Status: ✅
Remote access: ✅
Required rights: ☎ī¸

Description

This function marks a specified message as read. A specific TAM is selected by Index.
The Index field from a message in the MessageList should be taken for the MessageIndex to select a specific message. If the MarkedAsRead state variable is set to 1, the message is marked as read, when it is 0, the message is marked as unread. The default value is 1 to guarantee downward compatibility to older clients.

Input:

Data type Variable Example or Description
Ushort NewIndex 0
Ushort NewMessageIndex 0
Boolean NewMarkedAsRead 1

Output:

Data type Variable Example
String u urn:dslforum-org:service:X_AVM-DE_TAM:1

Syntax

Set-AvmTamMarkMessage
    [-Insecure]
    [-RemoteAccess]
    [-Url <String>]
    [-Port <Ushort>]
    [-Credential <PSCredential>]
    [-NewIndex <Ushort>]
    [-NewMessageIndex <Ushort>]
    [-NewMarkedAsRead <Boolean>]

Examples

Example 1

This example describes how to run the command using a valid certificate and remote access.

[PSCredential]$Credential = Import-Clixml -Path "${env:APPDATA}\PScred\avmtools-credential.xml"

$splatParameters = @{
    RemoteAccess = $true
    Url = "https://myfritzaddress12.myfritz.net"
    Port = 443
    Credential = $Credential
    NewIndex = 0
    NewMessageIndex = 0
    NewMarkedAsRead = 1
}

Set-AvmTamMarkMessage @splatParameters

Example 2

This example describes how to run the command using local connection with a valid certificate.

[PSCredential]$Credential = Import-Clixml -Path "${env:APPDATA}\PScred\avmtools-credential.xml"

$splatParameters = @{
    Url = "https://fritz.box"
    Port = 49443
    Credential = $Credential
    NewIndex = 0
    NewMessageIndex = 0
    NewMarkedAsRead = 1
}

Set-AvmTamMarkMessage @splatParameters

IP address can be used instead of DNS name.

[PSCredential]$Credential = Import-Clixml -Path "${env:APPDATA}\PScred\avmtools-credential.xml"

$splatParameters = @{
    Url = "https://192.168.178.1"
    Port = 49443
    Credential = $Credential
    NewIndex = 0
    NewMessageIndex = 0
    NewMarkedAsRead = 1
}

Set-AvmTamMarkMessage @splatParameters

Example 3

This example describes how to run the command using local connection without a valid certificate.

[PSCredential]$Credential = Import-Clixml -Path "${env:APPDATA}\PScred\avmtools-credential.xml"

$splatParameters = @{
    Insecure = $true
    Url = "http://fritz.box"
    Port = 49000
    Credential = $Credential
    NewIndex = 0
    NewMessageIndex = 0
    NewMarkedAsRead = 1
}

Set-AvmTamMarkMessage @splatParameters

IP address can be used instead of DNS name.

[PSCredential]$Credential = Import-Clixml -Path "${env:APPDATA}\PScred\avmtools-credential.xml"

$splatParameters = @{
    Insecure = $true
    Url = "http://192.168.178.1"
    Port = 49000
    Credential = $Credential
    NewIndex = 0
    NewMessageIndex = 0
    NewMarkedAsRead = 1
}

Set-AvmTamMarkMessage @splatParameters

Copyright Šī¸ 2020 Gincules. All rights reserved.

⚠ī¸ **GitHub.com Fallback** ⚠ī¸