...

Package email

import "github.com/oracle/oci-go-sdk/email"
Overview
Index

Overview ▾

Index ▾

type ChangeSenderCompartmentDetails
    func (m ChangeSenderCompartmentDetails) String() string
type ChangeSenderCompartmentRequest
    func (request ChangeSenderCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ChangeSenderCompartmentRequest) RetryPolicy() *common.RetryPolicy
    func (request ChangeSenderCompartmentRequest) String() string
type ChangeSenderCompartmentResponse
    func (response ChangeSenderCompartmentResponse) HTTPResponse() *http.Response
    func (response ChangeSenderCompartmentResponse) String() string
type CreateSenderDetails
    func (m CreateSenderDetails) String() string
type CreateSenderRequest
    func (request CreateSenderRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CreateSenderRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateSenderRequest) String() string
type CreateSenderResponse
    func (response CreateSenderResponse) HTTPResponse() *http.Response
    func (response CreateSenderResponse) String() string
type CreateSuppressionDetails
    func (m CreateSuppressionDetails) String() string
type CreateSuppressionRequest
    func (request CreateSuppressionRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CreateSuppressionRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateSuppressionRequest) String() string
type CreateSuppressionResponse
    func (response CreateSuppressionResponse) HTTPResponse() *http.Response
    func (response CreateSuppressionResponse) String() string
type DeleteSenderRequest
    func (request DeleteSenderRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DeleteSenderRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteSenderRequest) String() string
type DeleteSenderResponse
    func (response DeleteSenderResponse) HTTPResponse() *http.Response
    func (response DeleteSenderResponse) String() string
type DeleteSuppressionRequest
    func (request DeleteSuppressionRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DeleteSuppressionRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteSuppressionRequest) String() string
type DeleteSuppressionResponse
    func (response DeleteSuppressionResponse) HTTPResponse() *http.Response
    func (response DeleteSuppressionResponse) String() string
type EmailClient
    func NewEmailClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client EmailClient, err error)
    func NewEmailClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client EmailClient, err error)
    func (client EmailClient) ChangeSenderCompartment(ctx context.Context, request ChangeSenderCompartmentRequest) (response ChangeSenderCompartmentResponse, err error)
    func (client *EmailClient) ConfigurationProvider() *common.ConfigurationProvider
    func (client EmailClient) CreateSender(ctx context.Context, request CreateSenderRequest) (response CreateSenderResponse, err error)
    func (client EmailClient) CreateSuppression(ctx context.Context, request CreateSuppressionRequest) (response CreateSuppressionResponse, err error)
    func (client EmailClient) DeleteSender(ctx context.Context, request DeleteSenderRequest) (response DeleteSenderResponse, err error)
    func (client EmailClient) DeleteSuppression(ctx context.Context, request DeleteSuppressionRequest) (response DeleteSuppressionResponse, err error)
    func (client EmailClient) GetSender(ctx context.Context, request GetSenderRequest) (response GetSenderResponse, err error)
    func (client EmailClient) GetSuppression(ctx context.Context, request GetSuppressionRequest) (response GetSuppressionResponse, err error)
    func (client EmailClient) ListSenders(ctx context.Context, request ListSendersRequest) (response ListSendersResponse, err error)
    func (client EmailClient) ListSuppressions(ctx context.Context, request ListSuppressionsRequest) (response ListSuppressionsResponse, err error)
    func (client *EmailClient) SetRegion(region string)
    func (client EmailClient) UpdateSender(ctx context.Context, request UpdateSenderRequest) (response UpdateSenderResponse, err error)
type GetSenderRequest
    func (request GetSenderRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetSenderRequest) RetryPolicy() *common.RetryPolicy
    func (request GetSenderRequest) String() string
type GetSenderResponse
    func (response GetSenderResponse) HTTPResponse() *http.Response
    func (response GetSenderResponse) String() string
type GetSuppressionRequest
    func (request GetSuppressionRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetSuppressionRequest) RetryPolicy() *common.RetryPolicy
    func (request GetSuppressionRequest) String() string
