pinpointemail

package
v0.3.8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 1, 2021 License: MIT Imports: 6 Imported by: 0

README

aws-sdk-go-v2-wrapper | Pinpoint Email

Quick Usage

import (
	"context"

	"github.com/evalphobia/aws-sdk-go-v2-wrapper/config"
	"github.com/evalphobia/aws-sdk-go-v2-wrapper/pinpointemail"
)

func main() {
	svc, err := pinpointemail.New(config.Config{
		AccessKey: "<...>",
		SecretKey: "<...>",
	})
	if err != nil {
		panic(err)
	}
	ctx := context.Background()


	// text email
	err := svc.XSendEmailText(ctx, "My email report", "I love you!", "example@example.com", "example@example.com")
	if err != nil {
		panic(err)
	}

	// HTML email
	htmlBody := `<!DOCTYPE html><html lang="en"><body><p style="text-align: center;">I love you!</p></body></html>`
	err = svc.XSendEmailHTML(ctx, "My email report", htmlBody, "example@example.com", "example@example.com")
	if err != nil {
		panic(err)
	}
	// ...
}

X API

Name Description
XSendEmailHTML sends HTML type email.
XSendEmailText sends text type email.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type PinpointEmail 

type PinpointEmail struct {
	// contains filtered or unexported fields
}

PinpointEmail has PinpointEmail client.

func New 

func New(conf config.Config) (*PinpointEmail, error)

New returns initialized *PinpointEmail.

func (*PinpointEmail) Errorf 

func (svc *PinpointEmail) Errorf(format string, v ...interface{})

Errorf logging error information.

func (*PinpointEmail) GetClient 

func (svc *PinpointEmail) GetClient() *SDK.Client

GetClient gets original SDK client.

func (*PinpointEmail) Infof 

func (svc *PinpointEmail) Infof(format string, v ...interface{})

Infof logging information.

func (*PinpointEmail) RawCreateConfigurationSet 

func (svc *PinpointEmail) RawCreateConfigurationSet(ctx context.Context, in *SDK.CreateConfigurationSetInput) (*SDK.CreateConfigurationSetResponse, error)

RawCreateConfigurationSet executes `CreateConfigurationSet` raw operation.

func (*PinpointEmail) RawCreateConfigurationSetEventDestination 

func (svc *PinpointEmail) RawCreateConfigurationSetEventDestination(ctx context.Context, in *SDK.CreateConfigurationSetEventDestinationInput) (*SDK.CreateConfigurationSetEventDestinationResponse, error)

RawCreateConfigurationSetEventDestination executes `CreateConfigurationSetEventDestination` raw operation.

func (*PinpointEmail) RawCreateDedicatedIpPool 

func (svc *PinpointEmail) RawCreateDedicatedIpPool(ctx context.Context, in *SDK.CreateDedicatedIpPoolInput) (*SDK.CreateDedicatedIpPoolResponse, error)

RawCreateDedicatedIpPool executes `CreateDedicatedIpPool` raw operation.

func (*PinpointEmail) RawCreateDeliverabilityTestReport 

func (svc *PinpointEmail) RawCreateDeliverabilityTestReport(ctx context.Context, in *SDK.CreateDeliverabilityTestReportInput) (*SDK.CreateDeliverabilityTestReportResponse, error)

RawCreateDeliverabilityTestReport executes `CreateDeliverabilityTestReport` raw operation.

func (*PinpointEmail) RawCreateEmailIdentity 

func (svc *PinpointEmail) RawCreateEmailIdentity(ctx context.Context, in *SDK.CreateEmailIdentityInput) (*SDK.CreateEmailIdentityResponse, error)

RawCreateEmailIdentity executes `CreateEmailIdentity` raw operation.

func (*PinpointEmail) RawDeleteConfigurationSet 

func (svc *PinpointEmail) RawDeleteConfigurationSet(ctx context.Context, in *SDK.DeleteConfigurationSetInput) (*SDK.DeleteConfigurationSetResponse, error)

