email

package
v1.2.0 Latest Latest
Warning

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

 Go to latest Published: Apr 5, 2018 License: Apache-2.0, UPL-1.0 Imports: 4 Imported by: 14

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateSenderDetails 

type CreateSenderDetails struct {

	// The OCID of the compartment that contains the sender.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The email address of the sender.
	EmailAddress *string `mandatory:"false" json:"emailAddress"`
}

CreateSenderDetails The details needed for creating a sender.

func (CreateSenderDetails) String 

func (m CreateSenderDetails) String() string

type CreateSenderRequest 

type CreateSenderRequest struct {

	// Create a sender.
	CreateSenderDetails `contributesTo:"body"`
}

CreateSenderRequest wrapper for the CreateSender operation

func (CreateSenderRequest) String 

func (request CreateSenderRequest) String() string

type CreateSenderResponse 

type CreateSenderResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Sender instance
	Sender `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need
	// to contact Oracle about a particular request, please provide the
	// request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CreateSenderResponse wrapper for the CreateSender operation

func (CreateSenderResponse) String 

func (response CreateSenderResponse) String() string

type CreateSuppressionDetails 

type CreateSuppressionDetails struct {

	// The OCID of the compartment to contain the suppression. Since
	// suppressions are at the customer level, this must be the tenancy
	// OCID.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The recipient email address of the suppression.
	EmailAddress *string `mandatory:"false" json:"emailAddress"`
}

CreateSuppressionDetails The details needed for creating a single suppression.

func (CreateSuppressionDetails) String 

func (m CreateSuppressionDetails) String() string

type CreateSuppressionRequest 

type CreateSuppressionRequest struct {

	// Adds a single email address to the suppression list for a compartment's tenancy.
	CreateSuppressionDetails `contributesTo:"body"`
}

CreateSuppressionRequest wrapper for the CreateSuppression operation

func (CreateSuppressionRequest) String 

func (request CreateSuppressionRequest) String() string

type CreateSuppressionResponse 

type CreateSuppressionResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Suppression instance
	Suppression `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CreateSuppressionResponse wrapper for the CreateSuppression operation

func (CreateSuppressionResponse) String 

func (response CreateSuppressionResponse) String() string

type DeleteSenderRequest 

type DeleteSenderRequest struct {

	// The unique OCID of the sender.
	SenderId *string `mandatory:"true" contributesTo:"path" name:"senderId"`
}

DeleteSenderRequest wrapper for the DeleteSender operation

func (DeleteSenderRequest) String 

func (request DeleteSenderRequest) String() string

type DeleteSenderResponse 

type DeleteSenderResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If you need to
	// contact Oracle about a particular request, please provide the request
	// ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteSenderResponse wrapper for the DeleteSender operation

func (DeleteSenderResponse) String 

func (response DeleteSenderResponse) String() string

type DeleteSuppressionRequest 

type DeleteSuppressionRequest struct {

	// The unique OCID of the suppression.
	SuppressionId *string `mandatory:"true" contributesTo:"path" name:"suppressionId"`
}

DeleteSuppressionRequest wrapper for the DeleteSuppression operation

func (DeleteSuppressionRequest) String 

func (request DeleteSuppressionRequest) String() string

type DeleteSuppressionResponse 

type DeleteSuppressionResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If you need to
	// contact Oracle about a particular request, please provide the request
	// ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteSuppressionResponse wrapper for the DeleteSuppression operation

func (DeleteSuppressionResponse) String 

func (response DeleteSuppressionResponse) String() string

type EmailClient 

type EmailClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

EmailClient a client for Email

func NewEmailClientWithConfigurationProvider 

func NewEmailClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client EmailClient, err error)

NewEmailClientWithConfigurationProvider Creates a new default Email client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func (*EmailClient) ConfigurationProvider 