type GetSuppressionResponse
    func (response GetSuppressionResponse) HTTPResponse() *http.Response
    func (response GetSuppressionResponse) String() string
type ListSendersRequest
    func (request ListSendersRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListSendersRequest) RetryPolicy() *common.RetryPolicy
    func (request ListSendersRequest) String() string
type ListSendersResponse
    func (response ListSendersResponse) HTTPResponse() *http.Response
    func (response ListSendersResponse) String() string
type ListSendersSortByEnum
    func GetListSendersSortByEnumValues() []ListSendersSortByEnum
type ListSendersSortOrderEnum
    func GetListSendersSortOrderEnumValues() []ListSendersSortOrderEnum
type ListSuppressionsRequest
    func (request ListSuppressionsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListSuppressionsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListSuppressionsRequest) String() string
type ListSuppressionsResponse
    func (response ListSuppressionsResponse) HTTPResponse() *http.Response
    func (response ListSuppressionsResponse) String() string
type ListSuppressionsSortByEnum
    func GetListSuppressionsSortByEnumValues() []ListSuppressionsSortByEnum
type ListSuppressionsSortOrderEnum
    func GetListSuppressionsSortOrderEnumValues() []ListSuppressionsSortOrderEnum
type Sender
    func (m Sender) String() string
type SenderLifecycleStateEnum
    func GetSenderLifecycleStateEnumValues() []SenderLifecycleStateEnum
type SenderSummary
    func (m SenderSummary) String() string
type SenderSummaryLifecycleStateEnum
    func GetSenderSummaryLifecycleStateEnumValues() []SenderSummaryLifecycleStateEnum
type Suppression
    func (m Suppression) String() string
type SuppressionReasonEnum
    func GetSuppressionReasonEnumValues() []SuppressionReasonEnum
type SuppressionSummary
    func (m SuppressionSummary) String() string
type SuppressionSummaryReasonEnum
    func GetSuppressionSummaryReasonEnumValues() []SuppressionSummaryReasonEnum
type UpdateSenderDetails
    func (m UpdateSenderDetails) String() string
type UpdateSenderRequest
    func (request UpdateSenderRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request UpdateSenderRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateSenderRequest) String() string
type UpdateSenderResponse
    func (response UpdateSenderResponse) HTTPResponse() *http.Response
    func (response UpdateSenderResponse) String() string

Package files

change_sender_compartment_details.go change_sender_compartment_request_response.go create_sender_details.go create_sender_request_response.go create_suppression_details.go create_suppression_request_response.go delete_sender_request_response.go delete_suppression_request_response.go email_client.go get_sender_request_response.go get_suppression_request_response.go list_senders_request_response.go list_suppressions_request_response.go sender.go sender_summary.go suppression.go suppression_summary.go update_sender_details.go update_sender_request_response.go

type ChangeSenderCompartmentDetails

ChangeSenderCompartmentDetails The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved.

type ChangeSenderCompartmentDetails struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment
    // into which the sender should be moved.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

func (ChangeSenderCompartmentDetails) String

func (m ChangeSenderCompartmentDetails) String() string

type ChangeSenderCompartmentRequest

ChangeSenderCompartmentRequest wrapper for the ChangeSenderCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/email/ChangeSenderCompartment.go.html to see an example of how to use ChangeSenderCompartmentRequest.

type ChangeSenderCompartmentRequest struct {

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

    // Details for moving a sender into a different compartment.
    ChangeSenderCompartmentDetails `contributesTo:"body"`

    // Used for optimistic concurrency control. In the update or delete call for a resource, set the `if-match`
    // parameter to the value of the etag from a previous get, create, or update response for that resource.  The resource
    // will be updated or deleted only if the etag you provide matches the resource's current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // The request ID for tracing from the system
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (ChangeSenderCompartmentRequest) HTTPRequest

func (request ChangeSenderCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeSenderCompartmentRequest) RetryPolicy

func (request ChangeSenderCompartmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeSenderCompartmentRequest) String

func (request ChangeSenderCompartmentRequest) String() string

type ChangeSenderCompartmentResponse

ChangeSenderCompartmentResponse wrapper for the ChangeSenderCompartment operation

type ChangeSenderCompartmentResponse 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"`
}

