oci-go-sdk: github.com/oracle/oci-go-sdk/email Index | Files

package email

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

Index

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 Uses

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

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

func (ChangeSenderCompartmentDetails) String Uses

func (m ChangeSenderCompartmentDetails) String() string

type ChangeSenderCompartmentRequest Uses

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
}

ChangeSenderCompartmentRequest wrapper for the ChangeSenderCompartment operation

func (ChangeSenderCompartmentRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ChangeSenderCompartmentRequest) RetryPolicy Uses

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

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

func (ChangeSenderCompartmentRequest) String Uses

func (request ChangeSenderCompartmentRequest) String() string

type ChangeSenderCompartmentResponse Uses

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

ChangeSenderCompartmentResponse wrapper for the ChangeSenderCompartment operation

func (ChangeSenderCompartmentResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ChangeSenderCompartmentResponse) String Uses

func (response ChangeSenderCompartmentResponse) String() string

type CreateSenderDetails Uses

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

CreateSenderDetails The details needed for creating a sender.

func (CreateSenderDetails) String Uses

func (m CreateSenderDetails) String() string

type CreateSenderRequest Uses

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
}

CreateSenderRequest wrapper for the CreateSender operation

func (CreateSenderRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (CreateSenderRequest) RetryPolicy Uses

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

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

func (CreateSenderRequest) String Uses

func (request CreateSenderRequest) String() string

type CreateSenderResponse Uses

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

CreateSenderResponse wrapper for the CreateSender operation

func (CreateSenderResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateSenderResponse) String Uses

func (response CreateSenderResponse) String() string

type CreateSuppressionDetails Uses

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

CreateSuppressionDetails The details needed for creating a single suppression.

func (CreateSuppressionDetails) String Uses

func (m CreateSuppressionDetails) String() string

type CreateSuppressionRequest Uses

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
}

CreateSuppressionRequest wrapper for the CreateSuppression operation

func (CreateSuppressionRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (CreateSuppressionRequest) RetryPolicy Uses

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

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

func (CreateSuppressionRequest) String Uses

func (request CreateSuppressionRequest) String() string

type CreateSuppressionResponse Uses

type CreateSuppressionResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

CreateSuppressionResponse wrapper for the CreateSuppression operation

func (CreateSuppressionResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateSuppressionResponse) String Uses

func (response CreateSuppressionResponse) String() string

type DeleteSenderRequest Uses

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
}

DeleteSenderRequest wrapper for the DeleteSender operation

func (DeleteSenderRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (DeleteSenderRequest) RetryPolicy Uses

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

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

func (DeleteSenderRequest) String Uses

func (request DeleteSenderRequest) String() string

type DeleteSenderResponse Uses

type DeleteSenderResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

DeleteSenderResponse wrapper for the DeleteSender operation

func (DeleteSenderResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteSenderResponse) String Uses

func (response DeleteSenderResponse) String() string

type DeleteSuppressionRequest Uses

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
}

DeleteSuppressionRequest wrapper for the DeleteSuppression operation

func (DeleteSuppressionRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (DeleteSuppressionRequest) RetryPolicy Uses

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

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

func (DeleteSuppressionRequest) String Uses

func (request DeleteSuppressionRequest) String() string

type DeleteSuppressionResponse Uses

type DeleteSuppressionResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

DeleteSuppressionResponse wrapper for the DeleteSuppression operation

func (DeleteSuppressionResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteSuppressionResponse) String Uses

func (response DeleteSuppressionResponse) String() string

type EmailClient Uses

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

EmailClient a client for Email

func NewEmailClientWithConfigurationProvider Uses

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 Uses

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 Uses

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.

func (*EmailClient) ConfigurationProvider Uses

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

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

func (EmailClient) CreateSender Uses

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

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

func (EmailClient) CreateSuppression Uses

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.

func (EmailClient) DeleteSender Uses

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

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

func (EmailClient) DeleteSuppression Uses

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

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

func (EmailClient) GetSender Uses

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

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

func (EmailClient) GetSuppression Uses

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

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

func (EmailClient) ListSenders Uses

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

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

func (EmailClient) ListSuppressions Uses

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

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

func (*EmailClient) SetRegion Uses

func (client *EmailClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (EmailClient) UpdateSender Uses

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

type GetSenderRequest Uses

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
}

GetSenderRequest wrapper for the GetSender operation

func (GetSenderRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (GetSenderRequest) RetryPolicy Uses

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

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

func (GetSenderRequest) String Uses

func (request GetSenderRequest) String() string

type GetSenderResponse Uses

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

GetSenderResponse wrapper for the GetSender operation

func (GetSenderResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetSenderResponse) String Uses

func (response GetSenderResponse) String() string

type GetSuppressionRequest Uses

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
}

GetSuppressionRequest wrapper for the GetSuppression operation

func (GetSuppressionRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (GetSuppressionRequest) RetryPolicy Uses

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

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

func (GetSuppressionRequest) String Uses

func (request GetSuppressionRequest) String() string

type GetSuppressionResponse Uses

type GetSuppressionResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

GetSuppressionResponse wrapper for the GetSuppression operation

func (GetSuppressionResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetSuppressionResponse) String Uses

func (response GetSuppressionResponse) String() string

type ListSendersRequest Uses

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
}

ListSendersRequest wrapper for the ListSenders operation

func (ListSendersRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ListSendersRequest) RetryPolicy Uses

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

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

func (ListSendersRequest) String Uses

func (request ListSendersRequest) String() string

type ListSendersResponse Uses

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

ListSendersResponse wrapper for the ListSenders operation

func (ListSendersResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListSendersResponse) String Uses

func (response ListSendersResponse) String() string

type ListSendersSortByEnum Uses

type ListSendersSortByEnum string

ListSendersSortByEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListSendersSortByEnum

func GetListSendersSortByEnumValues Uses

func GetListSendersSortByEnumValues() []ListSendersSortByEnum

GetListSendersSortByEnumValues Enumerates the set of values for ListSendersSortByEnum

type ListSendersSortOrderEnum Uses

type ListSendersSortOrderEnum string

ListSendersSortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListSendersSortOrderEnum

func GetListSendersSortOrderEnumValues Uses

func GetListSendersSortOrderEnumValues() []ListSendersSortOrderEnum

GetListSendersSortOrderEnumValues Enumerates the set of values for ListSendersSortOrderEnum

type ListSuppressionsRequest Uses

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
}