RawDeleteConfigurationSet executes `DeleteConfigurationSet` raw operation.

func (*PinpointEmail) RawDeleteConfigurationSetEventDestination 

func (svc *PinpointEmail) RawDeleteConfigurationSetEventDestination(ctx context.Context, in *SDK.DeleteConfigurationSetEventDestinationInput) (*SDK.DeleteConfigurationSetEventDestinationResponse, error)

RawDeleteConfigurationSetEventDestination executes `DeleteConfigurationSetEventDestination` raw operation.

func (*PinpointEmail) RawDeleteDedicatedIpPool 

func (svc *PinpointEmail) RawDeleteDedicatedIpPool(ctx context.Context, in *SDK.DeleteDedicatedIpPoolInput) (*SDK.DeleteDedicatedIpPoolResponse, error)

RawDeleteDedicatedIpPool executes `DeleteDedicatedIpPool` raw operation.

func (*PinpointEmail) RawDeleteEmailIdentity 

func (svc *PinpointEmail) RawDeleteEmailIdentity(ctx context.Context, in *SDK.DeleteEmailIdentityInput) (*SDK.DeleteEmailIdentityResponse, error)

RawDeleteEmailIdentity executes `DeleteEmailIdentity` raw operation.

func (*PinpointEmail) RawGetAccount 

func (svc *PinpointEmail) RawGetAccount(ctx context.Context, in *SDK.GetAccountInput) (*SDK.GetAccountResponse, error)

RawGetAccount executes `GetAccount` raw operation.

func (*PinpointEmail) RawGetBlacklistReports 

func (svc *PinpointEmail) RawGetBlacklistReports(ctx context.Context, in *SDK.GetBlacklistReportsInput) (*SDK.GetBlacklistReportsResponse, error)

RawGetBlacklistReports executes `GetBlacklistReports` raw operation.

func (*PinpointEmail) RawGetConfigurationSet 

func (svc *PinpointEmail) RawGetConfigurationSet(ctx context.Context, in *SDK.GetConfigurationSetInput) (*SDK.GetConfigurationSetResponse, error)

RawGetConfigurationSet executes `GetConfigurationSet` raw operation.

func (*PinpointEmail) RawGetConfigurationSetEventDestinations 

func (svc *PinpointEmail) RawGetConfigurationSetEventDestinations(ctx context.Context, in *SDK.GetConfigurationSetEventDestinationsInput) (*SDK.GetConfigurationSetEventDestinationsResponse, error)

RawGetConfigurationSetEventDestinations executes `GetConfigurationSetEventDestinations` raw operation.

func (*PinpointEmail) RawGetDedicatedIp 

func (svc *PinpointEmail) RawGetDedicatedIp(ctx context.Context, in *SDK.GetDedicatedIpInput) (*SDK.GetDedicatedIpResponse, error)

RawGetDedicatedIp executes `GetDedicatedIp` raw operation.

func (*PinpointEmail) RawGetDedicatedIps 

func (svc *PinpointEmail) RawGetDedicatedIps(ctx context.Context, in *SDK.GetDedicatedIpsInput) (*SDK.GetDedicatedIpsResponse, error)

RawGetDedicatedIps executes `GetDedicatedIps` raw operation.

func (*PinpointEmail) RawGetDeliverabilityDashboardOptions 

func (svc *PinpointEmail) RawGetDeliverabilityDashboardOptions(ctx context.Context, in *SDK.GetDeliverabilityDashboardOptionsInput) (*SDK.GetDeliverabilityDashboardOptionsResponse, error)

RawGetDeliverabilityDashboardOptions executes `GetDeliverabilityDashboardOptions` raw operation.

func (*PinpointEmail) RawGetDeliverabilityTestReport 

