# CommunityToolkit.Aspire.Posta - Package: `CommunityToolkit.Aspire.Posta` - Version: `13.5.0` - Target framework: `net10.0` - Source: [GitHub](https://github.com/CommunityToolkit/Aspire/tree/4ff8268fbd97ddd23cb73dc8eff9cc92718156d1/src/CommunityToolkit.Aspire.Posta) - NuGet: [CommunityToolkit.Aspire.Posta](https://www.nuget.org/packages/CommunityToolkit.Aspire.Posta) ## Namespaces ### CommunityToolkit.Aspire.Posta.Clients - [IPostaClient](/reference/api/csharp/communitytoolkit.aspire.posta/ipostaclient.md) -- `interface` -- Provides access to all Posta API sections and endpoint definitions. - [IPostaEmailsClient](/reference/api/csharp/communitytoolkit.aspire.posta/ipostaemailsclient.md) -- `interface` -- Provides Posta emails operations. - [IPostaHealthClient](/reference/api/csharp/communitytoolkit.aspire.posta/ipostahealthclient.md) -- `interface` -- Provides Posta health operations. - [IPostaInfoClient](/reference/api/csharp/communitytoolkit.aspire.posta/ipostainfoclient.md) -- `interface` -- Provides Posta info operations. - [IPostaSectionClient](/reference/api/csharp/communitytoolkit.aspire.posta/ipostasectionclient.md) -- `interface` -- Common operations exposed by each Posta API section. - [IPostaSubscriberListsClient](/reference/api/csharp/communitytoolkit.aspire.posta/ipostasubscriberlistsclient.md) -- `interface` -- Provides Posta subscriberlists operations. - [IPostaTemplatesClient](/reference/api/csharp/communitytoolkit.aspire.posta/ipostatemplatesclient.md) -- `interface` -- Provides Posta templates operations. ### CommunityToolkit.Aspire.Posta.Configuration - [IPostaCredentialProvider](/reference/api/csharp/communitytoolkit.aspire.posta/ipostacredentialprovider.md) -- `interface` -- Resolves bearer credentials for Posta requests. - [PostaClientSettings](/reference/api/csharp/communitytoolkit.aspire.posta/postaclientsettings.md) -- `class` `sealed` -- Configuration used by the Posta HTTP client. ### CommunityToolkit.Aspire.Posta.Endpoints - [IPostaEndpoints](/reference/api/csharp/communitytoolkit.aspire.posta/ipostaendpoints.md) -- `interface` -- Defines the application-facing Posta API endpoints supported by this client. - [PostaAuthentication](/reference/api/csharp/communitytoolkit.aspire.posta/postaauthentication.md) -- `enum` -- Authentication modes used by Posta. - [PostaEndpoint](/reference/api/csharp/communitytoolkit.aspire.posta/postaendpoint.md) -- `record` `sealed` -- Describes a Posta API operation. - [PostaEndpoints](/reference/api/csharp/communitytoolkit.aspire.posta/postaendpoints.md) -- `class` -- Provides the default application-facing Posta API endpoint definitions. ### CommunityToolkit.Aspire.Posta.Models.Emails - [GetEmailDeliveryStatusRequest](/reference/api/csharp/communitytoolkit.aspire.posta/getemaildeliverystatusrequest.md) -- `class` -- Represents the GetEmailDeliveryStatusRequest payload. - [GetEmailDeliveryStatusResponse](/reference/api/csharp/communitytoolkit.aspire.posta/getemaildeliverystatusresponse.md) -- `class` -- Represents the GetEmailDeliveryStatusResponse payload. - [GetEmailDetailsRequest](/reference/api/csharp/communitytoolkit.aspire.posta/getemaildetailsrequest.md) -- `class` -- Represents the GetEmailDetailsRequest payload. - [GetEmailDetailsResponse](/reference/api/csharp/communitytoolkit.aspire.posta/getemaildetailsresponse.md) -- `class` -- Represents the GetEmailDetailsResponse payload. - [PreviewEmailFromTemplateRequest](/reference/api/csharp/communitytoolkit.aspire.posta/previewemailfromtemplaterequest.md) -- `class` -- Represents the PreviewEmailFromTemplateRequest payload. - [PreviewEmailFromTemplateResponse](/reference/api/csharp/communitytoolkit.aspire.posta/previewemailfromtemplateresponse.md) -- `class` -- Represents the PreviewEmailFromTemplateResponse payload. - [RetryFailedEmailRequest](/reference/api/csharp/communitytoolkit.aspire.posta/retryfailedemailrequest.md) -- `class` -- Represents the RetryFailedEmailRequest payload. - [RetryFailedEmailResponse](/reference/api/csharp/communitytoolkit.aspire.posta/retryfailedemailresponse.md) -- `class` -- Represents the RetryFailedEmailResponse payload. - [SendAnEmailRequest](/reference/api/csharp/communitytoolkit.aspire.posta/sendanemailrequest.md) -- `class` -- Represents the SendAnEmailRequest payload. - [SendAnEmailResponse](/reference/api/csharp/communitytoolkit.aspire.posta/sendanemailresponse.md) -- `class` -- Represents the SendAnEmailResponse payload. - [SendBatchEmailsRequest](/reference/api/csharp/communitytoolkit.aspire.posta/sendbatchemailsrequest.md) -- `class` -- Represents the SendBatchEmailsRequest payload. - [SendBatchEmailsResponse](/reference/api/csharp/communitytoolkit.aspire.posta/sendbatchemailsresponse.md) -- `class` -- Represents the SendBatchEmailsResponse payload. - [SendEmailUsingTemplateRequest](/reference/api/csharp/communitytoolkit.aspire.posta/sendemailusingtemplaterequest.md) -- `class` -- Represents the SendEmailUsingTemplateRequest payload. - [SendEmailUsingTemplateResponse](/reference/api/csharp/communitytoolkit.aspire.posta/sendemailusingtemplateresponse.md) -- `class` -- Represents the SendEmailUsingTemplateResponse payload. - [VerifyAnEmailAddressRequest](/reference/api/csharp/communitytoolkit.aspire.posta/verifyanemailaddressrequest.md) -- `class` -- Represents the VerifyAnEmailAddressRequest payload. - [VerifyAnEmailAddressResponse](/reference/api/csharp/communitytoolkit.aspire.posta/verifyanemailaddressresponse.md) -- `class` -- Represents the VerifyAnEmailAddressResponse payload. ### CommunityToolkit.Aspire.Posta.Models.Health - [LivenessProbeResponse](/reference/api/csharp/communitytoolkit.aspire.posta/livenessproberesponse.md) -- `class` -- Represents the LivenessProbeResponse payload. - [ReadinessProbeResponse](/reference/api/csharp/communitytoolkit.aspire.posta/readinessproberesponse.md) -- `class` -- Represents the ReadinessProbeResponse payload. ### CommunityToolkit.Aspire.Posta.Models.Info - [ApplicationInfoResponse](/reference/api/csharp/communitytoolkit.aspire.posta/applicationinforesponse.md) -- `class` -- Represents the ApplicationInfoResponse payload. ### CommunityToolkit.Aspire.Posta.Models.Shared - [ApplicationInfoResponseData](/reference/api/csharp/communitytoolkit.aspire.posta/applicationinforesponsedata.md) -- `class` -- Represents the ApplicationInfoResponseData payload. - [CreateTemplateResponseData](/reference/api/csharp/communitytoolkit.aspire.posta/createtemplateresponsedata.md) -- `class` -- Represents the CreateTemplateResponseData payload. - [CreateTemplateResponseDataActiveVersion](/reference/api/csharp/communitytoolkit.aspire.posta/createtemplateresponsedataactiveversion.md) -- `class` -- Represents the CreateTemplateResponseDataActiveVersion payload. - [CreateTemplateResponseDataActiveVersionLocalizationsItem](/reference/api/csharp/communitytoolkit.aspire.posta/createtemplateresponsedataactiveversionlocalizationsitem.md) -- `class` -- Represents the CreateTemplateResponseDataActiveVersionLocalizationsItem payload. - [CreateTemplateResponseDataActiveVersionStylesheet](/reference/api/csharp/communitytoolkit.aspire.posta/createtemplateresponsedataactiveversionstylesheet.md) -- `class` -- Represents the CreateTemplateResponseDataActiveVersionStylesheet payload. - [CreateTemplateResponseDataCreatedBy](/reference/api/csharp/communitytoolkit.aspire.posta/createtemplateresponsedatacreatedby.md) -- `class` -- Represents the CreateTemplateResponseDataCreatedBy payload. - [CreateTemplateResponseDataLastEditedBy](/reference/api/csharp/communitytoolkit.aspire.posta/createtemplateresponsedatalasteditedby.md) -- `class` -- Represents the CreateTemplateResponseDataLastEditedBy payload. - [GetEmailDeliveryStatusResponseData](/reference/api/csharp/communitytoolkit.aspire.posta/getemaildeliverystatusresponsedata.md) -- `class` -- Represents the GetEmailDeliveryStatusResponseData payload. - [GetEmailDetailsResponseData](/reference/api/csharp/communitytoolkit.aspire.posta/getemaildetailsresponsedata.md) -- `class` -- Represents the GetEmailDetailsResponseData payload. - [GetTemplateResponseData](/reference/api/csharp/communitytoolkit.aspire.posta/gettemplateresponsedata.md) -- `class` -- Represents the GetTemplateResponseData payload. - [GetTemplateResponseDataActiveVersion](/reference/api/csharp/communitytoolkit.aspire.posta/gettemplateresponsedataactiveversion.md) -- `class` -- Represents the GetTemplateResponseDataActiveVersion payload. - [GetTemplateResponseDataActiveVersionLocalizationsItem](/reference/api/csharp/communitytoolkit.aspire.posta/gettemplateresponsedataactiveversionlocalizationsitem.md) -- `class` -- Represents the GetTemplateResponseDataActiveVersionLocalizationsItem payload. - [GetTemplateResponseDataActiveVersionStylesheet](/reference/api/csharp/communitytoolkit.aspire.posta/gettemplateresponsedataactiveversionstylesheet.md) -- `class` -- Represents the GetTemplateResponseDataActiveVersionStylesheet payload. - [GetTemplateResponseDataCreatedBy](/reference/api/csharp/communitytoolkit.aspire.posta/gettemplateresponsedatacreatedby.md) -- `class` -- Represents the GetTemplateResponseDataCreatedBy payload. - [GetTemplateResponseDataLastEditedBy](/reference/api/csharp/communitytoolkit.aspire.posta/gettemplateresponsedatalasteditedby.md) -- `class` -- Represents the GetTemplateResponseDataLastEditedBy payload. - [ListTemplatesResponseDataItem](/reference/api/csharp/communitytoolkit.aspire.posta/listtemplatesresponsedataitem.md) -- `class` -- Represents the ListTemplatesResponseDataItem payload. - [ListTemplatesResponseDataItemActiveVersion](/reference/api/csharp/communitytoolkit.aspire.posta/listtemplatesresponsedataitemactiveversion.md) -- `class` -- Represents the ListTemplatesResponseDataItemActiveVersion payload. - [ListTemplatesResponseDataItemActiveVersionLocalizationsItem](/reference/api/csharp/communitytoolkit.aspire.posta/listtemplatesresponsedataitemactiveversionlocalizationsitem.md) -- `class` -- Represents the ListTemplatesResponseDataItemActiveVersionLocalizationsItem payload. - [ListTemplatesResponseDataItemActiveVersionStylesheet](/reference/api/csharp/communitytoolkit.aspire.posta/listtemplatesresponsedataitemactiveversionstylesheet.md) -- `class` -- Represents the ListTemplatesResponseDataItemActiveVersionStylesheet payload. - [ListTemplatesResponseDataItemCreatedBy](/reference/api/csharp/communitytoolkit.aspire.posta/listtemplatesresponsedataitemcreatedby.md) -- `class` -- Represents the ListTemplatesResponseDataItemCreatedBy payload. - [ListTemplatesResponseDataItemLastEditedBy](/reference/api/csharp/communitytoolkit.aspire.posta/listtemplatesresponsedataitemlasteditedby.md) -- `class` -- Represents the ListTemplatesResponseDataItemLastEditedBy payload. - [ListTemplatesResponsePageable](/reference/api/csharp/communitytoolkit.aspire.posta/listtemplatesresponsepageable.md) -- `class` -- Represents the ListTemplatesResponsePageable payload. - [PreviewEmailFromTemplateResponseData](/reference/api/csharp/communitytoolkit.aspire.posta/previewemailfromtemplateresponsedata.md) -- `class` -- Represents the PreviewEmailFromTemplateResponseData payload. - [PreviewTemplateResponseData](/reference/api/csharp/communitytoolkit.aspire.posta/previewtemplateresponsedata.md) -- `class` -- Represents the PreviewTemplateResponseData payload. - [ReSubscribeAnEmailToAListResponseData](/reference/api/csharp/communitytoolkit.aspire.posta/resubscribeanemailtoalistresponsedata.md) -- `class` -- Represents the ReSubscribeAnEmailToAListResponseData payload. - [RetryFailedEmailResponseData](/reference/api/csharp/communitytoolkit.aspire.posta/retryfailedemailresponsedata.md) -- `class` -- Represents the RetryFailedEmailResponseData payload. - [SendAnEmailRequestAttachmentsItem](/reference/api/csharp/communitytoolkit.aspire.posta/sendanemailrequestattachmentsitem.md) -- `class` -- Represents the SendAnEmailRequestAttachmentsItem payload. - [SendAnEmailRequestUnsubscribe](/reference/api/csharp/communitytoolkit.aspire.posta/sendanemailrequestunsubscribe.md) -- `class` -- Represents the SendAnEmailRequestUnsubscribe payload. - [SendAnEmailResponseData](/reference/api/csharp/communitytoolkit.aspire.posta/sendanemailresponsedata.md) -- `class` -- Represents the SendAnEmailResponseData payload. - [SendBatchEmailsRequestRecipientsItem](/reference/api/csharp/communitytoolkit.aspire.posta/sendbatchemailsrequestrecipientsitem.md) -- `class` -- Represents the SendBatchEmailsRequestRecipientsItem payload. - [SendBatchEmailsRequestUnsubscribe](/reference/api/csharp/communitytoolkit.aspire.posta/sendbatchemailsrequestunsubscribe.md) -- `class` -- Represents the SendBatchEmailsRequestUnsubscribe payload. - [SendBatchEmailsResponseData](/reference/api/csharp/communitytoolkit.aspire.posta/sendbatchemailsresponsedata.md) -- `class` -- Represents the SendBatchEmailsResponseData payload. - [SendBatchEmailsResponseDataResultsItem](/reference/api/csharp/communitytoolkit.aspire.posta/sendbatchemailsresponsedataresultsitem.md) -- `class` -- Represents the SendBatchEmailsResponseDataResultsItem payload. - [SendEmailUsingTemplateRequestAttachmentsItem](/reference/api/csharp/communitytoolkit.aspire.posta/sendemailusingtemplaterequestattachmentsitem.md) -- `class` -- Represents the SendEmailUsingTemplateRequestAttachmentsItem payload. - [SendEmailUsingTemplateRequestUnsubscribe](/reference/api/csharp/communitytoolkit.aspire.posta/sendemailusingtemplaterequestunsubscribe.md) -- `class` -- Represents the SendEmailUsingTemplateRequestUnsubscribe payload. - [SendEmailUsingTemplateResponseData](/reference/api/csharp/communitytoolkit.aspire.posta/sendemailusingtemplateresponsedata.md) -- `class` -- Represents the SendEmailUsingTemplateResponseData payload. - [SendTestEmailResponseData](/reference/api/csharp/communitytoolkit.aspire.posta/sendtestemailresponsedata.md) -- `class` -- Represents the SendTestEmailResponseData payload. - [SubscribeAnEmailToAListResponseData](/reference/api/csharp/communitytoolkit.aspire.posta/subscribeanemailtoalistresponsedata.md) -- `class` -- Represents the SubscribeAnEmailToAListResponseData payload. - [UnsubscribeAnEmailFromAListResponseData](/reference/api/csharp/communitytoolkit.aspire.posta/unsubscribeanemailfromalistresponsedata.md) -- `class` -- Represents the UnsubscribeAnEmailFromAListResponseData payload. - [UpdateTemplateResponseData](/reference/api/csharp/communitytoolkit.aspire.posta/updatetemplateresponsedata.md) -- `class` -- Represents the UpdateTemplateResponseData payload. - [UpdateTemplateResponseDataActiveVersion](/reference/api/csharp/communitytoolkit.aspire.posta/updatetemplateresponsedataactiveversion.md) -- `class` -- Represents the UpdateTemplateResponseDataActiveVersion payload. - [UpdateTemplateResponseDataActiveVersionLocalizationsItem](/reference/api/csharp/communitytoolkit.aspire.posta/updatetemplateresponsedataactiveversionlocalizationsitem.md) -- `class` -- Represents the UpdateTemplateResponseDataActiveVersionLocalizationsItem payload. - [UpdateTemplateResponseDataActiveVersionStylesheet](/reference/api/csharp/communitytoolkit.aspire.posta/updatetemplateresponsedataactiveversionstylesheet.md) -- `class` -- Represents the UpdateTemplateResponseDataActiveVersionStylesheet payload. - [UpdateTemplateResponseDataCreatedBy](/reference/api/csharp/communitytoolkit.aspire.posta/updatetemplateresponsedatacreatedby.md) -- `class` -- Represents the UpdateTemplateResponseDataCreatedBy payload. - [UpdateTemplateResponseDataLastEditedBy](/reference/api/csharp/communitytoolkit.aspire.posta/updatetemplateresponsedatalasteditedby.md) -- `class` -- Represents the UpdateTemplateResponseDataLastEditedBy payload. - [VerifyAnEmailAddressResponseData](/reference/api/csharp/communitytoolkit.aspire.posta/verifyanemailaddressresponsedata.md) -- `class` -- Represents the VerifyAnEmailAddressResponseData payload. - [VerifyAnEmailAddressResponseDataChecks](/reference/api/csharp/communitytoolkit.aspire.posta/verifyanemailaddressresponsedatachecks.md) -- `class` -- Represents the VerifyAnEmailAddressResponseDataChecks payload. ### CommunityToolkit.Aspire.Posta.Models.SubscriberLists - [ReSubscribeAnEmailToAListRequest](/reference/api/csharp/communitytoolkit.aspire.posta/resubscribeanemailtoalistrequest.md) -- `class` -- Represents the ReSubscribeAnEmailToAListRequest payload. - [ReSubscribeAnEmailToAListResponse](/reference/api/csharp/communitytoolkit.aspire.posta/resubscribeanemailtoalistresponse.md) -- `class` -- Represents the ReSubscribeAnEmailToAListResponse payload. - [SubscribeAnEmailToAListRequest](/reference/api/csharp/communitytoolkit.aspire.posta/subscribeanemailtoalistrequest.md) -- `class` -- Represents the SubscribeAnEmailToAListRequest payload. - [SubscribeAnEmailToAListResponse](/reference/api/csharp/communitytoolkit.aspire.posta/subscribeanemailtoalistresponse.md) -- `class` -- Represents the SubscribeAnEmailToAListResponse payload. - [UnsubscribeAnEmailFromAListRequest](/reference/api/csharp/communitytoolkit.aspire.posta/unsubscribeanemailfromalistrequest.md) -- `class` -- Represents the UnsubscribeAnEmailFromAListRequest payload. - [UnsubscribeAnEmailFromAListResponse](/reference/api/csharp/communitytoolkit.aspire.posta/unsubscribeanemailfromalistresponse.md) -- `class` -- Represents the UnsubscribeAnEmailFromAListResponse payload. ### CommunityToolkit.Aspire.Posta.Models.Templates - [CreateTemplateRequest](/reference/api/csharp/communitytoolkit.aspire.posta/createtemplaterequest.md) -- `class` -- Represents the CreateTemplateRequest payload. - [CreateTemplateResponse](/reference/api/csharp/communitytoolkit.aspire.posta/createtemplateresponse.md) -- `class` -- Represents the CreateTemplateResponse payload. - [DeleteTemplateRequest](/reference/api/csharp/communitytoolkit.aspire.posta/deletetemplaterequest.md) -- `class` -- Represents the DeleteTemplateRequest payload. - [DeleteTemplateResponse](/reference/api/csharp/communitytoolkit.aspire.posta/deletetemplateresponse.md) -- `class` -- Represents the DeleteTemplateResponse payload. - [GetTemplateRequest](/reference/api/csharp/communitytoolkit.aspire.posta/gettemplaterequest.md) -- `class` -- Represents the GetTemplateRequest payload. - [GetTemplateResponse](/reference/api/csharp/communitytoolkit.aspire.posta/gettemplateresponse.md) -- `class` -- Represents the GetTemplateResponse payload. - [ListTemplatesRequest](/reference/api/csharp/communitytoolkit.aspire.posta/listtemplatesrequest.md) -- `class` -- Represents the ListTemplatesRequest payload. - [ListTemplatesResponse](/reference/api/csharp/communitytoolkit.aspire.posta/listtemplatesresponse.md) -- `class` -- Represents the ListTemplatesResponse payload. - [PreviewTemplateRequest](/reference/api/csharp/communitytoolkit.aspire.posta/previewtemplaterequest.md) -- `class` -- Represents the PreviewTemplateRequest payload. - [PreviewTemplateResponse](/reference/api/csharp/communitytoolkit.aspire.posta/previewtemplateresponse.md) -- `class` -- Represents the PreviewTemplateResponse payload. - [SendTestEmailRequest](/reference/api/csharp/communitytoolkit.aspire.posta/sendtestemailrequest.md) -- `class` -- Represents the SendTestEmailRequest payload. - [SendTestEmailResponse](/reference/api/csharp/communitytoolkit.aspire.posta/sendtestemailresponse.md) -- `class` -- Represents the SendTestEmailResponse payload. - [UpdateTemplateRequest](/reference/api/csharp/communitytoolkit.aspire.posta/updatetemplaterequest.md) -- `class` -- Represents the UpdateTemplateRequest payload. - [UpdateTemplateResponse](/reference/api/csharp/communitytoolkit.aspire.posta/updatetemplateresponse.md) -- `class` -- Represents the UpdateTemplateResponse payload. ### CommunityToolkit.Aspire.Posta.Transport - [PostaApiException](/reference/api/csharp/communitytoolkit.aspire.posta/postaapiexception.md) -- `class` `sealed` -- Represents a non-successful response returned by Posta. - [PostaRequest](/reference/api/csharp/communitytoolkit.aspire.posta/postarequest.md) -- `class` `sealed` -- Arguments for invoking a Posta endpoint. - [PostaStreamResponse](/reference/api/csharp/communitytoolkit.aspire.posta/postastreamresponse.md) -- `class` `sealed` -- Owns a streaming Posta response and its content stream. ### Microsoft.Extensions.Hosting - [AspirePostaExtensions](/reference/api/csharp/communitytoolkit.aspire.posta/aspirepostaextensions.md) -- `class` `static` -- Extension methods for registering a Posta API client.