Skip to content

mailPublicFolders

Mail-Enabled Public Folders. Public folders that can receive email. The mailPublicFolders entity set lives under /exchange/v1.0/mailPublicFolders in the Public folders category.

Fact Value
Path /exchange/v1.0/mailPublicFolders
Category Public folders
Tier Tier 7, Public folders
Read role PublicFolder.Read.All (Community)
Write role PublicFolder.ReadWrite.All (Pro)
Backing cmdlets Get-MailPublicFolder, Set-MailPublicFolder, Enable-MailPublicFolder, Disable-MailPublicFolder
Method Path Synopsis Role Plan
GET /exchange/v1.0/mailPublicFolders List mailPublicFolders entries. PublicFolder.Read Community
GET /exchange/v1.0/mailPublicFolders/{key} Get a single mailPublicFolders entry by Identity. PublicFolder.Read Community
PATCH /exchange/v1.0/mailPublicFolders/{key} PATCH /mailPublicFolders/{key} - Set-MailPublicFolder. ~50-param config surface (custom attrs, accept/reject lists, moderation, forwarding, MailTip, etc.). Renames are supported via name in body. PublicFolder.ReadWrite Pro

List mailPublicFolders entries.

Backing cmdlet: Get-MailPublicFolder. Role: PublicFolder.Read (Community).

Parameter In Type Required Description
anr query string
filter query string
resultSize query int

Stub auto-generated example for the mailPublicFolders collection. Backing cmdlet: Get-MailPublicFolder. Live-verify with ?$top=3&$select=Id,Name and replace the synthetic body before promoting to Tier 1.

GET /exchange/v1.0/mailPublicFolders?$top=3 HTTP/1.1
Authorization: Bearer {token}
HTTP/1.1 200 OK
{
"@odata.context": "http://localhost:5043/exchange/v1.0/$metadata#mailPublicFolders",
"value": []
}

Notes: Illustrative example derived from the cmdlet documentation, not a live capture: field names are real, values are placeholders.

Related: GET /exchange/v1.0/mailPublicFolders/{key}

GET /exchange/v1.0/mailPublicFolders/{key}

Section titled “GET /exchange/v1.0/mailPublicFolders/{key}”

Get a single mailPublicFolders entry by Identity.

Backing cmdlet: Get-MailPublicFolder. Role: PublicFolder.Read (Community).

Stub auto-generated example for GET /mailPublicFolders/{key}. Backing cmdlet: Get-MailPublicFolder with -Identity {key}. Returns the full entity body; 404 if the identity doesn’t resolve.

GET /exchange/v1.0/mailPublicFolders/{key} HTTP/1.1
Authorization: Bearer {token}
HTTP/1.1 200 OK
{
"@odata.context": "http://localhost:5043/exchange/v1.0/$metadata#mailPublicFolders/$entity"
}

Notes: Illustrative example derived from the cmdlet documentation, not a live capture: field names are real, values are placeholders.

Related: GET /exchange/v1.0/mailPublicFolders

PATCH /exchange/v1.0/mailPublicFolders/{key}

Section titled “PATCH /exchange/v1.0/mailPublicFolders/{key}”

PATCH /mailPublicFolders/{key} - Set-MailPublicFolder. ~50-param config surface (custom attrs, accept/reject lists, moderation, forwarding, MailTip, etc.). Renames are supported via name in body.

Backing cmdlet: Set-MailPublicFolder. Role: PublicFolder.ReadWrite (Pro).

Parameter In Type Required Description
acceptMessagesOnlyFrom body
acceptMessagesOnlyFromDLMembers body
acceptMessagesOnlyFromSendersOrMembers body
alias body
bypassModerationFromSendersOrMembers body
contacts body
customAttribute1 body
customAttribute10 body
customAttribute11 body
customAttribute12 body
customAttribute13 body
customAttribute14 body
customAttribute15 body
customAttribute2 body
customAttribute3 body
customAttribute4 body
customAttribute5 body
customAttribute6 body
customAttribute7 body
customAttribute8 body
customAttribute9 body
deliverToMailboxAndForward body
displayName body
emailAddresses body
emailAddressPolicyEnabled body
entryId body
extensionCustomAttribute1 body
extensionCustomAttribute2 body
extensionCustomAttribute3 body
extensionCustomAttribute4 body
extensionCustomAttribute5 body
externalEmailAddress body
forwardingAddress body
grantSendOnBehalfTo body
hiddenFromAddressListsEnabled body
mailTip body
mailTipTranslations body
maxReceiveSize body
maxSendSize body
moderatedBy body
moderationEnabled body
name body
phoneticDisplayName body
primarySmtpAddress body
rejectMessagesFrom body
rejectMessagesFromDLMembers body
rejectMessagesFromSendersOrMembers body
requireSenderAuthenticationEnabled body
sendModerationNotifications body
simpleDisplayName body
windowsEmailAddress body
ignoreDefaultScope query bool (switch)
dryRun query bool (switch)

Tunes the mail configuration of a mail-enabled public folder via Set-MailPublicFolder (display name, custom attribute, MailTip). Mail-state lifecycle lives on the parent publicFolders enableMail/disableMail actions; this route only adjusts directory config.

PATCH /exchange/v1.0/mailPublicFolders/{key} HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
{
"displayName": "Exonaut Sample MailPublicFolder",
"customAttribute1": "exonaut-sample-mailPublicFolders",
"mailTip": "Internal use only - managed by Exonaut."
}
HTTP/1.1 200 OK
Content-Type: application/json; odata.metadata=minimal
{
"Identity": "\\exonaut-sample-mailPublicFolders",
"DisplayName": "Exonaut Sample MailPublicFolder",
"CustomAttribute1": "exonaut-sample-mailPublicFolders",
"MailTip": "Internal use only - managed by Exonaut.",
"PrimarySmtpAddress": "[email protected]"
}

Notes: Doc-derived from Wiki + write-param allowlist; not live-captured. Body fields are Wiki-valid; values are illustrative.

Related: GET /exchange/v1.0/mailPublicFolders

?dryRun=true previews of any write stay on Community.