PowerShell/docs/new-email.md

71 lines
1.6 KiB
Markdown
Raw Normal View History

2024-11-08 12:38:20 +01:00
The *new-email.ps1* Script
===========================
2021-11-08 21:36:42 +01:00
2022-02-10 09:01:07 +01:00
This PowerShell script opens the default email client to write a new email.
2021-11-08 21:36:42 +01:00
2023-07-29 10:04:38 +02:00
Parameters
----------
2021-11-08 21:36:42 +01:00
```powershell
2024-11-08 12:35:11 +01:00
/home/markus/Repos/PowerShell/scripts/new-email.ps1 [[-EmailAddress] <String>] [<CommonParameters>]
2021-11-08 21:36:42 +01:00
-EmailAddress <String>
Specifies the email address fill in
Required? false
Position? 1
Default value markus@fleschutz.de
Accept pipeline input? false
Accept wildcard characters? false
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
2023-07-29 10:04:38 +02:00
Example
-------
2021-11-08 21:36:42 +01:00
```powershell
2023-08-06 21:36:33 +02:00
PS> ./new-email.ps1
2021-11-08 21:36:42 +01:00
```
2023-07-29 10:04:38 +02:00
Notes
-----
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2021-11-08 21:36:42 +01:00
2023-07-29 10:04:38 +02:00
Related Links
-------------
2021-11-08 21:36:42 +01:00
https://github.com/fleschutz/PowerShell
2023-07-29 10:04:38 +02:00
Script Content
--------------
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
Opens the default email client to write a new email
.DESCRIPTION
This PowerShell script opens the default email client to write a new email.
.PARAMETER EmailAddress
Specifies the email address fill in
.EXAMPLE
2023-08-06 21:36:33 +02:00
PS> ./new-email.ps1
2022-11-17 20:02:26 +01:00
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$EmailAddress = "markus@fleschutz.de")
try {
$URL="mailto:$EmailAddress"
Start-Process $URL
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
2022-11-17 20:05:34 +01:00
```
2022-11-17 20:02:26 +01:00
2024-11-08 12:38:20 +01:00
*(generated by convert-ps2md.ps1 using the comment-based help of new-email.ps1 as of 11/08/2024 12:37:54)*