func (client *EmailClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (EmailClient) CreateSender 

func (client EmailClient) CreateSender(ctx context.Context, request CreateSenderRequest) (response CreateSenderResponse, err error)

CreateSender Creates a sender for a tenancy in a given compartment.

func (EmailClient) CreateSuppression 

func (client EmailClient) CreateSuppression(ctx context.Context, request CreateSuppressionRequest) (response CreateSuppressionResponse, err error)

CreateSuppression Adds recipient email addresses to the suppression list for a tenancy.

func (EmailClient) DeleteSender 

func (client EmailClient) DeleteSender(ctx context.Context, request DeleteSenderRequest) (response DeleteSenderResponse, err error)

DeleteSender Deletes an approved sender for a tenancy in a given compartment for a provided `senderId`.

func (EmailClient) DeleteSuppression 

func (client EmailClient) DeleteSuppression(ctx context.Context, request DeleteSuppressionRequest) (response DeleteSuppressionResponse, err error)

DeleteSuppression Removes a suppressed recipient email address from the suppression list for a tenancy in a given compartment for a provided `suppressionId`.

func (EmailClient) GetSender 

func (client EmailClient) GetSender(ctx context.Context, request GetSenderRequest) (response GetSenderResponse, err error)

GetSender Gets an approved sender for a given `senderId`.

func (EmailClient) GetSuppression 

func (client EmailClient) GetSuppression(ctx context.Context, request GetSuppressionRequest) (response GetSuppressionResponse, err error)

GetSuppression Gets the details of a suppressed recipient email address for a given `suppressionId`. Each suppression is given a unique OCID.

func (EmailClient) ListSenders 

func (client EmailClient) ListSenders(ctx context.Context, request ListSendersRequest) (response ListSendersResponse, err error)

ListSenders Gets a collection of approved sender email addresses and sender IDs.

func (EmailClient) ListSuppressions 

func (client EmailClient) ListSuppressions(ctx context.Context, request ListSuppressionsRequest) (response ListSuppressionsResponse, err error)

ListSuppressions Gets a list of suppressed recipient email addresses for a user. The `compartmentId` for suppressions must be a tenancy OCID. The returned list is sorted by creation time in descending order.

func (*EmailClient) SetRegion 

func (client *EmailClient) SetRegion(region string)

SetRegion overrides the region of this client.

type GetSenderRequest 

type GetSenderRequest struct {

	// The unique OCID of the sender.
	SenderId *string `mandatory:"true" contributesTo:"path" name:"senderId"`
}

GetSenderRequest wrapper for the GetSender operation

func (GetSenderRequest) String 

func (request GetSenderRequest) String() string

type GetSenderResponse 

type GetSenderResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Sender instance
	Sender `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need
	// to contact Oracle about a particular request, please provide the
	// request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetSenderResponse wrapper for the GetSender operation

func (GetSenderResponse) String 

func (response GetSenderResponse) String() string

type GetSuppressionRequest 

type GetSuppressionRequest struct {

	// The unique OCID of the suppression.
	SuppressionId *string `mandatory:"true" contributesTo:"path" name:"suppressionId"`
}

GetSuppressionRequest wrapper for the GetSuppression operation

func (GetSuppressionRequest) String 

func (request GetSuppressionRequest) String() string

type GetSuppressionResponse 

type GetSuppressionResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Suppression instance
	Suppression `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetSuppressionResponse wrapper for the GetSuppression operation

func (GetSuppressionResponse) String 

func (response GetSuppressionResponse) String() string

type ListSendersRequest 

type ListSendersRequest struct {

	// The OCID for the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The current state of a sender.
	LifecycleState SenderLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// The email address of the approved sender.
	EmailAddress *string `mandatory:"false" contributesTo:"query" name:"emailAddress"`

	// The value of the `opc-next-page` response header from the previous
	// GET request.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated GET request.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The field to sort by. The `TIMECREATED` value returns the list in in
	// descending order by default. The `EMAILADDRESS` value returns the list in
	// ascending order by default. Use the `SortOrderQueryParam` to change the
	// direction of the returned list of items.
	SortBy ListSendersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either ascending or descending order.
	SortOrder ListSendersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
}

ListSendersRequest wrapper for the ListSenders operation

func (ListSendersRequest) String 

func (request ListSendersRequest) String() string

type ListSendersResponse 

type ListSendersResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The []SenderSummary instance
	Items []SenderSummary `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need
	// to contact Oracle about a particular request, please provide the
	// request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For pagination of a list of items. If this header appears in the
	// response, then a partial list might have been returned. Include
	// this value for the `page` parameter in subsequent GET
	// requests to return the next batch of items.
	// of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

	// The total number of items returned from the request.
	OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`
}