func (svc *PinpointEmail) RawGetDeliverabilityTestReport(ctx context.Context, in *SDK.GetDeliverabilityTestReportInput) (*SDK.GetDeliverabilityTestReportResponse, error)

RawGetDeliverabilityTestReport executes `GetDeliverabilityTestReport` raw operation.

func (*PinpointEmail) RawGetDomainDeliverabilityCampaign 

func (svc *PinpointEmail) RawGetDomainDeliverabilityCampaign(ctx context.Context, in *SDK.GetDomainDeliverabilityCampaignInput) (*SDK.GetDomainDeliverabilityCampaignResponse, error)

RawGetDomainDeliverabilityCampaign executes `GetDomainDeliverabilityCampaign` raw operation.

func (*PinpointEmail) RawGetDomainStatisticsReport 

func (svc *PinpointEmail) RawGetDomainStatisticsReport(ctx context.Context, in *SDK.GetDomainStatisticsReportInput) (*SDK.GetDomainStatisticsReportResponse, error)

RawGetDomainStatisticsReport executes `GetDomainStatisticsReport` raw operation.

func (*PinpointEmail) RawGetEmailIdentity 

func (svc *PinpointEmail) RawGetEmailIdentity(ctx context.Context, in *SDK.GetEmailIdentityInput) (*SDK.GetEmailIdentityResponse, error)

RawGetEmailIdentity executes `GetEmailIdentity` raw operation.

func (*PinpointEmail) RawListConfigurationSets 

func (svc *PinpointEmail) RawListConfigurationSets(ctx context.Context, in *SDK.ListConfigurationSetsInput) (*SDK.ListConfigurationSetsResponse, error)

RawListConfigurationSets executes `ListConfigurationSets` raw operation.

func (*PinpointEmail) RawListDedicatedIpPools 

func (svc *PinpointEmail) RawListDedicatedIpPools(ctx context.Context, in *SDK.ListDedicatedIpPoolsInput) (*SDK.ListDedicatedIpPoolsResponse, error)

RawListDedicatedIpPools executes `ListDedicatedIpPools` raw operation.

func (*PinpointEmail) RawListDeliverabilityTestReports 

func (svc *PinpointEmail) RawListDeliverabilityTestReports(ctx context.Context, in *SDK.ListDeliverabilityTestReportsInput) (*SDK.ListDeliverabilityTestReportsResponse, error)

RawListDeliverabilityTestReports executes `ListDeliverabilityTestReports` raw operation.

func (*PinpointEmail) RawListDomainDeliverabilityCampaigns 

func (svc *PinpointEmail) RawListDomainDeliverabilityCampaigns(ctx context.Context, in *SDK.ListDomainDeliverabilityCampaignsInput) (*SDK.ListDomainDeliverabilityCampaignsResponse, error)

RawListDomainDeliverabilityCampaigns executes `ListDomainDeliverabilityCampaigns` raw operation.

func (*PinpointEmail) RawListEmailIdentities 

func (svc *PinpointEmail) RawListEmailIdentities(ctx context.Context, in *SDK.ListEmailIdentitiesInput) (*SDK.ListEmailIdentitiesResponse, error)

RawListEmailIdentities executes `ListEmailIdentities` raw operation.

func (*PinpointEmail) RawListTagsForResource 

func (svc *PinpointEmail) RawListTagsForResource(ctx context.Context, in *SDK.ListTagsForResourceInput) (*SDK.ListTagsForResourceResponse, error)

RawListTagsForResource executes `ListTagsForResource` raw operation.

func (*PinpointEmail) RawPutAccountDedicatedIpWarmupAttributes 

func (svc *PinpointEmail) RawPutAccountDedicatedIpWarmupAttributes(ctx context.Context, in *SDK.PutAccountDedicatedIpWarmupAttributesInput) (*SDK.PutAccountDedicatedIpWarmupAttributesResponse, error)

RawPutAccountDedicatedIpWarmupAttributes executes `PutAccountDedicatedIpWarmupAttributes` raw operation.