func (ChangeSenderCompartmentResponse) HTTPResponse

func (response ChangeSenderCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeSenderCompartmentResponse) String

func (response ChangeSenderCompartmentResponse) String() string

type CreateSenderDetails

CreateSenderDetails The details needed for creating a sender.

type CreateSenderDetails struct {

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

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

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (CreateSenderDetails) String

func (m CreateSenderDetails) String() string

type CreateSenderRequest

CreateSenderRequest wrapper for the CreateSender operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/email/CreateSender.go.html to see an example of how to use CreateSenderRequest.

type CreateSenderRequest struct {

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

    // The request ID for tracing from the system
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (CreateSenderRequest) HTTPRequest

func (request CreateSenderRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateSenderRequest) RetryPolicy

func (request CreateSenderRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateSenderRequest) String

func (request CreateSenderRequest) String() string

type CreateSenderResponse

CreateSenderResponse wrapper for the CreateSender operation

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"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`
}

func (CreateSenderResponse) HTTPResponse

func (response CreateSenderResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateSenderResponse) String

func (response CreateSenderResponse) String() string

type CreateSuppressionDetails

CreateSuppressionDetails The details needed for creating a single suppression.

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:"true" json:"compartmentId"`

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

func (CreateSuppressionDetails) String

func (m CreateSuppressionDetails) String() string

type CreateSuppressionRequest

CreateSuppressionRequest wrapper for the CreateSuppression operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/email/CreateSuppression.go.html to see an example of how to use CreateSuppressionRequest.

type CreateSuppressionRequest struct {

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

    // The request ID for tracing from the system
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (CreateSuppressionRequest) HTTPRequest

func (request CreateSuppressionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateSuppressionRequest) RetryPolicy

func (request CreateSuppressionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateSuppressionRequest) String

func (request CreateSuppressionRequest) String() string

type CreateSuppressionResponse

CreateSuppressionResponse wrapper for the CreateSuppression operation

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"`
}

func (CreateSuppressionResponse) HTTPResponse

func (response CreateSuppressionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateSuppressionResponse) String

func (response CreateSuppressionResponse) String() string

type DeleteSenderRequest

DeleteSenderRequest wrapper for the DeleteSender operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/email/DeleteSender.go.html to see an example of how to use DeleteSenderRequest.

type DeleteSenderRequest struct {

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

    // Used for optimistic concurrency control. In the update or delete call for a resource, set the `if-match`
    // parameter to the value of the etag from a previous get, create, or update response for that resource.  The resource
    // will be updated or deleted only if the etag you provide matches the resource's current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // The request ID for tracing from the system
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (DeleteSenderRequest) HTTPRequest

func (request DeleteSenderRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteSenderRequest) RetryPolicy

func (request DeleteSenderRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteSenderRequest) String

func (request DeleteSenderRequest) String() string

type DeleteSenderResponse

DeleteSenderResponse wrapper for the DeleteSender operation

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"`
}

func (DeleteSenderResponse) HTTPResponse

func (response DeleteSenderResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteSenderResponse) String

func (response DeleteSenderResponse) String() string

type DeleteSuppressionRequest

DeleteSuppressionRequest wrapper for the DeleteSuppression operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/email/DeleteSuppression.go.html to see an example of how to use DeleteSuppressionRequest.

type DeleteSuppressionRequest struct {

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

    // The request ID for tracing from the system
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (DeleteSuppressionRequest) HTTPRequest

func (request DeleteSuppressionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteSuppressionRequest) RetryPolicy

func (request DeleteSuppressionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteSuppressionRequest) String

func (request DeleteSuppressionRequest) String() string

type DeleteSuppressionResponse

DeleteSuppressionResponse wrapper for the DeleteSuppression operation

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"`
}

func (DeleteSuppressionResponse) HTTPResponse

func (response DeleteSuppressionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteSuppressionResponse) String

func (response DeleteSuppressionResponse) String() string