ListSuppressionsRequest wrapper for the ListSuppressions operation

func (ListSuppressionsRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ListSuppressionsRequest) RetryPolicy Uses

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

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

func (ListSuppressionsRequest) String Uses

func (request ListSuppressionsRequest) String() string

type ListSuppressionsResponse Uses

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

ListSuppressionsResponse wrapper for the ListSuppressions operation

func (ListSuppressionsResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListSuppressionsResponse) String Uses

func (response ListSuppressionsResponse) String() string

type ListSuppressionsSortByEnum Uses

type ListSuppressionsSortByEnum string

ListSuppressionsSortByEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListSuppressionsSortByEnum

func GetListSuppressionsSortByEnumValues Uses

func GetListSuppressionsSortByEnumValues() []ListSuppressionsSortByEnum

GetListSuppressionsSortByEnumValues Enumerates the set of values for ListSuppressionsSortByEnum

type ListSuppressionsSortOrderEnum Uses

type ListSuppressionsSortOrderEnum string

ListSuppressionsSortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ListSuppressionsSortOrderEnum

func GetListSuppressionsSortOrderEnumValues Uses

func GetListSuppressionsSortOrderEnumValues() []ListSuppressionsSortOrderEnum

GetListSuppressionsSortOrderEnumValues Enumerates the set of values for ListSuppressionsSortOrderEnum

type Sender Uses

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

Sender The full information representing an approved sender.

func (Sender) String Uses

func (m Sender) String() string

type SenderLifecycleStateEnum Uses

type SenderLifecycleStateEnum string

SenderLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for SenderLifecycleStateEnum

func GetSenderLifecycleStateEnumValues Uses

func GetSenderLifecycleStateEnumValues() []SenderLifecycleStateEnum

GetSenderLifecycleStateEnumValues Enumerates the set of values for SenderLifecycleStateEnum

type SenderSummary Uses

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

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

func (SenderSummary) String Uses

func (m SenderSummary) String() string

type SenderSummaryLifecycleStateEnum Uses

type SenderSummaryLifecycleStateEnum string

SenderSummaryLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for SenderSummaryLifecycleStateEnum

func GetSenderSummaryLifecycleStateEnumValues Uses

func GetSenderSummaryLifecycleStateEnumValues() []SenderSummaryLifecycleStateEnum

GetSenderSummaryLifecycleStateEnumValues Enumerates the set of values for SenderSummaryLifecycleStateEnum

type Suppression Uses

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

Suppression The full information representing an email suppression.

func (Suppression) String Uses

func (m Suppression) String() string

type SuppressionReasonEnum Uses

type SuppressionReasonEnum string

SuppressionReasonEnum Enum with underlying type: string

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

Set of constants representing the allowable values for SuppressionReasonEnum

func GetSuppressionReasonEnumValues Uses

func GetSuppressionReasonEnumValues() []SuppressionReasonEnum

GetSuppressionReasonEnumValues Enumerates the set of values for SuppressionReasonEnum

type SuppressionSummary Uses

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

SuppressionSummary The full information representing a suppression.

func (SuppressionSummary) String Uses

func (m SuppressionSummary) String() string

type SuppressionSummaryReasonEnum Uses

type SuppressionSummaryReasonEnum string

SuppressionSummaryReasonEnum Enum with underlying type: string

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

Set of constants representing the allowable values for SuppressionSummaryReasonEnum

func GetSuppressionSummaryReasonEnumValues Uses

func GetSuppressionSummaryReasonEnumValues() []SuppressionSummaryReasonEnum

GetSuppressionSummaryReasonEnumValues Enumerates the set of values for SuppressionSummaryReasonEnum

type UpdateSenderDetails Uses

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

UpdateSenderDetails The details allowed for updating a sender.

func (UpdateSenderDetails) String Uses

func (m UpdateSenderDetails) String() string

type UpdateSenderRequest Uses

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
}

UpdateSenderRequest wrapper for the UpdateSender operation

func (UpdateSenderRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (UpdateSenderRequest) RetryPolicy Uses

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

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

func (UpdateSenderRequest) String Uses

func (request UpdateSenderRequest) String() string

type UpdateSenderResponse Uses

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

UpdateSenderResponse wrapper for the UpdateSender operation

func (UpdateSenderResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (UpdateSenderResponse) String Uses

func (response UpdateSenderResponse) String() string

Package email imports 4 packages (graph) and is imported by 2 packages. Updated 2020-04-26. Refresh now. Tools for package owners.