ListSendersResponse wrapper for the ListSenders operation

func (ListSendersResponse) String 

func (response ListSendersResponse) String() string

type ListSendersSortByEnum 

type ListSendersSortByEnum string

ListSendersSortByEnum Enum with underlying type: string 

const (
	ListSendersSortByTimecreated  ListSendersSortByEnum = "TIMECREATED"
	ListSendersSortByEmailaddress ListSendersSortByEnum = "EMAILADDRESS"
)

Set of constants representing the allowable values for ListSendersSortBy

func GetListSendersSortByEnumValues 

func GetListSendersSortByEnumValues() []ListSendersSortByEnum

GetListSendersSortByEnumValues Enumerates the set of values for ListSendersSortBy

type ListSendersSortOrderEnum 

type ListSendersSortOrderEnum string

ListSendersSortOrderEnum Enum with underlying type: string 

const (
	ListSendersSortOrderAsc  ListSendersSortOrderEnum = "ASC"
	ListSendersSortOrderDesc ListSendersSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListSendersSortOrder

func GetListSendersSortOrderEnumValues 

func GetListSendersSortOrderEnumValues() []ListSendersSortOrderEnum

GetListSendersSortOrderEnumValues Enumerates the set of values for ListSendersSortOrder

type ListSuppressionsRequest 

type ListSuppressionsRequest struct {

	// The OCID for the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The email address of the suppression.
	EmailAddress *string `mandatory:"false" contributesTo:"query" name:"emailAddress"`

	// Search for suppressions that were created within a specific date range,
	// using this parameter to specify the earliest creation date for the
	// returned list (inclusive). Specifying this parameter without the
	// corresponding `timeCreatedLessThan` parameter will retrieve suppressions created from the
	// given `timeCreatedGreaterThanOrEqualTo` to the current time, in "YYYY-MM-ddThh:mmZ" format with a
	// Z offset, as defined by RFC 3339.
	// **Example:** 2016-12-19T16:39:57.600Z
	TimeCreatedGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedGreaterThanOrEqualTo"`

	// Search for suppressions that were created within a specific date range,
	// using this parameter to specify the latest creation date for the returned
	// list (exclusive). Specifying this parameter without the corresponding
	// `timeCreatedGreaterThanOrEqualTo` parameter will retrieve all suppressions created before the
	// specified end date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as
	// defined by RFC 3339.
	// **Example:** 2016-12-19T16:39:57.600Z
	TimeCreatedLessThan *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedLessThan"`

	// The value of the `opc-next-page` response header from the previous
	// GET request.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated GET request.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The field to sort by. The `TIMECREATED` value returns the list in in
	// descending order by default. The `EMAILADDRESS` value returns the list in
	// ascending order by default. Use the `SortOrderQueryParam` to change the
	// direction of the returned list of items.
	SortBy ListSuppressionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either ascending or descending order.
	SortOrder ListSuppressionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
}

ListSuppressionsRequest wrapper for the ListSuppressions operation

func (ListSuppressionsRequest) String 

func (request ListSuppressionsRequest) String() string

type ListSuppressionsResponse 

type ListSuppressionsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The []SuppressionSummary instance
	Items []SuppressionSummary `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need
	// to contact Oracle about a particular request, please provide the
	// request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For pagination of a list of items. If this header appears in the
	// response, then a partial list might have been returned. Include
	// this value for the `page` parameter in subsequent GET
	// requests to return the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListSuppressionsResponse wrapper for the ListSuppressions operation

func (ListSuppressionsResponse) String 

func (response ListSuppressionsResponse) String() string

type ListSuppressionsSortByEnum 

type ListSuppressionsSortByEnum string

ListSuppressionsSortByEnum Enum with underlying type: string 

const (
	ListSuppressionsSortByTimecreated  ListSuppressionsSortByEnum = "TIMECREATED"
	ListSuppressionsSortByEmailaddress ListSuppressionsSortByEnum = "EMAILADDRESS"
)

Set of constants representing the allowable values for ListSuppressionsSortBy

func GetListSuppressionsSortByEnumValues 

func GetListSuppressionsSortByEnumValues() []ListSuppressionsSortByEnum

GetListSuppressionsSortByEnumValues Enumerates the set of values for ListSuppressionsSortBy

type ListSuppressionsSortOrderEnum 

type ListSuppressionsSortOrderEnum string

ListSuppressionsSortOrderEnum Enum with underlying type: string 

const (
	ListSuppressionsSortOrderAsc  ListSuppressionsSortOrderEnum = "ASC"
	ListSuppressionsSortOrderDesc ListSuppressionsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListSuppressionsSortOrder

func GetListSuppressionsSortOrderEnumValues 

func GetListSuppressionsSortOrderEnumValues() []ListSuppressionsSortOrderEnum

GetListSuppressionsSortOrderEnumValues Enumerates the set of values for ListSuppressionsSortOrder

type Sender 

type Sender struct {

	// Email address of the sender.
	EmailAddress *string `mandatory:"false" json:"emailAddress"`

	// The unique OCID of the sender.
	Id *string `mandatory:"false" json:"id"`

	// Value of the SPF field. For more information about SPF, please see
	// SPF Authentication (https://docs.us-phoenix-1.oraclecloud.com/Content/Email/Concepts/emaildeliveryoverview.htm#spf).
	IsSpf *bool `mandatory:"false" json:"isSpf"`

	// The sender's current lifecycle state.
	LifecycleState SenderLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// The date and time the approved sender was added in "YYYY-MM-ddThh:mmZ"
	// format with a Z offset, as defined by RFC 3339.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

Sender The full information representing an approved sender.

func (Sender) String 

func (m Sender) String() string

type SenderLifecycleStateEnum 

type SenderLifecycleStateEnum string

SenderLifecycleStateEnum Enum with underlying type: string 

const (
	SenderLifecycleStateCreating SenderLifecycleStateEnum = "CREATING"
	SenderLifecycleStateActive   SenderLifecycleStateEnum = "ACTIVE"
	SenderLifecycleStateDeleting SenderLifecycleStateEnum = "DELETING"
	SenderLifecycleStateDeleted  SenderLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for SenderLifecycleState

func GetSenderLifecycleStateEnumValues 

func GetSenderLifecycleStateEnumValues() []SenderLifecycleStateEnum

GetSenderLifecycleStateEnumValues Enumerates the set of values for SenderLifecycleState

type SenderSummary 

type SenderSummary struct {

	// The email address of the sender.
	EmailAddress *string `mandatory:"false" json:"emailAddress"`

	// The unique ID of the sender.
	Id *string `mandatory:"false" json:"id"`

	// The current status of the approved sender.
	LifecycleState SenderSummaryLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// Date time the approved sender was added, in "YYYY-MM-ddThh:mmZ"
	// format with a Z offset, as defined by RFC 3339.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

SenderSummary The email addresses and `senderId` representing an approved sender.

func (SenderSummary) String 

func (m SenderSummary) String() string

type SenderSummaryLifecycleStateEnum 

type SenderSummaryLifecycleStateEnum string

SenderSummaryLifecycleStateEnum Enum with underlying type: string 

const (
	SenderSummaryLifecycleStateCreating SenderSummaryLifecycleStateEnum = "CREATING"
	SenderSummaryLifecycleStateActive   SenderSummaryLifecycleStateEnum = "ACTIVE"
	SenderSummaryLifecycleStateDeleting SenderSummaryLifecycleStateEnum = "DELETING"
	SenderSummaryLifecycleStateDeleted  SenderSummaryLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for SenderSummaryLifecycleState

func GetSenderSummaryLifecycleStateEnumValues 

func GetSenderSummaryLifecycleStateEnumValues() []SenderSummaryLifecycleStateEnum

GetSenderSummaryLifecycleStateEnumValues Enumerates the set of values for SenderSummaryLifecycleState

type Suppression 

type Suppression struct {

	// Email address of the suppression.
	EmailAddress *string `mandatory:"false" json:"emailAddress"`

	// The unique ID of the suppression.
	Id *string `mandatory:"false" json:"id"`

	// The reason that the email address was suppressed. For more information on the types of bounces, see Suppresion List (https://docs.us-phoenix-1.oraclecloud.com/Content/Email/Concepts/emaildeliveryoverview.htm#suppressionlist).
	Reason SuppressionReasonEnum `mandatory:"false" json:"reason,omitempty"`

	// The date and time the approved sender was added in "YYYY-MM-ddThh:mmZ"
	// format with a Z offset, as defined by RFC 3339.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

Suppression The full information representing an email suppression.

func (Suppression) String 

func (m Suppression) String() string

type SuppressionReasonEnum 

type SuppressionReasonEnum string

SuppressionReasonEnum Enum with underlying type: string 

const (
	SuppressionReasonUnknown     SuppressionReasonEnum = "UNKNOWN"
	SuppressionReasonHardbounce  SuppressionReasonEnum = "HARDBOUNCE"
	SuppressionReasonComplaint   SuppressionReasonEnum = "COMPLAINT"
	SuppressionReasonManual      SuppressionReasonEnum = "MANUAL"
	SuppressionReasonSoftbounce  SuppressionReasonEnum = "SOFTBOUNCE"
	SuppressionReasonUnsubscribe SuppressionReasonEnum = "UNSUBSCRIBE"
)

Set of constants representing the allowable values for SuppressionReason

func GetSuppressionReasonEnumValues 

func GetSuppressionReasonEnumValues() []SuppressionReasonEnum

GetSuppressionReasonEnumValues Enumerates the set of values for SuppressionReason

type SuppressionSummary 

type SuppressionSummary struct {

	// The email address of the suppression.
	EmailAddress *string `mandatory:"false" json:"emailAddress"`

	// The unique OCID of the suppression.
	Id *string `mandatory:"false" json:"id"`

	// The reason that the email address was suppressed.
	Reason SuppressionSummaryReasonEnum `mandatory:"false" json:"reason,omitempty"`

	// The date and time a recipient's email address was added to the
	// suppression list, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as
	// defined by RFC 3339.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

SuppressionSummary The full information representing a suppression.

func (SuppressionSummary) String 

func (m SuppressionSummary) String() string

type SuppressionSummaryReasonEnum 

type SuppressionSummaryReasonEnum string

SuppressionSummaryReasonEnum Enum with underlying type: string 

const (
	SuppressionSummaryReasonUnknown     SuppressionSummaryReasonEnum = "UNKNOWN"
	SuppressionSummaryReasonHardbounce  SuppressionSummaryReasonEnum = "HARDBOUNCE"
	SuppressionSummaryReasonComplaint   SuppressionSummaryReasonEnum = "COMPLAINT"
	SuppressionSummaryReasonManual      SuppressionSummaryReasonEnum = "MANUAL"
	SuppressionSummaryReasonSoftbounce  SuppressionSummaryReasonEnum = "SOFTBOUNCE"
	SuppressionSummaryReasonUnsubscribe SuppressionSummaryReasonEnum = "UNSUBSCRIBE"
)

Set of constants representing the allowable values for SuppressionSummaryReason

func GetSuppressionSummaryReasonEnumValues 

func GetSuppressionSummaryReasonEnumValues() []SuppressionSummaryReasonEnum

GetSuppressionSummaryReasonEnumValues Enumerates the set of values for SuppressionSummaryReason

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.