func (*PinpointEmail) RawPutAccountSendingAttributes 

func (svc *PinpointEmail) RawPutAccountSendingAttributes(ctx context.Context, in *SDK.PutAccountSendingAttributesInput) (*SDK.PutAccountSendingAttributesResponse, error)

RawPutAccountSendingAttributes executes `PutAccountSendingAttributes` raw operation.

func (*PinpointEmail) RawPutConfigurationSetDeliveryOptions 

func (svc *PinpointEmail) RawPutConfigurationSetDeliveryOptions(ctx context.Context, in *SDK.PutConfigurationSetDeliveryOptionsInput) (*SDK.PutConfigurationSetDeliveryOptionsResponse, error)

RawPutConfigurationSetDeliveryOptions executes `PutConfigurationSetDeliveryOptions` raw operation.

func (*PinpointEmail) RawPutConfigurationSetReputationOptions 

func (svc *PinpointEmail) RawPutConfigurationSetReputationOptions(ctx context.Context, in *SDK.PutConfigurationSetReputationOptionsInput) (*SDK.PutConfigurationSetReputationOptionsResponse, error)

RawPutConfigurationSetReputationOptions executes `PutConfigurationSetReputationOptions` raw operation.

func (*PinpointEmail) RawPutConfigurationSetSendingOptions 

func (svc *PinpointEmail) RawPutConfigurationSetSendingOptions(ctx context.Context, in *SDK.PutConfigurationSetSendingOptionsInput) (*SDK.PutConfigurationSetSendingOptionsResponse, error)

RawPutConfigurationSetSendingOptions executes `PutConfigurationSetSendingOptions` raw operation.

func (*PinpointEmail) RawPutConfigurationSetTrackingOptions 

func (svc *PinpointEmail) RawPutConfigurationSetTrackingOptions(ctx context.Context, in *SDK.PutConfigurationSetTrackingOptionsInput) (*SDK.PutConfigurationSetTrackingOptionsResponse, error)

RawPutConfigurationSetTrackingOptions executes `PutConfigurationSetTrackingOptions` raw operation.

func (*PinpointEmail) RawPutDedicatedIpInPool 

func (svc *PinpointEmail) RawPutDedicatedIpInPool(ctx context.Context, in *SDK.PutDedicatedIpInPoolInput) (*SDK.PutDedicatedIpInPoolResponse, error)

RawPutDedicatedIpInPool executes `PutDedicatedIpInPool` raw operation.

func (*PinpointEmail) RawPutDedicatedIpWarmupAttributes 

func (svc *PinpointEmail) RawPutDedicatedIpWarmupAttributes(ctx context.Context, in *SDK.PutDedicatedIpWarmupAttributesInput) (*SDK.PutDedicatedIpWarmupAttributesResponse, error)

RawPutDedicatedIpWarmupAttributes executes `PutDedicatedIpWarmupAttributes` raw operation.

func (*PinpointEmail) RawPutDeliverabilityDashboardOption 

func (svc *PinpointEmail) RawPutDeliverabilityDashboardOption(ctx context.Context, in *SDK.PutDeliverabilityDashboardOptionInput) (*SDK.PutDeliverabilityDashboardOptionResponse, error)

RawPutDeliverabilityDashboardOption executes `PutDeliverabilityDashboardOption` raw operation.

func (*PinpointEmail) RawPutEmailIdentityDkimAttributes 

func (svc *PinpointEmail) RawPutEmailIdentityDkimAttributes(ctx context.Context, in *SDK.PutEmailIdentityDkimAttributesInput) (*SDK.PutEmailIdentityDkimAttributesResponse, error)

RawPutEmailIdentityDkimAttributes executes `PutEmailIdentityDkimAttributes` raw operation.

func (*PinpointEmail) RawPutEmailIdentityFeedbackAttributes 

