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 (m ChangeSenderCompartmentDetails) String() string
ChangeSenderCompartmentRequest wrapper for the ChangeSenderCompartment operation
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 (request ChangeSenderCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeSenderCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeSenderCompartmentRequest) String() string
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 (response ChangeSenderCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeSenderCompartmentResponse) String() string
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 (m CreateSenderDetails) String() string
CreateSenderRequest wrapper for the CreateSender operation
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 (request CreateSenderRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateSenderRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateSenderRequest) String() string
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 (response CreateSenderResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateSenderResponse) String() string
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 (m CreateSuppressionDetails) String() string
CreateSuppressionRequest wrapper for the CreateSuppression operation
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 (request CreateSuppressionRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateSuppressionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateSuppressionRequest) String() string
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 (response CreateSuppressionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateSuppressionResponse) String() string
DeleteSenderRequest wrapper for the DeleteSender operation
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 (request DeleteSenderRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteSenderRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteSenderRequest) String() string
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 (response DeleteSenderResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteSenderResponse) String() string
DeleteSuppressionRequest wrapper for the DeleteSuppression operation
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 (request DeleteSuppressionRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteSuppressionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteSuppressionRequest) String() string
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 (response DeleteSuppressionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteSuppressionResponse) String() string
EmailClient a client for Email
type EmailClient struct { common.BaseClient // contains filtered or unexported fields }
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(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 (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.
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 (client *EmailClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client EmailClient) CreateSender(ctx context.Context, request CreateSenderRequest) (response CreateSenderResponse, err error)
CreateSender Creates a sender for a tenancy in a given compartment.
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 (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.
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 (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`.
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 (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`.
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 (client EmailClient) GetSender(ctx context.Context, request GetSenderRequest) (response GetSenderResponse, err error)
GetSender Gets an approved sender for a given `senderId`.
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 (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.
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 (client EmailClient) ListSenders(ctx context.Context, request ListSendersRequest) (response ListSendersResponse, err error)
ListSenders Gets a collection of approved sender email addresses and sender IDs.
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 (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.
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 (client *EmailClient) SetRegion(region string)
SetRegion overrides the region of this client.
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).
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.
GetSenderRequest wrapper for the GetSender operation
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 (request GetSenderRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSenderRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSenderRequest) String() string
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 (response GetSenderResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSenderResponse) String() string
GetSuppressionRequest wrapper for the GetSuppression operation
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 (request GetSuppressionRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSuppressionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSuppressionRequest) String() string
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 (response GetSuppressionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSuppressionResponse) String() string
ListSendersRequest wrapper for the ListSenders operation
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 (request ListSendersRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSendersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSendersRequest) String() string
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 (response ListSendersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSendersResponse) String() string
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() []ListSendersSortByEnum
GetListSendersSortByEnumValues Enumerates the set of values for ListSendersSortByEnum
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() []ListSendersSortOrderEnum
GetListSendersSortOrderEnumValues Enumerates the set of values for ListSendersSortOrderEnum
ListSuppressionsRequest wrapper for the ListSuppressions operation
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 (request ListSuppressionsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSuppressionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSuppressionsRequest) String() string
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 (response ListSuppressionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSuppressionsResponse) String() string
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() []ListSuppressionsSortByEnum
GetListSuppressionsSortByEnumValues Enumerates the set of values for ListSuppressionsSortByEnum
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() []ListSuppressionsSortOrderEnum
GetListSuppressionsSortOrderEnumValues Enumerates the set of values for ListSuppressionsSortOrderEnum
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 (m Sender) String() string
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() []SenderLifecycleStateEnum
GetSenderLifecycleStateEnumValues Enumerates the set of values for SenderLifecycleStateEnum
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 (m SenderSummary) String() string
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() []SenderSummaryLifecycleStateEnum
GetSenderSummaryLifecycleStateEnumValues Enumerates the set of values for SenderSummaryLifecycleStateEnum
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 (m Suppression) String() string
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() []SuppressionReasonEnum
GetSuppressionReasonEnumValues Enumerates the set of values for SuppressionReasonEnum
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 (m SuppressionSummary) String() string
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() []SuppressionSummaryReasonEnum
GetSuppressionSummaryReasonEnumValues Enumerates the set of values for SuppressionSummaryReasonEnum
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 (m UpdateSenderDetails) String() string
UpdateSenderRequest wrapper for the UpdateSender operation
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 (request UpdateSenderRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateSenderRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateSenderRequest) String() string
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 (response UpdateSenderResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateSenderResponse) String() string