type EmailClient

EmailClient a client for Email

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

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 NewEmailClientWithOboToken

func NewEmailClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client EmailClient, err error)

NewEmailClientWithOboToken Creates a new default Email client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer

as well as reading the region

func (EmailClient) ChangeSenderCompartment

func (client EmailClient) ChangeSenderCompartment(ctx context.Context, request ChangeSenderCompartmentRequest) (response ChangeSenderCompartmentResponse, err error)

ChangeSenderCompartment Moves a sender into a different compartment. When provided, If-Match is checked against ETag values of the resource.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/email/ChangeSenderCompartment.go.html to see an example of how to use ChangeSenderCompartment API.

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/email/CreateSender.go.html to see an example of how to use CreateSender API.

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. Addresses added to the suppression list via the API are denoted as "MANUAL" in the `reason` field. *Note:* All email addresses added to the suppression list are normalized to include only lowercase letters.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/email/CreateSuppression.go.html to see an example of how to use CreateSuppression API.

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`.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/email/DeleteSender.go.html to see an example of how to use DeleteSender API.

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`.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/email/DeleteSuppression.go.html to see an example of how to use DeleteSuppression API.

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`.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/email/GetSender.go.html to see an example of how to use GetSender API.

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/email/GetSuppression.go.html to see an example of how to use GetSuppression API.

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/email/ListSenders.go.html to see an example of how to use ListSenders API.

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/email/ListSuppressions.go.html to see an example of how to use ListSuppressions API.

func (*EmailClient) SetRegion

func (client *EmailClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (EmailClient) UpdateSender

func (client EmailClient) UpdateSender(ctx context.Context, request UpdateSenderRequest) (response UpdateSenderResponse, err error)

UpdateSender Replaces the set of tags for a sender with the tags provided. If either freeform or defined tags are omitted, the tags for that set remain the same. Each set must include the full set of tags for the sender, partial updates are not permitted. For more information about tagging, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/email/UpdateSender.go.html to see an example of how to use UpdateSender API.

type GetSenderRequest

GetSenderRequest wrapper for the GetSender operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/email/GetSender.go.html to see an example of how to use GetSenderRequest.

type GetSenderRequest struct {

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

    // The request ID for tracing from the system
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (GetSenderRequest) HTTPRequest

func (request GetSenderRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetSenderRequest) RetryPolicy

func (request GetSenderRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetSenderRequest) String

func (request GetSenderRequest) String() string

type GetSenderResponse

GetSenderResponse wrapper for the GetSender operation

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"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`
}

func (GetSenderResponse) HTTPResponse

func (response GetSenderResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetSenderResponse) String

func (response GetSenderResponse) String() string

type GetSuppressionRequest

GetSuppressionRequest wrapper for the GetSuppression operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/email/GetSuppression.go.html to see an example of how to use GetSuppressionRequest.

type GetSuppressionRequest struct {

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

    // The request ID for tracing from the system
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (GetSuppressionRequest) HTTPRequest

func (request GetSuppressionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetSuppressionRequest) RetryPolicy

func (request GetSuppressionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetSuppressionRequest) String

func (request GetSuppressionRequest) String() string

type GetSuppressionResponse

GetSuppressionResponse wrapper for the GetSuppression operation

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"`
}

func (GetSuppressionResponse) HTTPResponse

func (response GetSuppressionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetSuppressionResponse) String

func (response GetSuppressionResponse) String() string

type ListSendersRequest

ListSendersRequest wrapper for the ListSenders operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/email/ListSenders.go.html to see an example of how to use ListSendersRequest.

