PinpointEmail class

Welcome to the Amazon Pinpoint Email API Reference. This guide provides information about the Amazon Pinpoint Email API (version 1.0), including supported operations, data types, parameters, and schemas.

Constructors

PinpointEmail({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

createConfigurationSet({required String configurationSetName, DeliveryOptions? deliveryOptions, ReputationOptions? reputationOptions, SendingOptions? sendingOptions, List<Tag>? tags, TrackingOptions? trackingOptions}) → Future<void>

Create a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

createConfigurationSetEventDestination({required String configurationSetName, required EventDestinationDefinition eventDestination, required String eventDestinationName}) → Future<void>

Create an event destination. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

createDedicatedIpPool({required String poolName, List<Tag>? tags}) → Future<void>

Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Pinpoint account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, Amazon Pinpoint sends it using only the IP addresses in the associated pool.

createDeliverabilityTestReport({required EmailContent content, required String fromEmailAddress, String? reportName, List<Tag>? tags}) → Future<CreateDeliverabilityTestReportResponse>

Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon Pinpoint then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to view the results of the test.

createEmailIdentity({required String emailIdentity, List<Tag>? tags}) → Future<CreateEmailIdentityResponse>

Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email address or domain that you use when you send email. Before you can use an identity to send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you demonstrate that you're the owner of the address, and that you've given Amazon Pinpoint permission to send email from the address.

deleteConfigurationSet({required String configurationSetName}) → Future<void>

Delete an existing configuration set.

deleteConfigurationSetEventDestination({required String configurationSetName, required String eventDestinationName}) → Future<void>

Delete an event destination.

deleteDedicatedIpPool({required String poolName}) → Future<void>

Delete a dedicated IP pool.

deleteEmailIdentity({required String emailIdentity}) → Future<void>

Deletes an email identity that you previously verified for use with Amazon Pinpoint. An identity can be either an email address or a domain name.

getAccount() → Future<GetAccountResponse>

Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.

getBlacklistReports({required List<String> blacklistItemNames}) → Future<GetBlacklistReportsResponse>

Retrieve a list of the blacklists that your dedicated IP addresses appear on.

getConfigurationSet({required String configurationSetName}) → Future<GetConfigurationSetResponse>

Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more.

getConfigurationSetEventDestinations({required String configurationSetName}) → Future<GetConfigurationSetEventDestinationsResponse>

Retrieve a list of event destinations that are associated with a configuration set.

getDedicatedIp({required String ip}) → Future<GetDedicatedIpResponse>

Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.

getDedicatedIps({String? nextToken, int? pageSize, String? poolName}) → Future<GetDedicatedIpsResponse>

List the dedicated IP addresses that are associated with your Amazon Pinpoint account.

getDeliverabilityDashboardOptions() → Future<GetDeliverabilityDashboardOptionsResponse>

Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.

getDeliverabilityTestReport({required String reportId}) → Future<GetDeliverabilityTestReportResponse>

Retrieve the results of a predictive inbox placement test.

getDomainDeliverabilityCampaign({required String campaignId}) → Future<GetDomainDeliverabilityCampaignResponse>

Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation).

getDomainStatisticsReport({required String domain, required DateTime endDate, required DateTime startDate}) → Future<GetDomainStatisticsReportResponse>

Retrieve inbox placement and engagement rates for the domains that you use to send email.

getEmailIdentity({required String emailIdentity}) → Future<GetEmailIdentityResponse>

Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.

listConfigurationSets({String? nextToken, int? pageSize}) → Future<ListConfigurationSetsResponse>

List all of the configuration sets associated with your Amazon Pinpoint account in the current region.

listDedicatedIpPools({String? nextToken, int? pageSize}) → Future<ListDedicatedIpPoolsResponse>

List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.

listDeliverabilityTestReports({String? nextToken, int? pageSize}) → Future<ListDeliverabilityTestReportsResponse>

Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport operation to view the results.

listDomainDeliverabilityCampaigns({required DateTime endDate, required DateTime startDate, required String subscribedDomain, String? nextToken, int? pageSize}) → Future<ListDomainDeliverabilityCampaignsResponse>

Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOption operation) for the domain.

listEmailIdentities({String? nextToken, int? pageSize}) → Future<ListEmailIdentitiesResponse>

Returns a list of all of the email identities that are associated with your Amazon Pinpoint account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't.

listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>

Retrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

putAccountDedicatedIpWarmupAttributes({bool? autoWarmupEnabled}) → Future<void>

Enable or disable the automatic warm-up feature for dedicated IP addresses.

putAccountSendingAttributes({bool? sendingEnabled}) → Future<void>

Enable or disable the ability of your account to send email.

putConfigurationSetDeliveryOptions({required String configurationSetName, String? sendingPoolName, TlsPolicy? tlsPolicy}) → Future<void>

Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.

putConfigurationSetReputationOptions({required String configurationSetName, bool? reputationMetricsEnabled}) → Future<void>

Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.

putConfigurationSetSendingOptions({required String configurationSetName, bool? sendingEnabled}) → Future<void>

Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.

putConfigurationSetTrackingOptions({required String configurationSetName, String? customRedirectDomain}) → Future<void>

Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.

putDedicatedIpInPool({required String destinationPoolName, required String ip}) → Future<void>

Move a dedicated IP address to an existing dedicated IP pool.

putDedicatedIpWarmupAttributes({required String ip, required int warmupPercentage}) → Future<void>

putDeliverabilityDashboardOption({required bool dashboardEnabled, List<DomainDeliverabilityTrackingOption>? subscribedDomains}) → Future<void>

Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.

putEmailIdentityDkimAttributes({required String emailIdentity, bool? signingEnabled}) → Future<void>

Used to enable or disable DKIM authentication for an email identity.

putEmailIdentityFeedbackAttributes({required String emailIdentity, bool? emailForwardingEnabled}) → Future<void>

Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event.

putEmailIdentityMailFromAttributes({required String emailIdentity, BehaviorOnMxFailure? behaviorOnMxFailure, String? mailFromDomain}) → Future<void>

Used to enable or disable the custom Mail-From domain configuration for an email identity.

sendEmail({required EmailContent content, required Destination destination, String? configurationSetName, List<MessageTag>? emailTags, String? feedbackForwardingEmailAddress, String? fromEmailAddress, List<String>? replyToAddresses}) → Future<SendEmailResponse>

Sends an email message. You can use the Amazon Pinpoint Email API to send two types of messages:

tagResource({required String resourceArn, required List<Tag> tags}) → Future<void>

Add one or more tags (keys and values) to a specified resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.

toString() → String

A string representation of this object.

inherited

untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>

Remove one or more tags (keys and values) from a specified resource.

updateConfigurationSetEventDestination({required String configurationSetName, required EventDestinationDefinition eventDestination, required String eventDestinationName}) → Future<void>

Update the configuration of an event destination for a configuration set.

Operators

operator ==(Object other) → bool

The equality operator.

inherited