func (svc *PinpointEmail) RawPutEmailIdentityFeedbackAttributes(ctx context.Context, in *SDK.PutEmailIdentityFeedbackAttributesInput) (*SDK.PutEmailIdentityFeedbackAttributesResponse, error)

RawPutEmailIdentityFeedbackAttributes executes `PutEmailIdentityFeedbackAttributes` raw operation.

func (*PinpointEmail) RawPutEmailIdentityMailFromAttributes 

func (svc *PinpointEmail) RawPutEmailIdentityMailFromAttributes(ctx context.Context, in *SDK.PutEmailIdentityMailFromAttributesInput) (*SDK.PutEmailIdentityMailFromAttributesResponse, error)

RawPutEmailIdentityMailFromAttributes executes `PutEmailIdentityMailFromAttributes` raw operation.

func (*PinpointEmail) RawSendEmail 

func (svc *PinpointEmail) RawSendEmail(ctx context.Context, in *SDK.SendEmailInput) (*SDK.SendEmailResponse, error)

RawSendEmail executes `SendEmail` raw operation.

func (*PinpointEmail) RawTagResource 

func (svc *PinpointEmail) RawTagResource(ctx context.Context, in *SDK.TagResourceInput) (*SDK.TagResourceResponse, error)

RawTagResource executes `TagResource` raw operation.

func (*PinpointEmail) RawUntagResource 

func (svc *PinpointEmail) RawUntagResource(ctx context.Context, in *SDK.UntagResourceInput) (*SDK.UntagResourceResponse, error)

RawUntagResource executes `UntagResource` raw operation.

func (*PinpointEmail) RawUpdateConfigurationSetEventDestination 

func (svc *PinpointEmail) RawUpdateConfigurationSetEventDestination(ctx context.Context, in *SDK.UpdateConfigurationSetEventDestinationInput) (*SDK.UpdateConfigurationSetEventDestinationResponse, error)

RawUpdateConfigurationSetEventDestination executes `UpdateConfigurationSetEventDestination` raw operation.

func (*PinpointEmail) SendEmail 

func (svc *PinpointEmail) SendEmail(ctx context.Context, r SendEmailRequest) (*SendEmailResult, error)

SendEmail executes `SendEmail` operation.

func (*PinpointEmail) SetLogger 

func (svc *PinpointEmail) SetLogger(logger log.Logger)

SetLogger sets logger.

func (*PinpointEmail) XSendEmailHTML 

func (svc *PinpointEmail) XSendEmailHTML(ctx context.Context, subject, body, from string, to ...string) error

XSendEmailHTML sends HTML type email.

func (*PinpointEmail) XSendEmailText 

func (svc *PinpointEmail) XSendEmailText(ctx context.Context, subject, body, from string, to ...string) error

XSendEmailText sends text type email.

type SendEmailRequest 

type SendEmailRequest struct {
	To   []string
	Cc   []string
	Bcc  []string
	From string

	// for text or html
	Subject        string
	SubjectCharset string // optional
	HTMLBody       string
	HTMLCharset    string // optional
	TextBody       string
	TextCharset    string // optional

	// for template
	TemplateARN  string
	TemplateData string

	// for raw
	RawMessageData []byte

	ConfigurationSetName           string
	EmailTags                      []Tag
	FeedbackForwardingEmailAddress string
	ReplyToAddresses               []string
}

SendEmailRequest has parameters for `SendEmail` operation.

func (SendEmailRequest) ToInput 

func (r SendEmailRequest) ToInput() *SDK.SendEmailInput

type SendEmailResult 

type SendEmailResult struct {
	MessageID string
}

func NewSendEmailResult 

func NewSendEmailResult(o *SDK.SendEmailResponse) *SendEmailResult

type Tag 

type Tag struct {
	Key   string
	Value string
}

func (Tag) ToEmailTag 

func (r Tag) ToEmailTag() SDK.MessageTag

func (Tag) ToSDK 

func (r Tag) ToSDK() SDK.Tag

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.