type ListSendersRequest struct {

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

    // The request ID for tracing from the system
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // 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"`

    // For list pagination. The value of the opc-next-page response header from the previous "List" call.
    // For important details about how pagination works,
    // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // For list pagination. The maximum number of results per page, or items to return in a
    // paginated "List" call. `1` is the minimum, `1000` is the maximum. For important details about
    // how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    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"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (ListSendersRequest) HTTPRequest

func (request ListSendersRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListSendersRequest) RetryPolicy

func (request ListSendersRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListSendersRequest) String

func (request ListSendersRequest) String() string

type ListSendersResponse

ListSendersResponse wrapper for the ListSenders operation

type ListSendersResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of []SenderSummary instances
    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 list pagination. When this header appears in the response, additional
    // pages of results remain. For important details about how pagination works,
    // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // For list pagination. When this header appears in the response, previous pages
    // of results exist. For important details about how pagination works,
    // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`

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

func (ListSendersResponse) HTTPResponse

func (response ListSendersResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListSendersResponse) String

func (response ListSendersResponse) String() string

type ListSendersSortByEnum

ListSendersSortByEnum Enum with underlying type: string

type ListSendersSortByEnum string

Set of constants representing the allowable values for ListSendersSortByEnum

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

func GetListSendersSortByEnumValues

func GetListSendersSortByEnumValues() []ListSendersSortByEnum

GetListSendersSortByEnumValues Enumerates the set of values for ListSendersSortByEnum

type ListSendersSortOrderEnum

ListSendersSortOrderEnum Enum with underlying type: string

type ListSendersSortOrderEnum string

Set of constants representing the allowable values for ListSendersSortOrderEnum

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

func GetListSendersSortOrderEnumValues

func GetListSendersSortOrderEnumValues() []ListSendersSortOrderEnum

GetListSendersSortOrderEnumValues Enumerates the set of values for ListSendersSortOrderEnum

type ListSuppressionsRequest

ListSuppressionsRequest wrapper for the ListSuppressions operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/email/ListSuppressions.go.html to see an example of how to use ListSuppressionsRequest.

type ListSuppressionsRequest struct {

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

    // The request ID for tracing from the system
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // 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"`

    // For list pagination. The value of the opc-next-page response header from the previous "List" call.
    // For important details about how pagination works,
    // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // For list pagination. The maximum number of results per page, or items to return in a
    // paginated "List" call. `1` is the minimum, `1000` is the maximum. For important details about
    // how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    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"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (ListSuppressionsRequest) HTTPRequest

func (request ListSuppressionsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListSuppressionsRequest) RetryPolicy

func (request ListSuppressionsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListSuppressionsRequest) String

func (request ListSuppressionsRequest) String() string

type ListSuppressionsResponse

ListSuppressionsResponse wrapper for the ListSuppressions operation

type ListSuppressionsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of []SuppressionSummary instances
    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 list pagination. When this header appears in the response, additional
    // pages of results remain. For important details about how pagination works,
    // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // For list pagination. When this header appears in the response, previous pages
    // of results exist. For important details about how pagination works,
    // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}

func (ListSuppressionsResponse) HTTPResponse

func (response ListSuppressionsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListSuppressionsResponse) String

func (response ListSuppressionsResponse) String() string

type ListSuppressionsSortByEnum

ListSuppressionsSortByEnum Enum with underlying type: string

type ListSuppressionsSortByEnum string

Set of constants representing the allowable values for ListSuppressionsSortByEnum

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

func GetListSuppressionsSortByEnumValues

func GetListSuppressionsSortByEnumValues() []ListSuppressionsSortByEnum

GetListSuppressionsSortByEnumValues Enumerates the set of values for ListSuppressionsSortByEnum

type ListSuppressionsSortOrderEnum

ListSuppressionsSortOrderEnum Enum with underlying type: string

type ListSuppressionsSortOrderEnum string

Set of constants representing the allowable values for ListSuppressionsSortOrderEnum

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

func GetListSuppressionsSortOrderEnumValues

func GetListSuppressionsSortOrderEnumValues() []ListSuppressionsSortOrderEnum

GetListSuppressionsSortOrderEnumValues Enumerates the set of values for ListSuppressionsSortOrderEnum

type Sender

Sender The full information representing an approved sender.

type Sender struct {

    // The OCID for the compartment.
    CompartmentId *string `mandatory:"false" json:"compartmentId"`

    // 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.cloud.oracle.com/Content/Email/Concepts/overview.htm#components).
    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"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (Sender) String

func (m Sender) String() string

type SenderLifecycleStateEnum

SenderLifecycleStateEnum Enum with underlying type: string

type SenderLifecycleStateEnum string

Set of constants representing the allowable values for SenderLifecycleStateEnum

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

func GetSenderLifecycleStateEnumValues

func GetSenderLifecycleStateEnumValues() []SenderLifecycleStateEnum

GetSenderLifecycleStateEnumValues Enumerates the set of values for SenderLifecycleStateEnum

type SenderSummary

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

type SenderSummary struct {

    // The OCID for the compartment.
    CompartmentId *string `mandatory:"false" json:"compartmentId"`

    // 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"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (SenderSummary) String

func (m SenderSummary) String() string

type SenderSummaryLifecycleStateEnum

SenderSummaryLifecycleStateEnum Enum with underlying type: string

type SenderSummaryLifecycleStateEnum string

Set of constants representing the allowable values for SenderSummaryLifecycleStateEnum

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

func GetSenderSummaryLifecycleStateEnumValues

func GetSenderSummaryLifecycleStateEnumValues() []SenderSummaryLifecycleStateEnum

GetSenderSummaryLifecycleStateEnumValues Enumerates the set of values for SenderSummaryLifecycleStateEnum

type Suppression

Suppression The full information representing an email suppression.

type Suppression 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"`

    // 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 Suppression List (https://docs.cloud.oracle.com/Content/Email/Concepts/overview.htm#components).
    Reason SuppressionReasonEnum `mandatory:"false" json:"reason,omitempty"`

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

func (Suppression) String

func (m Suppression) String() string

type SuppressionReasonEnum

SuppressionReasonEnum Enum with underlying type: string

type SuppressionReasonEnum string

Set of constants representing the allowable values for SuppressionReasonEnum

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

func GetSuppressionReasonEnumValues

func GetSuppressionReasonEnumValues() []SuppressionReasonEnum

GetSuppressionReasonEnumValues Enumerates the set of values for SuppressionReasonEnum

type SuppressionSummary

SuppressionSummary The full information representing a suppression.

type SuppressionSummary struct {

    // The OCID for the compartment.
    CompartmentId *string `mandatory:"false" json:"compartmentId"`

    // 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"`
}

func (SuppressionSummary) String

func (m SuppressionSummary) String() string

type SuppressionSummaryReasonEnum

SuppressionSummaryReasonEnum Enum with underlying type: string

type SuppressionSummaryReasonEnum string

Set of constants representing the allowable values for SuppressionSummaryReasonEnum

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

func GetSuppressionSummaryReasonEnumValues

func GetSuppressionSummaryReasonEnumValues() []SuppressionSummaryReasonEnum

GetSuppressionSummaryReasonEnumValues Enumerates the set of values for SuppressionSummaryReasonEnum

type UpdateSenderDetails

UpdateSenderDetails The details allowed for updating a sender.

type UpdateSenderDetails struct {

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (UpdateSenderDetails) String

func (m UpdateSenderDetails) String() string

type UpdateSenderRequest

UpdateSenderRequest wrapper for the UpdateSender operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/email/UpdateSender.go.html to see an example of how to use UpdateSenderRequest.

type UpdateSenderRequest struct {

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

    // update details for sender.
    UpdateSenderDetails `contributesTo:"body"`

    // Used for optimistic concurrency control. In the update or delete call for a resource, set the `if-match`
    // parameter to the value of the etag from a previous get, create, or update response for that resource.  The resource
    // will be updated or deleted only if the etag you provide matches the resource's current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // The request ID for tracing from the system
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (UpdateSenderRequest) HTTPRequest

func (request UpdateSenderRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateSenderRequest) RetryPolicy

func (request UpdateSenderRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateSenderRequest) String

func (request UpdateSenderRequest) String() string

type UpdateSenderResponse

UpdateSenderResponse wrapper for the UpdateSender operation

type UpdateSenderResponse 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"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`
}

func (UpdateSenderResponse) HTTPResponse

func (response UpdateSenderResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateSenderResponse) String

func (response UpdateSenderResponse) String() string