MailSlurpClient

package module
v0.0.0-...-12b5e4c Latest Latest
Warning

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

 Go to latest Published: Mar 31, 2026 License: MIT Imports: 23 Imported by: 3

README

Go Email API - Documentation

Create and manage email addresses in GoLang. Send and receive emails and attachments in code and tests.

Common controllers
Tutorial

Get started

MailSlurp is an email API that lets you create email addresses on demand then send and receive emails in code and tests. No MailServer is required.

This section describes how to get up and running with the Go client. To use another language or the REST API see the developer page.

See the examples page for code examples and use with common frameworks.

See the method documentation for a list of all functions.

Get an API Key

You need a free MailSlurp account to use the service. Sign up for a free account first.

Install

go get github.com/mailslurp/mailslurp-client-go

You may also need these dependencies:

go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

MailSlurp's Go library uses /antihax/optional to wrap many parameters. Example usage looks like this:

waitOpts := &mailslurp.WaitForLatestEmailOpts{
    InboxId: optional.NewInterface(inbox2.Id),
    Timeout: optional.NewInt64(30000),
    UnreadOnly: optional.NewBool(true),
}

Initialize

To initialize the MailSlurp client first get an API Key. Then import the libraries:

import (
    "context"
    "github.com/mailslurp/mailslurp-client-go"
)

Then configure the client:

var apiKey = "your-mailslurp-client"

// create a context with your api key
ctx := context.WithValue(
    context.Background(),
    mailslurp.ContextAPIKey,
    mailslurp.APIKey{ Key: apiKey }
)

// create mailslurp client
config := mailslurp.NewConfiguration()
client := mailslurp.NewAPIClient(config)

Controllers are then available on the client instance and can be passed your context and options:

inbox, response, err := client.InboxControllerApi.CreateInbox(ctx, &mailslurp.CreateInboxOpts{})

Example

import (
    "context"
    "github.com/antihax/optional"
    mailslurp "github.com/mailslurp/mailslurp-client-go"
    "github.com/stretchr/testify/assert"
    "os"
    "testing"
    "encoding/base64"
)

// create a client and a context 
func createClient(t *testing.T) (*mailslurp.APIClient, context.Context) {
    // read mailslurp api key from environment variable
    var apiKey = os.Getenv("API_KEY")
    assert.NotEmpty(t, apiKey, "API KEY is empty")

    // create a context with your api key
    ctx := context.WithValue(
        context.Background(),
        mailslurp.ContextAPIKey,
        mailslurp.APIKey{Key: apiKey},
    )

    // create mailslurp client
    config := mailslurp.NewConfiguration()
    return mailslurp.NewAPIClient(config), ctx
}

func Test_CanCreateInbox(t *testing.T) {
    client, ctx := createClient(t)

    // call inbox controller to create an inbox
    opts := &mailslurp.CreateInboxOpts{}
    inbox, response, err := client.InboxControllerApi.CreateInbox(ctx, opts)

    assert.Nil(t, err)
    assert.Equal(t, response.StatusCode, 201)
    assert.NotNil(t, inbox.Id)
    assert.Contains(t, inbox.EmailAddress, "@mailslurp.com")
}

See the Method Documentation for more information or see the use cases below.

Common use cases

Use controllers to manage MailSlurp entities.

Create an inbox

Use the InboxController to manage inboxes. You can create email addresses in MailSlurp by creating an inbox:

opts := &mailslurp.CreateInboxOpts{}
inbox, response, err := client.InboxControllerApi.CreateInbox(ctx, opts)

The email address and ID are accessible on the Inbox:

assert.NotNil(t, inbox.Id)
assert.Contains(t, inbox.EmailAddress, "@mailslurp.com")
Inbox types

Inboxes can be either SMTP or HTTP type. Set the inbox type using the inboxType property. SMTP inboxes are handled by a custom mailserver and support a wide range of clients while HTTP inboxes use Amazon SES and don't support some older clients like Outlook. SMTP inboxes are recommended for public facing email addresses while HTTP inboxes are best for application testing. Please see the guide on types of inboxes for more information.

Send emails

To send emails first create an inbox then use the SendEmailOptions to configure the email.

sendEmailOptions := mailslurp.SendEmailOptions{
    To: []string{inbox.EmailAddress},
    Subject: "Test email",
    Body: "<h1>MailSlurp supports HTML</h1>",
    IsHTML: true,
}
opts := &mailslurp.SendEmailOpts{
    SendEmailOptions: optional.NewInterface(sendEmailOptions),
}
res, err := client.InboxControllerApi.SendEmail(ctx, inbox.Id, opts)

Here is another example:

sendOpts := &mailslurp.SendEmailOpts{
    SendEmailOptions: optional.NewInterface(mailslurp.SendEmailOptions{
        To:      []string{inbox2.EmailAddress},
        Subject: "Test subject",
        Body:    "Hello from inbox 1",
        Attachments: attachmentIds,
    }),
}
Receive emails

You can read emails in Go using the WaitForControllerApi:

// fetch the email for inbox2
waitOpts := &mailslurp.WaitForLatestEmailOpts{
    InboxId: optional.NewInterface(inbox2.Id),
    Timeout: optional.NewInt64(30000),
    UnreadOnly: optional.NewBool(true),
}
email, response, err := client.WaitForControllerApi.WaitForLatestEmail(ctx, waitOpts)

You can extract the content of an email for use in your tests or application using regex and the email body:

// can extract the contents
r := regexp.MustCompile(`Your code is: ([0-9]{3})`)
code := r.FindStringSubmatch(email.Body)[1]

Attachments

Attachments can be sent by first uploading an attachment then using the returned ID with send email options. See the AttachmentController to manage attachments.

func uploadAttachment(t *testing.T) []string {
    client, ctx := createClient(t)
    attachmentBytes := []byte{0}
    uploadOpts := mailslurp.UploadAttachmentOptions{
        Base64Contents: base64.URLEncoding.EncodeToString(attachmentBytes),
        ContentType:    "text/plain",
        Filename:       "test.txt",
    }
    attachmentIds, _, err := client.AttachmentControllerApi.UploadAttachment(ctx, uploadOpts)
    assert.Nil(t, err)
    return attachmentIds
}

func Test_CanSendEmail_AndReceive(t *testing.T) {
    client, ctx := createClient(t)
    opts := &mailslurp.CreateInboxOpts{}

    // create two inboxes
    inbox1, _, err := client.InboxControllerApi.CreateInbox(ctx, opts)
    inbox2, _, err := client.InboxControllerApi.CreateInbox(ctx, opts)

    assert.Nil(t, err)

    // upload attachments before send
    attachmentIds := uploadAttachment(t)

    // send a simple email from inbox 1 to inbox 2
    sendOpts := &mailslurp.SendEmailOpts{
        SendEmailOptions: optional.NewInterface(mailslurp.SendEmailOptions{
            To:      []string{inbox2.EmailAddress},
            Subject: "Test subject",
            Body:    "Hello from inbox 1",
            Attachments: attachmentIds,
        }),
    }

    _, err = client.InboxControllerApi.SendEmail(ctx, inbox1.Id, sendOpts)
    assert.Nil(t, err)

    // now receive the email at inbox 2
    waitForOpts := &mailslurp.WaitForLatestEmailOpts{
        InboxId:    optional.NewInterface(inbox2.Id),
        Timeout:    optional.NewInt64(30000),
        UnreadOnly: optional.NewBool(true),
    }
    email, _, err := client.WaitForControllerApi.WaitForLatestEmail(ctx,waitForOpts)
    assert.Nil(t, err)

    // access content
    assert.Equal(t, email.InboxId, inbox2.Id)
    assert.Contains(t, email.Subject, "Test subject")
    assert.Contains(t, email.Body, "Hello from inbox 1")

    // download the attachment as bytes
    downloadedBytes, _, err := client.EmailControllerApi.DownloadAttachment(ctx, email.Attachments[0], email.Id, nil)
    assert.Nil(t, err)
    assert.NotEmpty(t, downloadedBytes)
}

Next step

For more information see the source code on GitHub or documentation available at MailSlurp's developer page.

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type AIControllerApiService 

type AIControllerApiService service

AIControllerApiService AIControllerApi service

func (*AIControllerApiService) CreateTransformer 

func (a *AIControllerApiService) CreateTransformer(ctx _context.Context, aiTransformCreateOptions AiTransformCreateOptions) (AiTransformDto, *_nethttp.Response, error)

CreateTransformer Create a transformer for reuse in automations Save an AI transform instructions and schema for use with webhooks and automations

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param aiTransformCreateOptions

@return AiTransformDto

func (*AIControllerApiService) CreateTransformerMappings 

func (a *AIControllerApiService) CreateTransformerMappings(ctx _context.Context, createAiTransformerMappingOptions CreateAiTransformerMappingOptions) (AiTransformMappingDto, *_nethttp.Response, error)

CreateTransformerMappings Create transformer mapping Create AI transformer mappings to other entities

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createAiTransformerMappingOptions

@return AiTransformMappingDto

func (*AIControllerApiService) DeleteAllTransformerMappings 

func (a *AIControllerApiService) DeleteAllTransformerMappings(ctx _context.Context) (*_nethttp.Response, error)

DeleteAllTransformerMappings Delete all transformer mapping Delete all AI transformer mappings

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*AIControllerApiService) DeleteTransformer 

func (a *AIControllerApiService) DeleteTransformer(ctx _context.Context, id string) (*_nethttp.Response, error)

DeleteTransformer Delete a transformer Delete an AI transformer and schemas by ID

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

func (*AIControllerApiService) DeleteTransformerMapping 

func (a *AIControllerApiService) DeleteTransformerMapping(ctx _context.Context, id string) (*_nethttp.Response, error)

DeleteTransformerMapping Delete transformer mapping Delete an AI transformer mapping

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of transform mapping

func (*AIControllerApiService) DeleteTransformers 

func (a *AIControllerApiService) DeleteTransformers(ctx _context.Context) (*_nethttp.Response, error)

DeleteTransformers Delete all transformers Delete all AI transformers and schemas

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*AIControllerApiService) ExportTransformerResults 

func (a *AIControllerApiService) ExportTransformerResults(ctx _context.Context, exportTransformerOptions ExportTransformerOptions) (ExportTransformerResponse, *_nethttp.Response, error)

ExportTransformerResults Export transformer results Export AI transformer results in formats such as Excel, CSV, XML etc.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param exportTransformerOptions

@return ExportTransformerResponse

func (*AIControllerApiService) GenerateStructuredContentFromAttachment 

func (a *AIControllerApiService) GenerateStructuredContentFromAttachment(ctx _context.Context, generateStructuredContentAttachmentOptions GenerateStructuredContentAttachmentOptions) (StructuredContentResultDto, *_nethttp.Response, error)

GenerateStructuredContentFromAttachment Generate structured content for an attachment Use output schemas to extract data from an attachment using AI

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param generateStructuredContentAttachmentOptions

@return StructuredContentResultDto

func (*AIControllerApiService) GenerateStructuredContentFromEmail 

func (a *AIControllerApiService) GenerateStructuredContentFromEmail(ctx _context.Context, generateStructuredContentEmailOptions GenerateStructuredContentEmailOptions) (StructuredContentResultDto, *_nethttp.Response, error)

GenerateStructuredContentFromEmail Generate structured content for an email Use output schemas to extract data from an email using AI

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param generateStructuredContentEmailOptions

@return StructuredContentResultDto

func (*AIControllerApiService) GenerateStructuredContentFromSms 

func (a *AIControllerApiService) GenerateStructuredContentFromSms(ctx _context.Context, generateStructuredContentSmsOptions GenerateStructuredContentSmsOptions) (StructuredContentResultDto, *_nethttp.Response, error)

GenerateStructuredContentFromSms Generate structured content for a TXT message Use output schemas to extract data from an SMS using AI

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param generateStructuredContentSmsOptions

@return StructuredContentResultDto

func (*AIControllerApiService) GetExportTransformerResultsJob 

func (a *AIControllerApiService) GetExportTransformerResultsJob(ctx _context.Context, id string) (ExportTransformerResultJobDto, *_nethttp.Response, error)

GetExportTransformerResultsJob Get export transformer results job Get the job status for an export

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

@return ExportTransformerResultJobDto

func (*AIControllerApiService) GetTransformer 

func (a *AIControllerApiService) GetTransformer(ctx _context.Context, id string) (AiTransformDto, *_nethttp.Response, error)

GetTransformer Get a transformer Get AI transformer and schemas by ID

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

@return AiTransformDto

func (*AIControllerApiService) GetTransformerMapping 

func (a *AIControllerApiService) GetTransformerMapping(ctx _context.Context, id string) (AiTransformMappingDto, *_nethttp.Response, error)

GetTransformerMapping Get transformer mapping Get an AI transformer mapping

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of transform mapping

@return AiTransformMappingDto

func (*AIControllerApiService) GetTransformerMappings 

func (a *AIControllerApiService) GetTransformerMappings(ctx _context.Context, localVarOptionals *GetTransformerMappingsOpts) (PageAiTransformMappingProjection, *_nethttp.Response, error)

GetTransformerMappings Get transformer mappings Get AI transformer mappings to other entities

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetTransformerMappingsOpts - Optional Parameters:
  • @param "AiTransformId" (optional.Interface of string) -
  • @param "EntityId" (optional.Interface of string) -
  • @param "EntityType" (optional.String) -
  • @param "Page" (optional.Int32) -
  • @param "Size" (optional.Int32) - Optional page size. Maximum size is 100. Use page index and sort to page through larger results
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC

@return PageAiTransformMappingProjection

func (*AIControllerApiService) GetTransformerResult 

func (a *AIControllerApiService) GetTransformerResult(ctx _context.Context, id string) (AiTransformResultDto, *_nethttp.Response, error)

GetTransformerResult Get transformer result Get AI transformer result

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of transform result

@return AiTransformResultDto

func (*AIControllerApiService) GetTransformerResults 

func (a *AIControllerApiService) GetTransformerResults(ctx _context.Context, localVarOptionals *GetTransformerResultsOpts) (PageAiTransformResultProjection, *_nethttp.Response, error)

GetTransformerResults Get transformer results Get AI transformer results

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetTransformerResultsOpts - Optional Parameters:
  • @param "EmailId" (optional.Interface of string) -
  • @param "SmsId" (optional.Interface of string) -
  • @param "AttachmentId" (optional.String) -
  • @param "AiTransformId" (optional.Interface of string) -
  • @param "AiTransformMappingId" (optional.Interface of string) -
  • @param "EntityId" (optional.Interface of string) -
  • @param "EntityType" (optional.String) -
  • @param "Page" (optional.Int32) -
  • @param "Size" (optional.Int32) - Optional page size. Maximum size is 100. Use page index and sort to page through larger results
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC

@return PageAiTransformResultProjection

func (*AIControllerApiService) GetTransformerResultsTable 

func (a *AIControllerApiService) GetTransformerResultsTable(ctx _context.Context, includeMetaData bool, flattenArraysToRows bool, localVarOptionals *GetTransformerResultsTableOpts) (PageTableData, *_nethttp.Response, error)

GetTransformerResultsTable Get transformer results table Get AI transformer results in table format

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param includeMetaData
  • @param flattenArraysToRows
  • @param optional nil or *GetTransformerResultsTableOpts - Optional Parameters:
  • @param "EmailId" (optional.Interface of string) -
  • @param "SmsId" (optional.Interface of string) -
  • @param "AttachmentId" (optional.String) -
  • @param "AiTransformId" (optional.Interface of string) -
  • @param "AiTransformMappingId" (optional.Interface of string) -
  • @param "EntityId" (optional.Interface of string) -
  • @param "EntityType" (optional.String) -
  • @param "Page" (optional.Int32) -
  • @param "Size" (optional.Int32) - Optional page size. Maximum size is 100. Use page index and sort to page through larger results
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC

@return PageTableData

func (*AIControllerApiService) GetTransformers 

func (a *AIControllerApiService) GetTransformers(ctx _context.Context, localVarOptionals *GetTransformersOpts) (PageAiTransformProjection, *_nethttp.Response, error)

GetTransformers List transformers List all AI transforms

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetTransformersOpts - Optional Parameters:
  • @param "Page" (optional.Int32) -
  • @param "Size" (optional.Int32) - Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Include" (optional.Interface of []string) - Optional list of IDs to include in result

@return PageAiTransformProjection

func (*AIControllerApiService) InvokeTransformer 

func (a *AIControllerApiService) InvokeTransformer(ctx _context.Context, invokeTransformerOptions InvokeTransformerOptions) (ConditionalStructuredContentResult, *_nethttp.Response, error)

InvokeTransformer Invoke a transformer Execute an AI transformer to generate structured content

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param invokeTransformerOptions

@return ConditionalStructuredContentResult

func (*AIControllerApiService) TestTransformerMappingMatch 

func (a *AIControllerApiService) TestTransformerMappingMatch(ctx _context.Context, id string, localVarOptionals *TestTransformerMappingMatchOpts) (AiTransformMappingMatchResult, *_nethttp.Response, error)

TestTransformerMappingMatch Test transformer mapping match result Evaluate transform mapping match conditions for given email, sms, or attachment

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of transform mapping
  • @param optional nil or *TestTransformerMappingMatchOpts - Optional Parameters:
  • @param "EmailId" (optional.Interface of string) -
  • @param "SmsId" (optional.Interface of string) -
  • @param "AttachmentId" (optional.String) -

@return AiTransformMappingMatchResult

func (*AIControllerApiService) ValidateStructuredOutputSchema 

func (a *AIControllerApiService) ValidateStructuredOutputSchema(ctx _context.Context, structuredOutputSchema StructuredOutputSchema) (StructuredOutputSchemaValidation, *_nethttp.Response, error)

ValidateStructuredOutputSchema Validate structured content schema Check if a schema is valid and can be used to extract data using AI

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param structuredOutputSchema

@return StructuredOutputSchemaValidation

type APIClient 

type APIClient struct {
	AIControllerApi *AIControllerApiService

	AliasControllerApi *AliasControllerApiService

	ApiAuditLogControllerApi *ApiAuditLogControllerApiService

	AttachmentControllerApi *AttachmentControllerApiService

	BounceControllerApi *BounceControllerApiService

	BulkActionsControllerApi *BulkActionsControllerApiService

	CampaignProbeControllerApi *CampaignProbeControllerApiService

	CommonActionsControllerApi *CommonActionsControllerApiService

	ConnectorControllerApi *ConnectorControllerApiService

	ConsentControllerApi *ConsentControllerApiService

	ContactControllerApi *ContactControllerApiService

	DeliverabilityTestControllerApi *DeliverabilityTestControllerApiService

	DevicePreviewsControllerApi *DevicePreviewsControllerApiService

	DomainControllerApi *DomainControllerApiService

	DomainMonitorControllerApi *DomainMonitorControllerApiService

	EmailAuditControllerApi *EmailAuditControllerApiService

	EmailControllerApi *EmailControllerApiService

	EmailVerificationControllerApi *EmailVerificationControllerApiService

	ExpiredControllerApi *ExpiredControllerApiService

	ExportControllerApi *ExportControllerApiService

	FormControllerApi *FormControllerApiService

	GroupControllerApi *GroupControllerApiService

	GuestPortalControllerApi *GuestPortalControllerApiService

	ImapControllerApi *ImapControllerApiService

	InboxControllerApi *InboxControllerApiService

	InboxForwarderControllerApi *InboxForwarderControllerApiService

	InboxReplierControllerApi *InboxReplierControllerApiService

	MFAControllerApi *MFAControllerApiService

	MailServerControllerApi *MailServerControllerApiService

	MissedEmailControllerApi *MissedEmailControllerApiService

	MissedSmsControllerApi *MissedSmsControllerApiService

	PhoneControllerApi *PhoneControllerApiService

	RulesetControllerApi *RulesetControllerApiService

	SentEmailsControllerApi *SentEmailsControllerApiService

	SmsControllerApi *SmsControllerApiService

	TemplateControllerApi *TemplateControllerApiService

	ToolsControllerApi *ToolsControllerApiService

	TrackingControllerApi *TrackingControllerApiService

	UserControllerApi *UserControllerApiService

	WaitForControllerApi *WaitForControllerApiService

	WebhookControllerApi *WebhookControllerApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the MailSlurp API API v6.5.2 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

ChangeBasePath changes base path to allow switching to mocks

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResonse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type AbstractWebhookPayload 

type AbstractWebhookPayload struct {
	EventName   string `json:"eventName"`
	WebhookId   string `json:"webhookId"`
	MessageId   string `json:"messageId"`
	WebhookName string `json:"webhookName,omitempty"`
}

AbstractWebhookPayload Abstract webhook payload. Use the correct payload type for your webhook event type in order to access all the specific properties for that event. See the `NEW_EMAIL`,`NEW_CONTACT`, `NEW_ATTACHMENT` and `EMAIL_OPENED` payloads for the properties available for those events.

type AccountBounceBlockDto 

type AccountBounceBlockDto struct {
	IsFrozen              bool  `json:"isFrozen"`
	IsSendingBlocked      bool  `json:"isSendingBlocked"`
	BounceCount           int64 `json:"bounceCount"`
	BounceCountToday      int64 `json:"bounceCountToday"`
	MaximumDailyBounces   int64 `json:"maximumDailyBounces"`
	MaximumAccountBounces int64 `json:"maximumAccountBounces"`
}

AccountBounceBlockDto struct for AccountBounceBlockDto

type AcquirePhonePoolLeaseOptions 

type AcquirePhonePoolLeaseOptions struct {
	LeaseName            string `json:"leaseName,omitempty"`
	LeaseOwner           string `json:"leaseOwner,omitempty"`
	LeaseDurationMillis  int64  `json:"leaseDurationMillis,omitempty"`
	AcquireTimeoutMillis int64  `json:"acquireTimeoutMillis,omitempty"`
}

AcquirePhonePoolLeaseOptions struct for AcquirePhonePoolLeaseOptions

type AddPhonePoolNumbersOptions 

type AddPhonePoolNumbersOptions struct {
	PhoneNumberIds []string `json:"phoneNumberIds"`
}

AddPhonePoolNumbersOptions struct for AddPhonePoolNumbersOptions

type AiMappingMatchOption 

type AiMappingMatchOption struct {
	// Fields of an email, sms, or attachment object that can be used to filter results
	Field string `json:"field"`
	// How the value of the field specified should be compared to the value given in the match options.
	Should string `json:"should"`
	// The value you wish to compare with the value of the field specified using the `should` value passed. For example `BODY` should `CONTAIN` a value passed. When should value is `MATCH` pass a regex
	Value string `json:"value"`
}

AiMappingMatchOption Options for matching when an AI transform mapping should trigger. Each match option object contains a `field`, `should` and `value` property. Together they form logical conditions such as `SUBJECT` should `CONTAIN` value.

type AiMappingMatchOptions 

type AiMappingMatchOptions struct {
	// Zero or more match options such as `{ field: 'SUBJECT', should: 'CONTAIN', value: 'Welcome' }`. Options are additive so if one does not match the email is excluded from results
	Matches *[]AiMappingMatchOption `json:"matches,omitempty"`
}

AiMappingMatchOptions Optional filter for matching emails based on fields. For instance filter results to only include emails whose `SUBJECT` value does `CONTAIN` given match value. An example payload would be `{ matches: [{ field: 'SUBJECT', should: 'CONTAIN', value: 'Welcome' }] }`. You can also pass conditions such as `HAS_ATTACHMENT`. If you wish to extract regex matches inside the email content see the `getEmailContentMatch` method in the EmailController.

type AiTransformCreateOptions 

type AiTransformCreateOptions struct {
	Name           *string                 `json:"name,omitempty"`
	Conditions     *[]string               `json:"conditions,omitempty"`
	Instructions   *[]string               `json:"instructions,omitempty"`
	OutputSchema   *StructuredOutputSchema `json:"outputSchema,omitempty"`
	OutputSchemaId *string                 `json:"outputSchemaId,omitempty"`
	ExtractPrompt  *string                 `json:"extractPrompt,omitempty"`
}

AiTransformCreateOptions struct for AiTransformCreateOptions

type AiTransformDto 

type AiTransformDto struct {
	Id           string                  `json:"id"`
	Name         string                  `json:"name,omitempty"`
	Conditions   []string                `json:"conditions,omitempty"`
	Instructions []string                `json:"instructions,omitempty"`
	OutputSchema *StructuredOutputSchema `json:"outputSchema,omitempty"`
	CreatedAt    time.Time               `json:"createdAt"`
}

AiTransformDto struct for AiTransformDto

type AiTransformMappingDto 

type AiTransformMappingDto struct {
	Id            string                 `json:"id"`
	AiTransformId string                 `json:"aiTransformId"`
	MatchOptions  *AiMappingMatchOptions `json:"matchOptions,omitempty"`
	UserId        string                 `json:"userId"`
	Name          string                 `json:"name,omitempty"`
	EntityId      string                 `json:"entityId,omitempty"`
	EntityType    string                 `json:"entityType"`
	CreatedAt     time.Time              `json:"createdAt"`
}

AiTransformMappingDto struct for AiTransformMappingDto

type AiTransformMappingMatchResult 

type AiTransformMappingMatchResult struct {
	IsMatch bool `json:"isMatch"`
}

AiTransformMappingMatchResult struct for AiTransformMappingMatchResult

type AiTransformMappingProjection 

type AiTransformMappingProjection struct {
	Name            string    `json:"name,omitempty"`
	Id              string    `json:"id"`
	UserId          string    `json:"userId"`
	CreatedAt       time.Time `json:"createdAt"`
	EntityType      string    `json:"entityType"`
	AiTransformId   string    `json:"aiTransformId"`
	EntityId        string    `json:"entityId,omitempty"`
	ContentSelector string    `json:"contentSelector,omitempty"`
	TriggerSelector string    `json:"triggerSelector,omitempty"`
}

AiTransformMappingProjection struct for AiTransformMappingProjection

type AiTransformProjection 

type AiTransformProjection struct {
	Name         string                  `json:"name,omitempty"`
	Id           string                  `json:"id"`
	CreatedAt    time.Time               `json:"createdAt"`
	Conditions   []string                `json:"conditions,omitempty"`
	Instructions []string                `json:"instructions,omitempty"`
	OutputSchema *StructuredOutputSchema `json:"outputSchema,omitempty"`
}

AiTransformProjection struct for AiTransformProjection

type AiTransformResultDto 

type AiTransformResultDto struct {
	Id                   string                  `json:"id"`
	UserId               string                  `json:"userId"`
	AiTransformId        string                  `json:"aiTransformId"`
	AiTransformMappingId *string                 `json:"aiTransformMappingId,omitempty"`
	Value                *map[string]interface{} `json:"value,omitempty"`
	EntityId             *string                 `json:"entityId,omitempty"`
	EntityType           *string                 `json:"entityType,omitempty"`
	Columns              *[]string               `json:"columns"`
	EmailId              *string                 `json:"emailId,omitempty"`
	SmsId                *string                 `json:"smsId,omitempty"`
	AttachmentId         *string                 `json:"attachmentId,omitempty"`
	CreatedAt            time.Time               `json:"createdAt"`
	UpdatedAt            time.Time               `json:"updatedAt"`
}

AiTransformResultDto struct for AiTransformResultDto

type AiTransformResultProjectionDto 

type AiTransformResultProjectionDto struct {
	Id                   string                  `json:"id"`
	AiTransformId        string                  `json:"aiTransformId"`
	AiTransformMappingId *string                 `json:"aiTransformMappingId,omitempty"`
	UserId               string                  `json:"userId"`
	Value                *map[string]interface{} `json:"value,omitempty"`
	EntityId             *string                 `json:"entityId,omitempty"`
	EntityType           *string                 `json:"entityType,omitempty"`
	SmsId                *string                 `json:"smsId,omitempty"`
	EmailId              *string                 `json:"emailId,omitempty"`
	AttachmentId         *string                 `json:"attachmentId,omitempty"`
	CreatedAt            time.Time               `json:"createdAt"`
}

AiTransformResultProjectionDto struct for AiTransformResultProjectionDto

type AliasControllerApiService 

type AliasControllerApiService service

AliasControllerApiService AliasControllerApi service

func (*AliasControllerApiService) CreateAlias 

func (a *AliasControllerApiService) CreateAlias(ctx _context.Context, createAliasOptions CreateAliasOptions) (AliasDto, *_nethttp.Response, error)

CreateAlias Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active. Email aliases use a MailSlurp randomly generated email address (or a custom domain inbox that you provide) to mask or proxy a real email address. Emails sent to the alias address will be forwarded to the hidden email address it was created for. If you want to send a reply use the threadId attached

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createAliasOptions

@return AliasDto

func (*AliasControllerApiService) DeleteAlias 

func (a *AliasControllerApiService) DeleteAlias(ctx _context.Context, aliasId string) (*_nethttp.Response, error)

DeleteAlias Delete an email alias

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param aliasId

func (*AliasControllerApiService) GetAlias 

func (a *AliasControllerApiService) GetAlias(ctx _context.Context, aliasId string) (AliasDto, *_nethttp.Response, error)

GetAlias Get an email alias Get an email alias by ID

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param aliasId

@return AliasDto

func (*AliasControllerApiService) GetAliasEmails 

func (a *AliasControllerApiService) GetAliasEmails(ctx _context.Context, aliasId string, localVarOptionals *GetAliasEmailsOpts) (PageEmailProjection, *_nethttp.Response, error)

GetAliasEmails Get emails for an alias Get paginated emails for an alias by ID

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param aliasId
  • @param optional nil or *GetAliasEmailsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index alias email list pagination
  • @param "Size" (optional.Int32) - Optional page size alias email list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Optional filter by sent after given date time
  • @param "Before" (optional.Time) - Optional filter by sent before given date time

@return PageEmailProjection

func (*AliasControllerApiService) GetAliasThreads 

func (a *AliasControllerApiService) GetAliasThreads(ctx _context.Context, aliasId string, localVarOptionals *GetAliasThreadsOpts) (PageAliasThreadProjection, *_nethttp.Response, error)

GetAliasThreads Get threads created for an alias Returns threads created for an email alias in paginated form

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param aliasId
  • @param optional nil or *GetAliasThreadsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in thread list pagination
  • @param "Size" (optional.Int32) - Optional page size in thread list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Optional filter by sent after given date time
  • @param "Before" (optional.Time) - Optional filter by sent before given date time

@return PageAliasThreadProjection

func (*AliasControllerApiService) GetAliases 

func (a *AliasControllerApiService) GetAliases(ctx _context.Context, localVarOptionals *GetAliasesOpts) (PageAlias, *_nethttp.Response, error)

GetAliases Get all email aliases you have created Get all email aliases in paginated form

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAliasesOpts - Optional Parameters:
  • @param "Search" (optional.String) - Optional search term
  • @param "Page" (optional.Int32) - Optional page index in alias list pagination
  • @param "Size" (optional.Int32) - Optional page size in alias list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return PageAlias

func (*AliasControllerApiService) GetThread 

func (a *AliasControllerApiService) GetThread(ctx _context.Context, threadId string) (AliasThreadProjection, *_nethttp.Response, error)

GetThread Get a thread Return a thread associated with an alias

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param threadId

@return AliasThreadProjection

func (*AliasControllerApiService) GetThreadsPaginated 

func (a *AliasControllerApiService) GetThreadsPaginated(ctx _context.Context, localVarOptionals *GetThreadsPaginatedOpts) (PageAliasThreadProjection, *_nethttp.Response, error)

GetThreadsPaginated Get all threads Returns threads created for all aliases in paginated form

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetThreadsPaginatedOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in thread list pagination
  • @param "Size" (optional.Int32) - Optional page size in thread list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Optional filter by sent after given date time
  • @param "Before" (optional.Time) - Optional filter by sent before given date time

@return PageAliasThreadProjection

func (*AliasControllerApiService) ReplyToAliasEmail 

func (a *AliasControllerApiService) ReplyToAliasEmail(ctx _context.Context, aliasId string, emailId string, replyToAliasEmailOptions ReplyToAliasEmailOptions) (SentEmailDto, *_nethttp.Response, error)

ReplyToAliasEmail Reply to an email Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails &#x60;to&#x60;, &#x60;cc&#x60;, and &#x60;bcc&#x60;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param aliasId ID of the alias that email belongs to
  • @param emailId ID of the email that should be replied to
  • @param replyToAliasEmailOptions

@return SentEmailDto

func (*AliasControllerApiService) SendAliasEmail 

func (a *AliasControllerApiService) SendAliasEmail(ctx _context.Context, aliasId string, sendEmailOptions SendEmailOptions) (SentEmailDto, *_nethttp.Response, error)

SendAliasEmail Send an email from an alias inbox Send an email from an alias. Replies to the email will be forwarded to the alias masked email address

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param aliasId
  • @param sendEmailOptions

@return SentEmailDto

func (*AliasControllerApiService) UpdateAlias 

func (a *AliasControllerApiService) UpdateAlias(ctx _context.Context, aliasId string, updateAliasOptions UpdateAliasOptions) (AliasDto, *_nethttp.Response, error)

UpdateAlias Update an email alias

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param aliasId
  • @param updateAliasOptions

@return AliasDto

type AliasDto 

type AliasDto struct {
	Id string `json:"id"`
	// The alias's email address for receiving email
	EmailAddress string `json:"emailAddress"`
	// The underlying email address that is hidden and will received forwarded email
	MaskedEmailAddress *string `json:"maskedEmailAddress,omitempty"`
	UserId             string  `json:"userId"`
	// Inbox that is associated with the alias
	InboxId string  `json:"inboxId"`
	Name    *string `json:"name,omitempty"`
	// If alias will generate response threads or not when email are received by it
	UseThreads *bool `json:"useThreads,omitempty"`
	// Has the alias been verified. You must verify an alias if the masked email address has not yet been verified by your account
	IsVerified bool `json:"isVerified"`
	// Domain ID associated with the alias
	DomainId  *string    `json:"domainId,omitempty"`
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
}

AliasDto Email alias representation

type AliasProjection 

type AliasProjection struct {
	Name         string    `json:"name,omitempty"`
	Id           string    `json:"id"`
	UserId       string    `json:"userId"`
	EmailAddress string    `json:"emailAddress"`
	InboxId      string    `json:"inboxId"`
	UpdatedAt    time.Time `json:"updatedAt"`
	CreatedAt    time.Time `json:"createdAt"`
	UseThreads   bool      `json:"useThreads,omitempty"`
}

AliasProjection Representation of a alias

type AliasThreadProjection 

type AliasThreadProjection struct {
	// Name of thread
	Name string `json:"name,omitempty"`
	// ID of email thread
	Id string `json:"id"`
	// Thread subject
	Subject string `json:"subject,omitempty"`
	// User ID
	UserId string `json:"userId"`
	// Inbox ID
	InboxId string `json:"inboxId"`
	// Updated at DateTime
	UpdatedAt time.Time `json:"updatedAt"`
	// Created at DateTime
	CreatedAt time.Time `json:"createdAt"`
	// To recipients
	To []string `json:"to"`
	// CC recipients
	Cc []string `json:"cc,omitempty"`
	// BCC recipients
	Bcc []string `json:"bcc,omitempty"`
	// Alias ID
	AliasId string `json:"aliasId"`
}

AliasThreadProjection A thread is a message thread created for a message received by an alias

type AnalyzeDmarcReportOptions 

type AnalyzeDmarcReportOptions struct {
	ReportXml    string `json:"reportXml"`
	CaptchaToken string `json:"captchaToken,omitempty"`
}

AnalyzeDmarcReportOptions struct for AnalyzeDmarcReportOptions

type AnalyzeDmarcReportResults 

type AnalyzeDmarcReportResults struct {
	Metadata             DmarcReportMetadata        `json:"metadata"`
	RecordCount          int32                      `json:"recordCount"`
	TotalMessages        int32                      `json:"totalMessages"`
	RejectCount          int32                      `json:"rejectCount"`
	QuarantineCount      int32                      `json:"quarantineCount"`
	NoneCount            int32                      `json:"noneCount"`
	DkimAlignedCount     int32                      `json:"dkimAlignedCount"`
	SpfAlignedCount      int32                      `json:"spfAlignedCount"`
	FullyAlignedCount    int32                      `json:"fullyAlignedCount"`
	FailedAlignmentCount int32                      `json:"failedAlignmentCount"`
	TopSources           []DmarcReportSourceSummary `json:"topSources"`
	Warnings             []string                   `json:"warnings"`
	Errors               []string                   `json:"errors"`
}

AnalyzeDmarcReportResults Aggregate analysis results for an uploaded DMARC XML report

type AnalyzeEmailHeadersOptions 

type AnalyzeEmailHeadersOptions struct {
	// Raw RFC 5322 email headers to analyze
	RawHeaders string `json:"rawHeaders"`
}

AnalyzeEmailHeadersOptions struct for AnalyzeEmailHeadersOptions

type AnalyzeEmailHeadersResults 

type AnalyzeEmailHeadersResults struct {
	Summary       EmailHeaderAnalysisSummary `json:"summary"`
	ReceivedPath  []EmailHeaderReceivedHop   `json:"receivedPath"`
	ParsedHeaders map[string][]string        `json:"parsedHeaders"`
	Warnings      []string                   `json:"warnings"`
	Errors        []string                   `json:"errors"`
}

AnalyzeEmailHeadersResults struct for AnalyzeEmailHeadersResults

type ApiAuditLogControllerApiService 

type ApiAuditLogControllerApiService service

ApiAuditLogControllerApiService ApiAuditLogControllerApi service

func (*ApiAuditLogControllerApiService) GetAuditLogByEventId 

func (a *ApiAuditLogControllerApiService) GetAuditLogByEventId(ctx _context.Context, eventId string, localVarOptionals *GetAuditLogByEventIdOpts) (AuditLogEventDto, *_nethttp.Response, error)

GetAuditLogByEventId Method for GetAuditLogByEventId

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param eventId
  • @param optional nil or *GetAuditLogByEventIdOpts - Optional Parameters:
  • @param "Since" (optional.Time) -
  • @param "Before" (optional.Time) -

@return AuditLogEventDto

func (*ApiAuditLogControllerApiService) GetAuditLogs 

func (a *ApiAuditLogControllerApiService) GetAuditLogs(ctx _context.Context, localVarOptionals *GetAuditLogsOpts) (AuditLogPageDto, *_nethttp.Response, error)

GetAuditLogs Method for GetAuditLogs

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAuditLogsOpts - Optional Parameters:
  • @param "Since" (optional.Time) -
  • @param "Before" (optional.Time) -
  • @param "Action" (optional.String) -
  • @param "UserId" (optional.Interface of string) -
  • @param "ActorUserId" (optional.Interface of string) -
  • @param "TargetUserId" (optional.Interface of string) -
  • @param "ResourceType" (optional.String) -
  • @param "ResourceId" (optional.String) -
  • @param "Outcome" (optional.String) -
  • @param "RequestId" (optional.String) -
  • @param "IpAddress" (optional.String) -
  • @param "PageSize" (optional.Int32) -
  • @param "Cursor" (optional.String) -

@return AuditLogPageDto

func (*ApiAuditLogControllerApiService) SearchAuditLogs 

func (a *ApiAuditLogControllerApiService) SearchAuditLogs(ctx _context.Context, auditLogSearchOptions AuditLogSearchOptions) (AuditLogPageDto, *_nethttp.Response, error)

SearchAuditLogs Method for SearchAuditLogs

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param auditLogSearchOptions

@return AuditLogPageDto

type AttachmentControllerApiService 

type AttachmentControllerApiService service

AttachmentControllerApiService AttachmentControllerApi service

func (*AttachmentControllerApiService) DeleteAllAttachments 

func (a *AttachmentControllerApiService) DeleteAllAttachments(ctx _context.Context) (*_nethttp.Response, error)

DeleteAllAttachments Delete all attachments Delete all attachments

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*AttachmentControllerApiService) DeleteAttachment 

func (a *AttachmentControllerApiService) DeleteAttachment(ctx _context.Context, attachmentId string) (*_nethttp.Response, error)

DeleteAttachment Delete an attachment Delete an attachment

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param attachmentId ID of attachment

func (*AttachmentControllerApiService) DownloadAttachmentAsBase64Encoded 

func (a *AttachmentControllerApiService) DownloadAttachmentAsBase64Encoded(ctx _context.Context, attachmentId string) (DownloadAttachmentDto, *_nethttp.Response, error)

DownloadAttachmentAsBase64Encoded Get email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents. Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the &#x60;downloadAttachment&#x60; method but allows some clients to get around issues with binary responses.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param attachmentId ID of attachment

@return DownloadAttachmentDto

func (*AttachmentControllerApiService) DownloadAttachmentAsBytes 

func (a *AttachmentControllerApiService) DownloadAttachmentAsBytes(ctx _context.Context, attachmentId string) (string, *_nethttp.Response, error)

DownloadAttachmentAsBytes Download attachments. Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints. Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param attachmentId ID of attachment

@return string

func (*AttachmentControllerApiService) ExtractAttachmentText 

func (a *AttachmentControllerApiService) ExtractAttachmentText(ctx _context.Context, attachmentId string, localVarOptionals *ExtractAttachmentTextOpts) (ExtractAttachmentTextResult, *_nethttp.Response, error)

ExtractAttachmentText Extract text from an attachment Extract text content from an attachment using the requested method. &#x60;NATIVE&#x60; decoding supports text-like files, common Word and spreadsheet documents, and PDFs with embedded text.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param attachmentId ID of attachment
  • @param optional nil or *ExtractAttachmentTextOpts - Optional Parameters:
  • @param "ExtractAttachmentTextOptions" (optional.Interface of ExtractAttachmentTextOptions) -

@return ExtractAttachmentTextResult

func (*AttachmentControllerApiService) GetAttachment 

func (a *AttachmentControllerApiService) GetAttachment(ctx _context.Context, attachmentId string) (AttachmentEntityDto, *_nethttp.Response, error)

GetAttachment Get an attachment entity

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param attachmentId ID of attachment

@return AttachmentEntityDto

func (*AttachmentControllerApiService) GetAttachmentInfo 

func (a *AttachmentControllerApiService) GetAttachmentInfo(ctx _context.Context, attachmentId string) (AttachmentMetaData, *_nethttp.Response, error)

GetAttachmentInfo Get email attachment metadata information Returns the metadata for an attachment. It is saved separately to the content of the attachment. Contains properties &#x60;name&#x60; and &#x60;content-type&#x60; and &#x60;content-length&#x60; in bytes for a given attachment.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param attachmentId ID of attachment

@return AttachmentMetaData

func (*AttachmentControllerApiService) GetAttachments 

func (a *AttachmentControllerApiService) GetAttachments(ctx _context.Context, localVarOptionals *GetAttachmentsOpts) (PageAttachmentEntity, *_nethttp.Response, error)

GetAttachments Get email attachments Get all attachments in paginated response. Each entity contains meta data for the attachment such as &#x60;name&#x60; and &#x60;content-type&#x60;. Use the &#x60;attachmentId&#x60; and the download endpoints to get the file contents.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAttachmentsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index for list pagination
  • @param "Size" (optional.Int32) - Optional page size for list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "FileNameFilter" (optional.String) - Optional file name and content type search filter
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp
  • @param "InboxId" (optional.Interface of string) - Optional inboxId to filter attachments by
  • @param "EmailId" (optional.Interface of string) - Optional emailId to filter attachments by
  • @param "SentEmailId" (optional.Interface of string) - Optional sentEmailId to filter attachments by
  • @param "Include" (optional.Interface of []string) - Optional list of IDs to include in result

@return PageAttachmentEntity

func (*AttachmentControllerApiService) UploadAttachment 

func (a *AttachmentControllerApiService) UploadAttachment(ctx _context.Context, uploadAttachmentOptions UploadAttachmentOptions) ([]string, *_nethttp.Response, error)

UploadAttachment Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param uploadAttachmentOptions

@return []string

func (*AttachmentControllerApiService) UploadAttachmentBytes 

func (a *AttachmentControllerApiService) UploadAttachmentBytes(ctx _context.Context, localVarOptionals *UploadAttachmentBytesOpts) ([]string, *_nethttp.Response, error)

UploadAttachmentBytes Upload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *UploadAttachmentBytesOpts - Optional Parameters:
  • @param "ContentType" (optional.String) -
  • @param "ContentType2" (optional.String) - Optional contentType for file. For instance `application/pdf`
  • @param "ContentId" (optional.String) - Optional content ID (CID) to save upload with
  • @param "Filename" (optional.String) - Optional filename to save upload with
  • @param "FileSize" (optional.Int64) - Optional byte length to save upload with
  • @param "Filename2" (optional.String) -

@return []string

func (*AttachmentControllerApiService) UploadMultipartForm 

func (a *AttachmentControllerApiService) UploadMultipartForm(ctx _context.Context, localVarOptionals *UploadMultipartFormOpts) ([]string, *_nethttp.Response, error)

UploadMultipartForm Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *UploadMultipartFormOpts - Optional Parameters:
  • @param "ContentId" (optional.String) - Optional content ID of attachment
  • @param "ContentType" (optional.String) - Optional content type of attachment
  • @param "Filename" (optional.String) - Optional name of file
  • @param "ContentTypeHeader" (optional.String) - Optional content type header of attachment
  • @param "XFilename" (optional.String) - Optional filename header of attachment
  • @param "XFilenameRaw" (optional.String) - Optional raw filename header of attachment that will be converted to punycode
  • @param "XFilesize" (optional.Int64) - Optional content size of attachment
  • @param "InlineObject2" (optional.Interface of InlineObject2) -

@return []string

type AttachmentEntityDto 

type AttachmentEntityDto struct {
	// The unique identifier for this attachment.
	Id string `json:"id"`
	// The identifier of the attachment file
	AttachmentId string `json:"attachmentId"`
	// The user identifier associated with this attachment.
	UserId string `json:"userId"`
	// The content type of the attachment.
	ContentType *string `json:"contentType,omitempty"`
	// The content length of the attachment in bytes.
	ContentLength *int64 `json:"contentLength,omitempty"`
	// The content identifier, which is a unique ID for the content part of the email.
	ContentId *string `json:"contentId,omitempty"`
	// The name of the attachment file.
	Name *string `json:"name,omitempty"`
	// The inbox identifier associated with this attachment.
	InboxId *string `json:"inboxId,omitempty"`
	// The timestamp when this attachment was created.
	CreatedAt time.Time `json:"createdAt"`
	// The timestamp when this attachment was last updated.
	UpdatedAt time.Time `json:"updatedAt"`
}

AttachmentEntityDto DTO representation of an attachment.

type AttachmentMetaData 

type AttachmentMetaData struct {
	// Name of attachment if given
	Name string `json:"name"`
	// Content type of attachment such as `image/png`
	ContentType string `json:"contentType"`
	// Size of attachment in bytes
	ContentLength int64 `json:"contentLength"`
	// ID of attachment. Can be used to with attachment controller endpoints to download attachment or with sending methods to attach to an email.
	Id string `json:"id"`
	// CID of attachment
	ContentId *string `json:"contentId,omitempty"`
}

AttachmentMetaData Meta data associated with an attachment. Attachments are stored as byte blobs so the meta data is stored separately.

type AttachmentProjection 

type AttachmentProjection struct {
	Name *string `json:"name,omitempty"`
	// ID
	Id string `json:"id"`
	// Content length of attachment in bytes
	ContentLength *int64 `json:"contentLength,omitempty"`
	UserId        string `json:"userId"`
	// Inbox ID
	InboxId   string    `json:"inboxId,omitempty"`
	UpdatedAt time.Time `json:"updatedAt"`
	CreatedAt time.Time `json:"createdAt"`
	// Content ID of attachment.
	ContentId *string `json:"contentId,omitempty"`
	// Attachment ID
	AttachmentId string `json:"attachmentId"`
	// Content type of attachment.
	ContentType *string `json:"contentType,omitempty"`
}

AttachmentProjection Email attachment data

type AuditLogEventDto 

type AuditLogEventDto struct {
	TenantId     string    `json:"tenantId"`
	Dt           string    `json:"dt,omitempty"`
	EventId      string    `json:"eventId"`
	EventTs      time.Time `json:"eventTs"`
	Action       string    `json:"action"`
	UserId       string    `json:"userId,omitempty"`
	ActorUserId  string    `json:"actorUserId,omitempty"`
	TargetUserId string    `json:"targetUserId,omitempty"`
	ResourceType string    `json:"resourceType,omitempty"`
	ResourceId   string    `json:"resourceId,omitempty"`
	Outcome      string    `json:"outcome,omitempty"`
	RequestId    string    `json:"requestId,omitempty"`
	IpAddress    string    `json:"ipAddress,omitempty"`
	MetadataJson string    `json:"metadataJson,omitempty"`
}

AuditLogEventDto struct for AuditLogEventDto

type AuditLogPageDto 

type AuditLogPageDto struct {
	Items      []AuditLogEventDto `json:"items"`
	NextCursor string             `json:"nextCursor,omitempty"`
}

AuditLogPageDto struct for AuditLogPageDto

type AuditLogSearchOptions 

type AuditLogSearchOptions struct {
	Since        time.Time `json:"since,omitempty"`
	Before       time.Time `json:"before,omitempty"`
	Action       string    `json:"action,omitempty"`
	UserId       string    `json:"userId,omitempty"`
	ActorUserId  string    `json:"actorUserId,omitempty"`
	TargetUserId string    `json:"targetUserId,omitempty"`
	ResourceType string    `json:"resourceType,omitempty"`
	ResourceId   string    `json:"resourceId,omitempty"`
	Outcome      string    `json:"outcome,omitempty"`
	RequestId    string    `json:"requestId,omitempty"`
	IpAddress    string    `json:"ipAddress,omitempty"`
	EventId      string    `json:"eventId,omitempty"`
	PageSize     int32     `json:"pageSize,omitempty"`
	Cursor       string    `json:"cursor,omitempty"`
}

AuditLogSearchOptions struct for AuditLogSearchOptions

type AvailablePhoneNumberDto 

type AvailablePhoneNumberDto struct {
	PhoneNumber       string `json:"phoneNumber"`
	PhoneCountry      string `json:"phoneCountry"`
	PhoneVariant      string `json:"phoneVariant,omitempty"`
	LineType          string `json:"lineType,omitempty"`
	CarrierName       string `json:"carrierName,omitempty"`
	MobileCountryCode string `json:"mobileCountryCode,omitempty"`
	MobileNetworkCode string `json:"mobileNetworkCode,omitempty"`
	ProviderLabel     string `json:"providerLabel,omitempty"`
}

AvailablePhoneNumberDto struct for AvailablePhoneNumberDto

type AvailablePhoneNumbersResult 

type AvailablePhoneNumbersResult struct {
	Count   int32                     `json:"count"`
	Items   []AvailablePhoneNumberDto `json:"items"`
	Warning string                    `json:"warning,omitempty"`
}

AvailablePhoneNumbersResult struct for AvailablePhoneNumbersResult

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BasicAuthOptions 

type BasicAuthOptions struct {
	Username string `json:"username"`
	Password string `json:"password"`
}

BasicAuthOptions Basic Authentication options for webhooks. Will be used is present when calling webhook endpoints.

type BounceControllerApiService 

type BounceControllerApiService service

BounceControllerApiService BounceControllerApi service

func (*BounceControllerApiService) FilterBouncedRecipient 

func (a *BounceControllerApiService) FilterBouncedRecipient(ctx _context.Context, filterBouncedRecipientsOptions FilterBouncedRecipientsOptions) (FilterBouncedRecipientsResult, *_nethttp.Response, error)

FilterBouncedRecipient Filter a list of email recipients and remove those who have bounced Prevent email sending errors by remove recipients who have resulted in past email bounces or complaints

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param filterBouncedRecipientsOptions

@return FilterBouncedRecipientsResult

func (*BounceControllerApiService) GetAccountBounceBlockStatus 

func (a *BounceControllerApiService) GetAccountBounceBlockStatus(ctx _context.Context) (AccountBounceBlockDto, *_nethttp.Response, error)

GetAccountBounceBlockStatus Can account send email Check if account block status prevents sending

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return AccountBounceBlockDto

func (*BounceControllerApiService) GetBouncedEmail 

func (a *BounceControllerApiService) GetBouncedEmail(ctx _context.Context, id string) (BouncedEmailDto, *_nethttp.Response, error)

GetBouncedEmail Get a bounced email. Bounced emails are email you have sent that were rejected by a recipient

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of the bounced email to fetch

@return BouncedEmailDto

func (*BounceControllerApiService) GetBouncedEmails 

func (a *BounceControllerApiService) GetBouncedEmails(ctx _context.Context, localVarOptionals *GetBouncedEmailsOpts) (PageBouncedEmail, *_nethttp.Response, error)

GetBouncedEmails Get paginated list of bounced emails. Bounced emails are email you have sent that were rejected by a recipient

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetBouncedEmailsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index
  • @param "Size" (optional.Int32) - Optional page size
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return PageBouncedEmail

func (*BounceControllerApiService) GetBouncedRecipient 

func (a *BounceControllerApiService) GetBouncedRecipient(ctx _context.Context, id string) (BouncedRecipientDto, *_nethttp.Response, error)

GetBouncedRecipient Get a bounced email. Bounced emails are email you have sent that were rejected by a recipient

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of the bounced recipient

@return BouncedRecipientDto

func (*BounceControllerApiService) GetBouncedRecipients 

func (a *BounceControllerApiService) GetBouncedRecipients(ctx _context.Context, localVarOptionals *GetBouncedRecipientsOpts) (PageBouncedRecipients, *_nethttp.Response, error)

GetBouncedRecipients Get paginated list of bounced recipients. Bounced recipients are email addresses that you have sent emails to that did not accept the sent email. Once a recipient is bounced you cannot send emails to that address.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetBouncedRecipientsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index
  • @param "Size" (optional.Int32) - Optional page size
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return PageBouncedRecipients

func (*BounceControllerApiService) GetComplaint 

func (a *BounceControllerApiService) GetComplaint(ctx _context.Context, id string) (Complaint, *_nethttp.Response, error)

GetComplaint Get complaint Get complaint

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of the complaint

@return Complaint

func (*BounceControllerApiService) GetComplaints 

func (a *BounceControllerApiService) GetComplaints(ctx _context.Context, localVarOptionals *GetComplaintsOpts) (PageComplaint, *_nethttp.Response, error)

GetComplaints Get paginated list of complaints. SMTP complaints made against your account

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetComplaintsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index
  • @param "Size" (optional.Int32) - Optional page size
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return PageComplaint

func (*BounceControllerApiService) GetListUnsubscribeRecipients 

func (a *BounceControllerApiService) GetListUnsubscribeRecipients(ctx _context.Context, localVarOptionals *GetListUnsubscribeRecipientsOpts) (PageListUnsubscribeRecipients, *_nethttp.Response, error)

GetListUnsubscribeRecipients Get paginated list of unsubscribed recipients. Unsubscribed recipient have unsubscribed from a mailing list for a user or domain and cannot be contacted again.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetListUnsubscribeRecipientsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index
  • @param "Size" (optional.Int32) - Optional page size
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "DomainId" (optional.Interface of string) - Filter by domainId

@return PageListUnsubscribeRecipients

func (*BounceControllerApiService) GetReputationItems 

func (a *BounceControllerApiService) GetReputationItems(ctx _context.Context, localVarOptionals *GetReputationItemsOpts) (PageReputationItems, *_nethttp.Response, error)

GetReputationItems Get paginated list of reputation items. List of complaints and bounces

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetReputationItemsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index
  • @param "Size" (optional.Int32) - Optional page size
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return PageReputationItems

func (*BounceControllerApiService) GetTenantReputationFindings 

func (a *BounceControllerApiService) GetTenantReputationFindings(ctx _context.Context, localVarOptionals *GetTenantReputationFindingsOpts) (TenantReputationFindingsDto, *_nethttp.Response, error)

GetTenantReputationFindings Get SES tenant reputation findings Get SES tenant reputation recommendations/findings for this user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetTenantReputationFindingsOpts - Optional Parameters:
  • @param "AccountRegion" (optional.String) - Optional account region filter

@return TenantReputationFindingsDto

func (*BounceControllerApiService) GetTenantReputationStatusSummary 

func (a *BounceControllerApiService) GetTenantReputationStatusSummary(ctx _context.Context, localVarOptionals *GetTenantReputationStatusSummaryOpts) (TenantReputationStatusSummaryDto, *_nethttp.Response, error)

GetTenantReputationStatusSummary Get SES tenant status summary Get SES tenant sending and reputation status rows for this user. Includes complaint and bounce rates from CloudWatch.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetTenantReputationStatusSummaryOpts - Optional Parameters:
  • @param "AccountRegion" (optional.String) - Optional account region filter

@return TenantReputationStatusSummaryDto

type BounceProjection 

type BounceProjection struct {
	Id         string    `json:"id,omitempty"`
	Subject    *string   `json:"subject,omitempty"`
	Sender     string    `json:"sender"`
	CreatedAt  time.Time `json:"createdAt"`
	BounceType *string   `json:"bounceType,omitempty"`
	BounceMta  *string   `json:"bounceMta,omitempty"`
}

BounceProjection Bounced email event

type BounceRecipientProjection 

type BounceRecipientProjection struct {
	Id          string    `json:"id,omitempty"`
	Status      *string   `json:"status,omitempty"`
	SentEmailId *string   `json:"sentEmailId,omitempty"`
	CreatedAt   time.Time `json:"createdAt"`
	Recipient   string    `json:"recipient"`
	BounceType  *string   `json:"bounceType,omitempty"`
	Action      *string   `json:"action,omitempty"`
}

BounceRecipientProjection Bounced recipient

type BouncedEmailDto 

type BouncedEmailDto struct {
	Id               string    `json:"id"`
	UserId           string    `json:"userId"`
	NotificationType string    `json:"notificationType"`
	SentToRecipients *[]string `json:"sentToRecipients,omitempty"`
	Sender           string    `json:"sender"`
	BounceMta        *string   `json:"bounceMta,omitempty"`
	BounceType       *string   `json:"bounceType,omitempty"`
	BounceRecipients *[]string `json:"bounceRecipients,omitempty"`
	BounceSubType    *string   `json:"bounceSubType,omitempty"`
	SentEmailId      *string   `json:"sentEmailId,omitempty"`
	Subject          *string   `json:"subject,omitempty"`
	CreatedAt        time.Time `json:"createdAt"`
}

BouncedEmailDto Bounced email

type BouncedRecipientDto 

type BouncedRecipientDto struct {
	Id             string    `json:"id"`
	UserId         *string   `json:"userId,omitempty"`
	SentEmailId    *string   `json:"sentEmailId,omitempty"`
	Recipient      string    `json:"recipient"`
	DiagnosticCode *string   `json:"diagnosticCode,omitempty"`
	Action         *string   `json:"action,omitempty"`
	BounceType     *string   `json:"bounceType,omitempty"`
	Status         *string   `json:"status,omitempty"`
	CreatedAt      time.Time `json:"createdAt"`
}

BouncedRecipientDto Bounced recipient

type BulkActionsControllerApiService 

type BulkActionsControllerApiService service

BulkActionsControllerApiService BulkActionsControllerApi service

func (*BulkActionsControllerApiService) BulkCreateInboxes 

func (a *BulkActionsControllerApiService) BulkCreateInboxes(ctx _context.Context, count int32) ([]InboxDto, *_nethttp.Response, error)

BulkCreateInboxes Bulk create Inboxes (email addresses)

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param count Number of inboxes to be created in bulk

@return []InboxDto

func (*BulkActionsControllerApiService) BulkDeleteInboxes 

func (a *BulkActionsControllerApiService) BulkDeleteInboxes(ctx _context.Context, requestBody []string) (*_nethttp.Response, error)

BulkDeleteInboxes Bulk Delete Inboxes

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param requestBody

func (*BulkActionsControllerApiService) BulkSendEmails 

func (a *BulkActionsControllerApiService) BulkSendEmails(ctx _context.Context, bulkSendEmailOptions BulkSendEmailOptions) (*_nethttp.Response, error)

BulkSendEmails Bulk Send Emails

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param bulkSendEmailOptions

type BulkSendEmailOptions 

type BulkSendEmailOptions struct {
	// Inboxes to send the email from
	InboxIds         []string         `json:"inboxIds"`
	SendEmailOptions SendEmailOptions `json:"sendEmailOptions"`
}

BulkSendEmailOptions Options for bulk sending an email from multiple addresses. See regular `sendEmail` methods for more information.

type CampaignProbeControllerApiService 

type CampaignProbeControllerApiService service

CampaignProbeControllerApiService CampaignProbeControllerApi service

func (*CampaignProbeControllerApiService) CompareCampaignProbeRuns 

func (a *CampaignProbeControllerApiService) CompareCampaignProbeRuns(ctx _context.Context, probeId string, runId string, otherRunId string) (CampaignProbeRunComparisonDto, *_nethttp.Response, error)

CompareCampaignProbeRuns Compare two campaign probe runs

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param probeId
  • @param runId
  • @param otherRunId

@return CampaignProbeRunComparisonDto

func (*CampaignProbeControllerApiService) CreateCampaignProbe 

func (a *CampaignProbeControllerApiService) CreateCampaignProbe(ctx _context.Context, createCampaignProbeOptions CreateCampaignProbeOptions) (CampaignProbeDto, *_nethttp.Response, error)

CreateCampaignProbe Create campaign probe

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createCampaignProbeOptions

@return CampaignProbeDto

func (*CampaignProbeControllerApiService) DeleteCampaignProbe 

func (a *CampaignProbeControllerApiService) DeleteCampaignProbe(ctx _context.Context, probeId string) (*_nethttp.Response, error)

DeleteCampaignProbe Delete campaign probe

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param probeId

func (*CampaignProbeControllerApiService) GetCampaignProbe 

func (a *CampaignProbeControllerApiService) GetCampaignProbe(ctx _context.Context, probeId string) (CampaignProbeDto, *_nethttp.Response, error)

GetCampaignProbe Get campaign probe

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param probeId

@return CampaignProbeDto

func (*CampaignProbeControllerApiService) GetCampaignProbeInsights 

func (a *CampaignProbeControllerApiService) GetCampaignProbeInsights(ctx _context.Context, probeId string, localVarOptionals *GetCampaignProbeInsightsOpts) (CampaignProbeInsightsDto, *_nethttp.Response, error)

GetCampaignProbeInsights Get campaign probe insights

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param probeId
  • @param optional nil or *GetCampaignProbeInsightsOpts - Optional Parameters:
  • @param "Since" (optional.Time) -
  • @param "Before" (optional.Time) -

@return CampaignProbeInsightsDto

func (*CampaignProbeControllerApiService) GetCampaignProbeRun 

func (a *CampaignProbeControllerApiService) GetCampaignProbeRun(ctx _context.Context, probeId string, runId string) (CampaignProbeRunDto, *_nethttp.Response, error)

GetCampaignProbeRun Get campaign probe run

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param probeId
  • @param runId

@return CampaignProbeRunDto

func (*CampaignProbeControllerApiService) GetCampaignProbeRuns 

func (a *CampaignProbeControllerApiService) GetCampaignProbeRuns(ctx _context.Context, probeId string, localVarOptionals *GetCampaignProbeRunsOpts) ([]CampaignProbeRunDto, *_nethttp.Response, error)

GetCampaignProbeRuns List campaign probe runs

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param probeId
  • @param optional nil or *GetCampaignProbeRunsOpts - Optional Parameters:
  • @param "Since" (optional.Time) -
  • @param "Before" (optional.Time) -
  • @param "Status" (optional.String) -
  • @param "Limit" (optional.Int32) -

@return []CampaignProbeRunDto

func (*CampaignProbeControllerApiService) GetCampaignProbeSeries 

func (a *CampaignProbeControllerApiService) GetCampaignProbeSeries(ctx _context.Context, probeId string, localVarOptionals *GetCampaignProbeSeriesOpts) (CampaignProbeSeriesDto, *_nethttp.Response, error)

GetCampaignProbeSeries Get campaign probe trend series

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param probeId
  • @param optional nil or *GetCampaignProbeSeriesOpts - Optional Parameters:
  • @param "Since" (optional.Time) -
  • @param "Before" (optional.Time) -
  • @param "Bucket" (optional.String) -

@return CampaignProbeSeriesDto

func (*CampaignProbeControllerApiService) GetCampaignProbes 

func (a *CampaignProbeControllerApiService) GetCampaignProbes(ctx _context.Context) ([]CampaignProbeDto, *_nethttp.Response, error)

GetCampaignProbes List campaign probes

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []CampaignProbeDto

func (*CampaignProbeControllerApiService) RunCampaignProbeNow 

func (a *CampaignProbeControllerApiService) RunCampaignProbeNow(ctx _context.Context, probeId string, createCampaignProbeRunOptions CreateCampaignProbeRunOptions) (CampaignProbeRunNowResult, *_nethttp.Response, error)

RunCampaignProbeNow Run campaign probe now

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param probeId
  • @param createCampaignProbeRunOptions

@return CampaignProbeRunNowResult

func (*CampaignProbeControllerApiService) RunDueCampaignProbes 

func (a *CampaignProbeControllerApiService) RunDueCampaignProbes(ctx _context.Context, localVarOptionals *RunDueCampaignProbesOpts) (CampaignProbeRunDueResult, *_nethttp.Response, error)

RunDueCampaignProbes Run due campaign probes for user

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *RunDueCampaignProbesOpts - Optional Parameters:
  • @param "MaxRuns" (optional.Int32) -

@return CampaignProbeRunDueResult

func (*CampaignProbeControllerApiService) UpdateCampaignProbe 

func (a *CampaignProbeControllerApiService) UpdateCampaignProbe(ctx _context.Context, probeId string, updateCampaignProbeOptions UpdateCampaignProbeOptions) (CampaignProbeDto, *_nethttp.Response, error)

UpdateCampaignProbe Update campaign probe

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param probeId
  • @param updateCampaignProbeOptions

@return CampaignProbeDto

type CampaignProbeDto 

type CampaignProbeDto struct {
	Id                string    `json:"id"`
	UserId            string    `json:"userId"`
	Name              string    `json:"name,omitempty"`
	LocalPart         string    `json:"localPart"`
	EmailAddress      string    `json:"emailAddress"`
	Enabled           bool      `json:"enabled"`
	IntervalSeconds   int64     `json:"intervalSeconds,omitempty"`
	SchedulingEnabled bool      `json:"schedulingEnabled"`
	NextRunAt         time.Time `json:"nextRunAt,omitempty"`
	LastRunStatus     string    `json:"lastRunStatus,omitempty"`
	LastHealthScore   int32     `json:"lastHealthScore,omitempty"`
	LastIngestAt      time.Time `json:"lastIngestAt,omitempty"`
	TotalIngestCount  int64     `json:"totalIngestCount"`
	CreatedAt         time.Time `json:"createdAt"`
	UpdatedAt         time.Time `json:"updatedAt"`
}

CampaignProbeDto struct for CampaignProbeDto

type CampaignProbeInsightsDto 

type CampaignProbeInsightsDto struct {
	ProbeId                string              `json:"probeId"`
	Since                  time.Time           `json:"since"`
	Before                 time.Time           `json:"before"`
	TotalRuns              int32               `json:"totalRuns"`
	HealthyRuns            int32               `json:"healthyRuns"`
	WarningRuns            int32               `json:"warningRuns"`
	FailedRuns             int32               `json:"failedRuns"`
	SuccessRate            float64             `json:"successRate"`
	AverageHealthScore     float64             `json:"averageHealthScore"`
	CurrentHealthyStreak   int32               `json:"currentHealthyStreak"`
	BestHealthyStreak      int32               `json:"bestHealthyStreak"`
	GoodPerformanceSignals []string            `json:"goodPerformanceSignals"`
	AttentionSignals       []string            `json:"attentionSignals"`
	TopFindings            []string            `json:"topFindings"`
	LatestRun              CampaignProbeRunDto `json:"latestRun,omitempty"`
}

CampaignProbeInsightsDto struct for CampaignProbeInsightsDto

type CampaignProbeRunComparisonDto 

type CampaignProbeRunComparisonDto struct {
	Baseline                       CampaignProbeRunDto `json:"baseline"`
	Current                        CampaignProbeRunDto `json:"current"`
	HealthScoreDelta               int32               `json:"healthScoreDelta"`
	StatusChanged                  bool                `json:"statusChanged"`
	LinkIssueDelta                 int32               `json:"linkIssueDelta"`
	ImageIssueDelta                int32               `json:"imageIssueDelta"`
	CompatibilityWarningDelta      int32               `json:"compatibilityWarningDelta"`
	CompatibilityNotSupportedDelta int32               `json:"compatibilityNotSupportedDelta"`
	HtmlErrorDelta                 int32               `json:"htmlErrorDelta"`
	HtmlWarningDelta               int32               `json:"htmlWarningDelta"`
	ReputationFailureDelta         int32               `json:"reputationFailureDelta"`
	AttachmentMentionIssueDelta    int32               `json:"attachmentMentionIssueDelta"`
	AddedInsights                  []string            `json:"addedInsights"`
	RemovedInsights                []string            `json:"removedInsights"`
}

CampaignProbeRunComparisonDto struct for CampaignProbeRunComparisonDto

type CampaignProbeRunDto 

type CampaignProbeRunDto struct {
	Id                             string    `json:"id"`
	ProbeId                        string    `json:"probeId"`
	UserId                         string    `json:"userId"`
	Status                         string    `json:"status"`
	Source                         string    `json:"source"`
	HealthScore                    int32     `json:"healthScore"`
	TotalChecks                    int32     `json:"totalChecks"`
	PassingChecks                  int32     `json:"passingChecks"`
	FailingChecks                  int32     `json:"failingChecks"`
	CheckedLinks                   int32     `json:"checkedLinks"`
	CheckedImages                  int32     `json:"checkedImages"`
	LinkIssueCount                 int32     `json:"linkIssueCount"`
	ImageIssueCount                int32     `json:"imageIssueCount"`
	CompatibilityWarningCount      int32     `json:"compatibilityWarningCount"`
	CompatibilityNotSupportedCount int32     `json:"compatibilityNotSupportedCount"`
	CompatibilityUnknownCount      int32     `json:"compatibilityUnknownCount"`
	HtmlErrorCount                 int32     `json:"htmlErrorCount"`
	HtmlWarningCount               int32     `json:"htmlWarningCount"`
	HtmlInfoCount                  int32     `json:"htmlInfoCount"`
	ReputationFailureCount         int32     `json:"reputationFailureCount"`
	AttachmentMentionIssueCount    int32     `json:"attachmentMentionIssueCount"`
	Insights                       []string  `json:"insights"`
	ErrorMessage                   string    `json:"errorMessage,omitempty"`
	FromAddress                    string    `json:"fromAddress,omitempty"`
	Recipient                      string    `json:"recipient,omitempty"`
	Subject                        string    `json:"subject,omitempty"`
	MessageId                      string    `json:"messageId,omitempty"`
	SourceMessageId                string    `json:"sourceMessageId,omitempty"`
	ProcessingMs                   int64     `json:"processingMs,omitempty"`
	CreatedAt                      time.Time `json:"createdAt"`
	UpdatedAt                      time.Time `json:"updatedAt"`
}

CampaignProbeRunDto struct for CampaignProbeRunDto

type CampaignProbeRunDueResult 

type CampaignProbeRunDueResult struct {
	TriggerSource    string    `json:"triggerSource"`
	RunCount         int32     `json:"runCount"`
	DueProbeCount    int32     `json:"dueProbeCount"`
	SkippedCount     int32     `json:"skippedCount"`
	RequestedMaxRuns int32     `json:"requestedMaxRuns"`
	ExecutedAt       time.Time `json:"executedAt"`
}

CampaignProbeRunDueResult struct for CampaignProbeRunDueResult

type CampaignProbeRunNowResult 

type CampaignProbeRunNowResult struct {
	Probe CampaignProbeDto    `json:"probe"`
	Run   CampaignProbeRunDto `json:"run"`
}

CampaignProbeRunNowResult struct for CampaignProbeRunNowResult

type CampaignProbeSeriesDto 

type CampaignProbeSeriesDto struct {
	ProbeId string                        `json:"probeId"`
	Since   time.Time                     `json:"since"`
	Before  time.Time                     `json:"before"`
	Bucket  string                        `json:"bucket"`
	Points  []CampaignProbeSeriesPointDto `json:"points"`
}

CampaignProbeSeriesDto struct for CampaignProbeSeriesDto

type CampaignProbeSeriesPointDto 

type CampaignProbeSeriesPointDto struct {
	BucketStart        time.Time `json:"bucketStart"`
	RunCount           int32     `json:"runCount"`
	HealthyCount       int32     `json:"healthyCount"`
	WarningCount       int32     `json:"warningCount"`
	FailedCount        int32     `json:"failedCount"`
	HealthyRate        float64   `json:"healthyRate"`
	AverageHealthScore float64   `json:"averageHealthScore"`
}

CampaignProbeSeriesPointDto struct for CampaignProbeSeriesPointDto

type CanSendEmailResults 

type CanSendEmailResults struct {
	IsSendingPermitted bool   `json:"isSendingPermitted"`
	Message            string `json:"message,omitempty"`
}

CanSendEmailResults struct for CanSendEmailResults

type CancelDevicePreviewRunOptions 

type CancelDevicePreviewRunOptions struct {
	Reason string `json:"reason,omitempty"`
}

CancelDevicePreviewRunOptions struct for CancelDevicePreviewRunOptions

type CancelDevicePreviewRunOpts 

type CancelDevicePreviewRunOpts struct {
	CancelDevicePreviewRunOptions optional.Interface
}

CancelDevicePreviewRunOpts Optional parameters for the method 'CancelDevicePreviewRun'

type CancelDevicePreviewRunResult 

type CancelDevicePreviewRunResult struct {
	Run                   DevicePreviewRunDto `json:"run"`
	RemoteCancelAttempted bool                `json:"remoteCancelAttempted"`
	RemoteCancelAccepted  bool                `json:"remoteCancelAccepted"`
	Warning               string              `json:"warning,omitempty"`
}

CancelDevicePreviewRunResult struct for CancelDevicePreviewRunResult

type CheckCampaignProbeOptions 

type CheckCampaignProbeOptions struct {
	// Optional sender email address
	FromAddress *string `json:"fromAddress,omitempty"`
	// Optional message subject
	Subject *string `json:"subject,omitempty"`
	// Optional recipient email address for context
	Recipient *string `json:"recipient,omitempty"`
	// Optional caller supplied message id
	MessageId *string `json:"messageId,omitempty"`
	// HTML body content to analyze
	HtmlBody *string `json:"htmlBody,omitempty"`
	// Text body content to analyze when HTML is absent
	TextBody *string `json:"textBody,omitempty"`
	// Optional captcha token when captcha protection is enabled
	CaptchaToken *string `json:"captchaToken,omitempty"`
}

CheckCampaignProbeOptions One-shot public campaign probe preflight check options

type CheckCampaignProbeResults 

type CheckCampaignProbeResults struct {
	Status                         string   `json:"status"`
	HealthScore                    int32    `json:"healthScore"`
	TotalChecks                    int32    `json:"totalChecks"`
	PassingChecks                  int32    `json:"passingChecks"`
	FailingChecks                  int32    `json:"failingChecks"`
	CheckedLinks                   int32    `json:"checkedLinks"`
	CheckedImages                  int32    `json:"checkedImages"`
	LinkIssueCount                 int32    `json:"linkIssueCount"`
	ImageIssueCount                int32    `json:"imageIssueCount"`
	CompatibilityWarningCount      int32    `json:"compatibilityWarningCount"`
	CompatibilityNotSupportedCount int32    `json:"compatibilityNotSupportedCount"`
	CompatibilityUnknownCount      int32    `json:"compatibilityUnknownCount"`
	HtmlErrorCount                 int32    `json:"htmlErrorCount"`
	HtmlWarningCount               int32    `json:"htmlWarningCount"`
	HtmlInfoCount                  int32    `json:"htmlInfoCount"`
	AttachmentMentionIssueCount    int32    `json:"attachmentMentionIssueCount"`
	Insights                       []string `json:"insights"`
	ErrorMessage                   *string  `json:"errorMessage,omitempty"`
}

CheckCampaignProbeResults One-shot public campaign probe preflight results

type CheckDnsPropagationOptions 

type CheckDnsPropagationOptions struct {
	Host string `json:"host"`
	// Domain Name Server Record Types
	RecordType    string `json:"recordType"`
	ExpectedValue string `json:"expectedValue,omitempty"`
	CaptchaToken  string `json:"captchaToken,omitempty"`
}

CheckDnsPropagationOptions struct for CheckDnsPropagationOptions

type CheckDnsPropagationResults 

type CheckDnsPropagationResults struct {
	Host string `json:"host"`
	// Domain Name Server Record Types
	RecordType               string                         `json:"recordType"`
	ExpectedValue            *string                        `json:"expectedValue,omitempty"`
	PropagatedToAllResolvers bool                           `json:"propagatedToAllResolvers"`
	RespondingResolverCount  int32                          `json:"respondingResolverCount"`
	MatchingResolverCount    int32                          `json:"matchingResolverCount"`
	ResolverResults          []DnsPropagationResolverResult `json:"resolverResults"`
	Warnings                 []string                       `json:"warnings"`
	Errors                   []string                       `json:"errors"`
}

CheckDnsPropagationResults DNS propagation status across configured resolvers

type CheckDomainMonitorOptions 

type CheckDomainMonitorOptions struct {
	// Domain to evaluate
	Domain string `json:"domain"`
	// Optional captcha token when captcha protection is enabled
	CaptchaToken *string `json:"captchaToken,omitempty"`
}

CheckDomainMonitorOptions One-shot public domain monitor check options

type CheckDomainMonitorResults 

type CheckDomainMonitorResults struct {
	Domain        string   `json:"domain"`
	Status        string   `json:"status"`
	HealthScore   int32    `json:"healthScore"`
	TotalChecks   int32    `json:"totalChecks"`
	PassingChecks int32    `json:"passingChecks"`
	FailingChecks int32    `json:"failingChecks"`
	SpfOk         bool     `json:"spfOk"`
	DmarcOk       bool     `json:"dmarcOk"`
	DmarcEnforced bool     `json:"dmarcEnforced"`
	MxOk          bool     `json:"mxOk"`
	Insights      []string `json:"insights"`
	ErrorMessage  *string  `json:"errorMessage,omitempty"`
}

CheckDomainMonitorResults One-shot public domain monitor check results

type CheckEmailAuditOptions 

type CheckEmailAuditOptions struct {
	// Optional sender address context
	FromAddress *string `json:"fromAddress,omitempty"`
	// Optional recipient context
	Recipient *string `json:"recipient,omitempty"`
	// Optional subject line context
	Subject *string `json:"subject,omitempty"`
	// Optional HTML email body
	HtmlBody *string `json:"htmlBody,omitempty"`
	// Optional text email body
	TextBody      *string        `json:"textBody,omitempty"`
	EmailAnalysis *EmailAnalysis `json:"emailAnalysis,omitempty"`
	// Whether the source email included attachments
	HasAttachments *bool `json:"hasAttachments,omitempty"`
	// Optional captcha token for abuse protection
	CaptchaToken *string `json:"captchaToken,omitempty"`
}

CheckEmailAuditOptions Anonymous one-shot email audit request

type CheckEmailAuthStackOptions 

type CheckEmailAuthStackOptions struct {
	Domain       string `json:"domain"`
	DkimSelector string `json:"dkimSelector,omitempty"`
	CaptchaToken string `json:"captchaToken,omitempty"`
}

CheckEmailAuthStackOptions struct for CheckEmailAuthStackOptions

type CheckEmailAuthStackResults 

type CheckEmailAuthStackResults struct {
	Domain        string                          `json:"domain"`
	Status        string                          `json:"status"`
	HealthScore   int32                           `json:"healthScore"`
	TotalChecks   int32                           `json:"totalChecks"`
	PassingChecks int32                           `json:"passingChecks"`
	FailingChecks int32                           `json:"failingChecks"`
	Spf           LookupSpfDomainResults          `json:"spf"`
	Dmarc         LookupDmarcDomainResults        `json:"dmarc"`
	Dkim          LookupDkimDomainResults         `json:"dkim"`
	Bimi          LookupBimiDomainResults         `json:"bimi"`
	Mx            LookupMxRecordsResults          `json:"mx"`
	MtaSts        LookupMtaStsDomainResults       `json:"mtaSts"`
	TlsReporting  LookupTlsReportingDomainResults `json:"tlsReporting"`
	Insights      []string                        `json:"insights"`
	Warnings      []string                        `json:"warnings"`
	Errors        []string                        `json:"errors"`
}

CheckEmailAuthStackResults Combined authentication and deliverability DNS results for a domain

type CheckEmailBlacklistOptions 

type CheckEmailBlacklistOptions struct {
	// Domain to expand into A and MX host IPv4 addresses
	Domain *string `json:"domain,omitempty"`
	// Specific IPv4 address to check directly
	IpAddress *string `json:"ipAddress,omitempty"`
	// Specific MX host to resolve and check directly
	MxHost       *string `json:"mxHost,omitempty"`
	CaptchaToken *string `json:"captchaToken,omitempty"`
}

CheckEmailBlacklistOptions Check a domain, IP address, or specific MX host against configured DNS blacklists

type CheckEmailBlacklistResults 

type CheckEmailBlacklistResults struct {
	Domain             *string                  `json:"domain,omitempty"`
	RequestedIpAddress *string                  `json:"requestedIpAddress,omitempty"`
	RequestedMxHost    *string                  `json:"requestedMxHost,omitempty"`
	Status             string                   `json:"status"`
	Listed             bool                     `json:"listed"`
	CheckedIpAddresses []EmailBlacklistIpResult `json:"checkedIpAddresses"`
	CheckedZoneCount   int32                    `json:"checkedZoneCount"`
	TotalListings      int32                    `json:"totalListings"`
	Warnings           []string                 `json:"warnings"`
	Errors             []string                 `json:"errors"`
}

CheckEmailBlacklistResults Public blacklist lookup results for a domain or IP address

type CheckEmailBodyFeatureSupportResults 

type CheckEmailBodyFeatureSupportResults struct {
	Result EmailFeatureSupportResult `json:"result"`
}

CheckEmailBodyFeatureSupportResults struct for CheckEmailBodyFeatureSupportResults

type CheckEmailBodyResults 

type CheckEmailBodyResults struct {
	HasIssues      bool            `json:"hasIssues"`
	LinkIssues     []LinkIssue     `json:"linkIssues"`
	ImageIssues    []ImageIssue    `json:"imageIssues"`
	SpellingIssues []SpellingIssue `json:"spellingIssues"`
}

CheckEmailBodyResults struct for CheckEmailBodyResults

type CheckEmailClientSupportOptions 

type CheckEmailClientSupportOptions struct {
	EmailBody string `json:"emailBody"`
}

CheckEmailClientSupportOptions Options for the email to be validated

type CheckEmailClientSupportResults 

type CheckEmailClientSupportResults struct {
	Result EmailFeatureSupportResult `json:"result"`
}

CheckEmailClientSupportResults struct for CheckEmailClientSupportResults

type CheckEmailFeaturesClientSupportOptions 

type CheckEmailFeaturesClientSupportOptions struct {
	EmailBody string `json:"emailBody"`
}

CheckEmailFeaturesClientSupportOptions struct for CheckEmailFeaturesClientSupportOptions

type CheckEmailFeaturesClientSupportResults 

type CheckEmailFeaturesClientSupportResults struct {
	Result EmailFeatureSupportResult `json:"result"`
}

CheckEmailFeaturesClientSupportResults struct for CheckEmailFeaturesClientSupportResults

type CodeCandidate 

type CodeCandidate struct {
	// Extracted code value
	Code string `json:"code"`
	// Relative confidence score from 0 to 1
	Confidence float64 `json:"confidence"`
	// Extraction strategy for verification codes. Unsupported strategies may fall back when allowFallback is true.
	Method string `json:"method"`
	// Source fragment used for extraction, for example RAW_TEXT_PART or SMS_BODY
	Source string `json:"source"`
	// Nearby text context useful for debugging extraction decisions
	Context *string `json:"context,omitempty"`
}

CodeCandidate Candidate verification code extracted from content

type CommonActionsControllerApiService 

type CommonActionsControllerApiService service

CommonActionsControllerApiService CommonActionsControllerApi service

func (*CommonActionsControllerApiService) CreateNewEmailAddress 

func (a *CommonActionsControllerApiService) CreateNewEmailAddress(ctx _context.Context, localVarOptionals *CreateNewEmailAddressOpts) (InboxDto, *_nethttp.Response, error)

CreateNewEmailAddress Create new random inbox Returns an Inbox with an &#x60;id&#x60; and an &#x60;emailAddress&#x60;

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *CreateNewEmailAddressOpts - Optional Parameters:
  • @param "AllowTeamAccess" (optional.Bool) -
  • @param "UseDomainPool" (optional.Bool) -
  • @param "ExpiresAt" (optional.Time) -
  • @param "ExpiresIn" (optional.Int64) -
  • @param "EmailAddress" (optional.String) -
  • @param "InboxType" (optional.String) -
  • @param "Description" (optional.String) -
  • @param "Name" (optional.String) -
  • @param "Tags" (optional.Interface of []string) -
  • @param "Favourite" (optional.Bool) -
  • @param "VirtualInbox" (optional.Bool) -
  • @param "UseShortAddress" (optional.Bool) -
  • @param "DomainName" (optional.String) -
  • @param "DomainId" (optional.Interface of string) -
  • @param "Prefix" (optional.String) -

@return InboxDto

func (*CommonActionsControllerApiService) CreateRandomInbox 

func (a *CommonActionsControllerApiService) CreateRandomInbox(ctx _context.Context, localVarOptionals *CreateRandomInboxOpts) (InboxDto, *_nethttp.Response, error)

CreateRandomInbox Create new random inbox Returns an Inbox with an &#x60;id&#x60; and an &#x60;emailAddress&#x60;

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *CreateRandomInboxOpts - Optional Parameters:
  • @param "AllowTeamAccess" (optional.Bool) -
  • @param "UseDomainPool" (optional.Bool) -
  • @param "ExpiresAt" (optional.Time) -
  • @param "ExpiresIn" (optional.Int64) -
  • @param "EmailAddress" (optional.String) -
  • @param "InboxType" (optional.String) -
  • @param "Description" (optional.String) -
  • @param "Name" (optional.String) -
  • @param "Tags" (optional.Interface of []string) -
  • @param "Favourite" (optional.Bool) -
  • @param "VirtualInbox" (optional.Bool) -
  • @param "UseShortAddress" (optional.Bool) -
  • @param "DomainName" (optional.String) -
  • @param "DomainId" (optional.Interface of string) -
  • @param "Prefix" (optional.String) -

@return InboxDto

func (*CommonActionsControllerApiService) DeleteEmailAddress 

func (a *CommonActionsControllerApiService) DeleteEmailAddress(ctx _context.Context, inboxId string) (*_nethttp.Response, error)

DeleteEmailAddress Delete inbox email address by inbox id Deletes inbox email address

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId ID of inbox to delete

func (*CommonActionsControllerApiService) EmptyInbox 

func (a *CommonActionsControllerApiService) EmptyInbox(ctx _context.Context, inboxId string) (*_nethttp.Response, error)

EmptyInbox Delete all emails in an inbox Deletes all emails

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId ID of inbox to empty

func (*CommonActionsControllerApiService) SendEmailQuery 

func (a *CommonActionsControllerApiService) SendEmailQuery(ctx _context.Context, to string, localVarOptionals *SendEmailQueryOpts) (*_nethttp.Response, error)

SendEmailQuery Send an email using query parameters If no senderId or inboxId provided a random email address will be used to send from. Ensure your parameters are URL encoded.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param to Email address to send to
  • @param optional nil or *SendEmailQueryOpts - Optional Parameters:
  • @param "SenderId" (optional.Interface of string) - ID of inbox to send from. If null an inbox will be created for sending
  • @param "Body" (optional.String) - Body of the email message. Supports HTML
  • @param "Subject" (optional.String) - Subject line of the email

func (*CommonActionsControllerApiService) SendEmailSimple 

func (a *CommonActionsControllerApiService) SendEmailSimple(ctx _context.Context, simpleSendEmailOptions SimpleSendEmailOptions) (*_nethttp.Response, error)

SendEmailSimple Send an email If no senderId or inboxId provided a random email address will be used to send from.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param simpleSendEmailOptions

type Complaint 

type Complaint struct {
	Id                 string    `json:"id"`
	UserId             string    `json:"userId,omitempty"`
	EventType          string    `json:"eventType,omitempty"`
	MailSource         string    `json:"mailSource,omitempty"`
	MailMessageId      string    `json:"mailMessageId,omitempty"`
	ComplaintRecipient string    `json:"complaintRecipient"`
	CreatedAt          time.Time `json:"createdAt"`
	UpdatedAt          time.Time `json:"updatedAt"`
}

Complaint struct for Complaint

type ConditionOption 

type ConditionOption struct {
	// Condition of an email object that can be used to filter results
	Condition string `json:"condition"`
	// Expected condition value
	Value string `json:"value"`
}

ConditionOption Options for matching emails in an inbox based on a condition such as `HAS_ATTACHMENTS=TRUE`

type ConditionalStructuredContentResult 

type ConditionalStructuredContentResult struct {
	Result          *map[string]interface{} `json:"result,omitempty"`
	ConditionsMatch bool                    `json:"conditionsMatch"`
	TokenCount      int32                   `json:"tokenCount,omitempty"`
}

ConditionalStructuredContentResult struct for ConditionalStructuredContentResult

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	Debug         bool              `json:"debug,omitempty"`
	Servers       []ServerConfiguration
	HTTPClient    *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerUrl 

func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error)

ServerUrl returns URL based on server settings

type ConnectorControllerApiService 

type ConnectorControllerApiService service

ConnectorControllerApiService ConnectorControllerApi service

func (*ConnectorControllerApiService) CreateConnector 

func (a *ConnectorControllerApiService) CreateConnector(ctx _context.Context, createConnectorOptions CreateConnectorOptions, localVarOptionals *CreateConnectorOpts) (ConnectorDto, *_nethttp.Response, error)

CreateConnector Create an inbox connector Sync emails between external mailboxes and MailSlurp inboxes

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createConnectorOptions
  • @param optional nil or *CreateConnectorOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Optional inbox ID to associate with the connector

@return ConnectorDto

func (*ConnectorControllerApiService) CreateConnectorImapConnection 

func (a *ConnectorControllerApiService) CreateConnectorImapConnection(ctx _context.Context, id string, createConnectorImapConnectionOptions CreateConnectorImapConnectionOptions) (ConnectorImapConnectionDto, *_nethttp.Response, error)

CreateConnectorImapConnection Create an inbox connector IMAP connection Allows the reading of emails in an external mailbox and syncing to a MailSlurp inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param createConnectorImapConnectionOptions

@return ConnectorImapConnectionDto

func (*ConnectorControllerApiService) CreateConnectorSmtpConnection 

func (a *ConnectorControllerApiService) CreateConnectorSmtpConnection(ctx _context.Context, id string, createConnectorSmtpConnectionOptions CreateConnectorSmtpConnectionOptions) (ConnectorSmtpConnectionDto, *_nethttp.Response, error)

CreateConnectorSmtpConnection Create an inbox connector SMTP connection Allows sending via connector and email is routed to connected inbox and sent via SMTP

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param createConnectorSmtpConnectionOptions

@return ConnectorSmtpConnectionDto

func (*ConnectorControllerApiService) CreateConnectorSyncSettings 

func (a *ConnectorControllerApiService) CreateConnectorSyncSettings(ctx _context.Context, id string, createConnectorSyncSettingsOptions CreateConnectorSyncSettingsOptions) (ConnectorSyncSettingsDto, *_nethttp.Response, error)

CreateConnectorSyncSettings Create an inbox connector sync settings Configure automatic pull or emails from external inboxes using an interval or schedule

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param createConnectorSyncSettingsOptions

@return ConnectorSyncSettingsDto

func (*ConnectorControllerApiService) CreateConnectorWithOptions 

func (a *ConnectorControllerApiService) CreateConnectorWithOptions(ctx _context.Context, createConnectorWithOptions CreateConnectorWithOptions, localVarOptionals *CreateConnectorWithOptionsOpts) (ConnectorDto, *_nethttp.Response, error)

CreateConnectorWithOptions Create an inbox connector with options Sync emails between external mailboxes and MailSlurp inboxes

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createConnectorWithOptions
  • @param optional nil or *CreateConnectorWithOptionsOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Optional inbox ID to associate with the connector

@return ConnectorDto

func (*ConnectorControllerApiService) DeleteAllConnector 

func (a *ConnectorControllerApiService) DeleteAllConnector(ctx _context.Context) (*_nethttp.Response, error)

DeleteAllConnector Delete all inbox connectors

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*ConnectorControllerApiService) DeleteConnector 

func (a *ConnectorControllerApiService) DeleteConnector(ctx _context.Context, id string) (*_nethttp.Response, error)

DeleteConnector Delete an inbox connector

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

func (*ConnectorControllerApiService) DeleteConnectorImapConnection 

func (a *ConnectorControllerApiService) DeleteConnectorImapConnection(ctx _context.Context, id string) (*_nethttp.Response, error)

DeleteConnectorImapConnection Delete an inbox connector IMAP connection Delete IMAP connection for external inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

func (*ConnectorControllerApiService) DeleteConnectorSmtpConnection 

func (a *ConnectorControllerApiService) DeleteConnectorSmtpConnection(ctx _context.Context, id string) (*_nethttp.Response, error)

DeleteConnectorSmtpConnection Delete an inbox connector SMTP connection Delete SMTP connection for external inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

func (*ConnectorControllerApiService) DeleteConnectorSyncSettings 

func (a *ConnectorControllerApiService) DeleteConnectorSyncSettings(ctx _context.Context, id string) (*_nethttp.Response, error)

DeleteConnectorSyncSettings Create an inbox connector sync settings Configure automatic pull or emails from external inboxes using an interval or schedule

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

func (*ConnectorControllerApiService) GetAllConnectorEvents 

func (a *ConnectorControllerApiService) GetAllConnectorEvents(ctx _context.Context, localVarOptionals *GetAllConnectorEventsOpts) (PageConnectorEvents, *_nethttp.Response, error)

GetAllConnectorEvents Get all inbox connector events

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAllConnectorEventsOpts - Optional Parameters:
  • @param "Id" (optional.Interface of string) - Optional connector ID
  • @param "Page" (optional.Int32) - Optional page index in connector list pagination
  • @param "Size" (optional.Int32) - Optional page size in connector list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp
  • @param "EventType" (optional.String) - Filter by event type

@return PageConnectorEvents

func (*ConnectorControllerApiService) GetConnector 

func (a *ConnectorControllerApiService) GetConnector(ctx _context.Context, id string) (ConnectorDto, *_nethttp.Response, error)

GetConnector Get an inbox connector

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

@return ConnectorDto

func (*ConnectorControllerApiService) GetConnectorByEmailAddress 

func (a *ConnectorControllerApiService) GetConnectorByEmailAddress(ctx _context.Context, emailAddress string) (OptionalConnectorDto, *_nethttp.Response, error)

GetConnectorByEmailAddress Get connector by email address Find an inbox connector by email address

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailAddress Email address to search for connector by

@return OptionalConnectorDto

func (*ConnectorControllerApiService) GetConnectorByInboxId 

func (a *ConnectorControllerApiService) GetConnectorByInboxId(ctx _context.Context, inboxId string) (OptionalConnectorDto, *_nethttp.Response, error)

GetConnectorByInboxId Get connector by inbox ID Find an inbox connector by inbox ID

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId Inbox ID to search for connector by

@return OptionalConnectorDto

func (*ConnectorControllerApiService) GetConnectorByName 

func (a *ConnectorControllerApiService) GetConnectorByName(ctx _context.Context, name string) (OptionalConnectorDto, *_nethttp.Response, error)

GetConnectorByName Get connector by name Find an inbox connector by name

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name Name to search for connector by

@return OptionalConnectorDto

func (*ConnectorControllerApiService) GetConnectorEvent 

func (a *ConnectorControllerApiService) GetConnectorEvent(ctx _context.Context, id string) (ConnectorEventDto, *_nethttp.Response, error)

GetConnectorEvent Get an inbox connector event

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

@return ConnectorEventDto

func (*ConnectorControllerApiService) GetConnectorEvents 

func (a *ConnectorControllerApiService) GetConnectorEvents(ctx _context.Context, id string, localVarOptionals *GetConnectorEventsOpts) (PageConnectorEvents, *_nethttp.Response, error)

GetConnectorEvents Get an inbox connector events

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param optional nil or *GetConnectorEventsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in connector list pagination
  • @param "Size" (optional.Int32) - Optional page size in connector list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp
  • @param "EventType" (optional.String) - Filter by event type

@return PageConnectorEvents

func (*ConnectorControllerApiService) GetConnectorImapConnection 

func (a *ConnectorControllerApiService) GetConnectorImapConnection(ctx _context.Context, id string) (OptionalConnectorImapConnectionDto, *_nethttp.Response, error)

GetConnectorImapConnection Get an inbox connector IMAP connection Get IMAP connection for external inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

@return OptionalConnectorImapConnectionDto

func (*ConnectorControllerApiService) GetConnectorProviderSettings 

func (a *ConnectorControllerApiService) GetConnectorProviderSettings(ctx _context.Context) (ConnectorProviderSettingsDto, *_nethttp.Response, error)

GetConnectorProviderSettings Get SMTP and IMAP connection settings for common mail providers Get common mail provider SMTP and IMAP connection settings

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ConnectorProviderSettingsDto

func (*ConnectorControllerApiService) GetConnectorSmtpConnection 

func (a *ConnectorControllerApiService) GetConnectorSmtpConnection(ctx _context.Context, id string) (OptionalConnectorSmtpConnectionDto, *_nethttp.Response, error)

GetConnectorSmtpConnection Get an inbox connector SMTP connection Get SMTP connection for external inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

@return OptionalConnectorSmtpConnectionDto

func (*ConnectorControllerApiService) GetConnectorSyncSettings 

func (a *ConnectorControllerApiService) GetConnectorSyncSettings(ctx _context.Context, id string) (OptionalConnectorSyncSettingsDto, *_nethttp.Response, error)

GetConnectorSyncSettings Get an inbox connector sync settings Get sync settings for connection with external inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

@return OptionalConnectorSyncSettingsDto

func (*ConnectorControllerApiService) GetConnectors 

func (a *ConnectorControllerApiService) GetConnectors(ctx _context.Context, localVarOptionals *GetConnectorsOpts) (PageConnector, *_nethttp.Response, error)

GetConnectors Get inbox connectors List inbox connectors that sync external emails to MailSlurp inboxes

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetConnectorsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in connector list pagination
  • @param "Size" (optional.Int32) - Optional page size in connector list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return PageConnector

func (*ConnectorControllerApiService) SendEmailFromConnector 

func (a *ConnectorControllerApiService) SendEmailFromConnector(ctx _context.Context, id string, sendEmailOptions SendEmailOptions, localVarOptionals *SendEmailFromConnectorOpts) (SentEmailDto, *_nethttp.Response, error)

SendEmailFromConnector Send from an inbox connector

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param sendEmailOptions
  • @param optional nil or *SendEmailFromConnectorOpts - Optional Parameters:
  • @param "UseFallback" (optional.Bool) -

@return SentEmailDto

func (*ConnectorControllerApiService) SyncConnector 

func (a *ConnectorControllerApiService) SyncConnector(ctx _context.Context, id string, localVarOptionals *SyncConnectorOpts) (ConnectorSyncRequestResult, *_nethttp.Response, error)

SyncConnector Sync an inbox connector

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param optional nil or *SyncConnectorOpts - Optional Parameters:
  • @param "Since" (optional.Time) - Date to request emails since
  • @param "Folder" (optional.String) - Which folder to sync emails with
  • @param "Logging" (optional.Bool) - Enable or disable logging for the sync operation

@return ConnectorSyncRequestResult

func (*ConnectorControllerApiService) TestConnectorImapConnection 

func (a *ConnectorControllerApiService) TestConnectorImapConnection(ctx _context.Context, id string, localVarOptionals *TestConnectorImapConnectionOpts) (ConnectorImapConnectionTestResult, *_nethttp.Response, error)

TestConnectorImapConnection Test an inbox connector IMAP connection Test the IMAP connection for a connector

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param optional nil or *TestConnectorImapConnectionOpts - Optional Parameters:
  • @param "CreateConnectorImapConnectionOptions" (optional.Interface of CreateConnectorImapConnectionOptions) -

@return ConnectorImapConnectionTestResult

func (*ConnectorControllerApiService) TestConnectorImapConnectionOptions 

func (a *ConnectorControllerApiService) TestConnectorImapConnectionOptions(ctx _context.Context, createConnectorImapConnectionOptions CreateConnectorImapConnectionOptions) (ConnectorImapConnectionTestResult, *_nethttp.Response, error)

TestConnectorImapConnectionOptions Test an inbox connector IMAP connection options Test the IMAP connection options for a connector

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createConnectorImapConnectionOptions

@return ConnectorImapConnectionTestResult

func (*ConnectorControllerApiService) TestConnectorSmtpConnection 

func (a *ConnectorControllerApiService) TestConnectorSmtpConnection(ctx _context.Context, id string, localVarOptionals *TestConnectorSmtpConnectionOpts) (ConnectorSmtpConnectionTestResult, *_nethttp.Response, error)

TestConnectorSmtpConnection Test an inbox connector SMTP connection Test the SMTP connection for a connector

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param optional nil or *TestConnectorSmtpConnectionOpts - Optional Parameters:
  • @param "CreateConnectorSmtpConnectionOptions" (optional.Interface of CreateConnectorSmtpConnectionOptions) -

@return ConnectorSmtpConnectionTestResult

func (*ConnectorControllerApiService) TestConnectorSmtpConnectionOptions 

func (a *ConnectorControllerApiService) TestConnectorSmtpConnectionOptions(ctx _context.Context, createConnectorSmtpConnectionOptions CreateConnectorSmtpConnectionOptions) (ConnectorSmtpConnectionTestResult, *_nethttp.Response, error)

TestConnectorSmtpConnectionOptions Test an inbox connector SMTP connection options Test the SMTP connection options for a connector

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createConnectorSmtpConnectionOptions

@return ConnectorSmtpConnectionTestResult

func (*ConnectorControllerApiService) UpdateConnector 

func (a *ConnectorControllerApiService) UpdateConnector(ctx _context.Context, id string, createConnectorOptions CreateConnectorOptions) (ConnectorDto, *_nethttp.Response, error)

UpdateConnector Update an inbox connector

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param createConnectorOptions

@return ConnectorDto

func (*ConnectorControllerApiService) UpdateConnectorImapConnection 

func (a *ConnectorControllerApiService) UpdateConnectorImapConnection(ctx _context.Context, id string, createConnectorImapConnectionOptions CreateConnectorImapConnectionOptions) (ConnectorImapConnectionDto, *_nethttp.Response, error)

UpdateConnectorImapConnection Update an inbox connector IMAP connection Update IMAP connection for external inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param createConnectorImapConnectionOptions

@return ConnectorImapConnectionDto

func (*ConnectorControllerApiService) UpdateConnectorSmtpConnection 

func (a *ConnectorControllerApiService) UpdateConnectorSmtpConnection(ctx _context.Context, id string, createConnectorSmtpConnectionOptions CreateConnectorSmtpConnectionOptions) (ConnectorSmtpConnectionDto, *_nethttp.Response, error)

UpdateConnectorSmtpConnection Update an inbox connector SMTP connection Update SMTP connection for external inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param createConnectorSmtpConnectionOptions

@return ConnectorSmtpConnectionDto

type ConnectorDto 

type ConnectorDto struct {
	Id           string    `json:"id"`
	Name         *string   `json:"name,omitempty"`
	Enabled      bool      `json:"enabled"`
	EmailAddress *string   `json:"emailAddress,omitempty"`
	UserId       string    `json:"userId"`
	InboxId      string    `json:"inboxId"`
	CreatedAt    time.Time `json:"createdAt"`
}

ConnectorDto struct for ConnectorDto

type ConnectorEventDto 

type ConnectorEventDto struct {
	Id          string    `json:"id"`
	ConnectorId string    `json:"connectorId"`
	Status      string    `json:"status"`
	EventType   string    `json:"eventType"`
	Size        int64     `json:"size"`
	Message     string    `json:"message,omitempty"`
	Logs        string    `json:"logs,omitempty"`
	Seen        bool      `json:"seen,omitempty"`
	CreatedAt   time.Time `json:"createdAt"`
}

ConnectorEventDto struct for ConnectorEventDto

type ConnectorEventProjection 

type ConnectorEventProjection struct {
	Message     string    `json:"message,omitempty"`
	Id          string    `json:"id,omitempty"`
	Size        int64     `json:"size"`
	Status      string    `json:"status"`
	EventType   string    `json:"eventType"`
	CreatedAt   time.Time `json:"createdAt"`
	ConnectorId string    `json:"connectorId"`
	Seen        bool      `json:"seen,omitempty"`
}

ConnectorEventProjection ConnectorEventProjection

type ConnectorImapConnectionDto 

type ConnectorImapConnectionDto struct {
	ConnectorId   string    `json:"connectorId"`
	ImapHost      string    `json:"imapHost"`
	ImapPort      int32     `json:"imapPort,omitempty"`
	ImapUsername  string    `json:"imapUsername,omitempty"`
	ImapPassword  string    `json:"imapPassword,omitempty"`
	ImapSsl       bool      `json:"imapSsl,omitempty"`
	SelectFolder  string    `json:"selectFolder,omitempty"`
	SearchTerms   string    `json:"searchTerms,omitempty"`
	StartTls      bool      `json:"startTls,omitempty"`
	ProxyHost     string    `json:"proxyHost,omitempty"`
	ProxyPort     int32     `json:"proxyPort,omitempty"`
	ProxyEnabled  bool      `json:"proxyEnabled,omitempty"`
	LocalHostName string    `json:"localHostName,omitempty"`
	Mechanisms    []string  `json:"mechanisms,omitempty"`
	SslProtocols  []string  `json:"sslProtocols,omitempty"`
	SslTrust      string    `json:"sslTrust,omitempty"`
	Enabled       bool      `json:"enabled,omitempty"`
	CreatedAt     time.Time `json:"createdAt"`
	Id            string    `json:"id"`
}

ConnectorImapConnectionDto struct for ConnectorImapConnectionDto

type ConnectorImapConnectionTestResult 

type ConnectorImapConnectionTestResult struct {
	Error   string   `json:"error,omitempty"`
	Success bool     `json:"success"`
	Message string   `json:"message,omitempty"`
	Logs    []string `json:"logs,omitempty"`
}

ConnectorImapConnectionTestResult struct for ConnectorImapConnectionTestResult

type ConnectorProjection 

type ConnectorProjection struct {
	Name         string    `json:"name,omitempty"`
	Id           string    `json:"id"`
	Enabled      bool      `json:"enabled,omitempty"`
	UserId       string    `json:"userId"`
	EmailAddress string    `json:"emailAddress,omitempty"`
	InboxId      string    `json:"inboxId"`
	CreatedAt    time.Time `json:"createdAt"`
}

ConnectorProjection Connector

type ConnectorProviderSettingsDto 

type ConnectorProviderSettingsDto struct {
	GoogleSettings    ProviderSettings `json:"googleSettings"`
	MicrosoftSettings ProviderSettings `json:"microsoftSettings"`
}

ConnectorProviderSettingsDto struct for ConnectorProviderSettingsDto

type ConnectorSmtpConnectionDto 

type ConnectorSmtpConnectionDto struct {
	ConnectorId    string    `json:"connectorId"`
	SmtpHost       string    `json:"smtpHost"`
	SmtpPort       *int32    `json:"smtpPort,omitempty"`
	SmtpUsername   *string   `json:"smtpUsername,omitempty"`
	SmtpPassword   *string   `json:"smtpPassword,omitempty"`
	SmtpSsl        *bool     `json:"smtpSsl,omitempty"`
	StartTls       *bool     `json:"startTls,omitempty"`
	SmtpMechanisms *[]string `json:"smtpMechanisms,omitempty"`
	LocalHostName  *string   `json:"localHostName,omitempty"`
	ProxyHost      *string   `json:"proxyHost,omitempty"`
	ProxyPort      *int32    `json:"proxyPort,omitempty"`
	ProxyEnabled   *bool     `json:"proxyEnabled,omitempty"`
	Enabled        *bool     `json:"enabled,omitempty"`
	SslTrust       *string   `json:"sslTrust,omitempty"`
	SslProtocols   *[]string `json:"sslProtocols,omitempty"`
	CreatedAt      time.Time `json:"createdAt"`
	Id             string    `json:"id"`
}

ConnectorSmtpConnectionDto struct for ConnectorSmtpConnectionDto

type ConnectorSmtpConnectionTestResult 

type ConnectorSmtpConnectionTestResult struct {
	Error   string   `json:"error,omitempty"`
	Success bool     `json:"success"`
	Message string   `json:"message,omitempty"`
	Logs    []string `json:"logs,omitempty"`
}

ConnectorSmtpConnectionTestResult struct for ConnectorSmtpConnectionTestResult

type ConnectorSyncRequestResult 

type ConnectorSyncRequestResult struct {
	SyncResult ConnectorSyncResult `json:"syncResult,omitempty"`
	Exception  string              `json:"exception,omitempty"`
	EventId    string              `json:"eventId,omitempty"`
}

ConnectorSyncRequestResult struct for ConnectorSyncRequestResult

type ConnectorSyncResult 

type ConnectorSyncResult struct {
	EmailSyncCount int32    `json:"emailSyncCount"`
	Logs           []string `json:"logs,omitempty"`
	EmailIds       []string `json:"emailIds,omitempty"`
}

ConnectorSyncResult struct for ConnectorSyncResult

type ConnectorSyncSettingsDto 

type ConnectorSyncSettingsDto struct {
	Id               string  `json:"id"`
	UserId           string  `json:"userId"`
	ConnectorId      string  `json:"connectorId"`
	SyncEnabled      bool    `json:"syncEnabled"`
	SyncScheduleType *string `json:"syncScheduleType,omitempty"`
	SyncInterval     *int32  `json:"syncInterval,omitempty"`
}

ConnectorSyncSettingsDto struct for ConnectorSyncSettingsDto

type ConsentControllerApiService 

type ConsentControllerApiService service

ConsentControllerApiService ConsentControllerApi service

func (*ConsentControllerApiService) CheckSendingConsentForEmailAddress 

func (a *ConsentControllerApiService) CheckSendingConsentForEmailAddress(ctx _context.Context, emailAddress string) (OptInSendingConsentDto, *_nethttp.Response, error)

CheckSendingConsentForEmailAddress Method for CheckSendingConsentForEmailAddress

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailAddress Email address to check consent for

@return OptInSendingConsentDto

func (*ConsentControllerApiService) GetOptInIdentities 

func (a *ConsentControllerApiService) GetOptInIdentities(ctx _context.Context, localVarOptionals *GetOptInIdentitiesOpts) (PageOptInIdentityProjection, *_nethttp.Response, error)

GetOptInIdentities Method for GetOptInIdentities

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetOptInIdentitiesOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size in list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC

@return PageOptInIdentityProjection

func (*ConsentControllerApiService) RevokeOptInConsentForEmailAddress 

func (a *ConsentControllerApiService) RevokeOptInConsentForEmailAddress(ctx _context.Context, emailAddress string) (OptInSendingConsentDto, *_nethttp.Response, error)

RevokeOptInConsentForEmailAddress Method for RevokeOptInConsentForEmailAddress

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailAddress Email address to revoke consent for

@return OptInSendingConsentDto

func (*ConsentControllerApiService) SendOptInConsentForEmailAddress 

func (a *ConsentControllerApiService) SendOptInConsentForEmailAddress(ctx _context.Context, optInConsentOptions OptInConsentOptions) (OptInConsentSendResult, *_nethttp.Response, error)

SendOptInConsentForEmailAddress Send a verification code to a user once they have explicitly submitted their email address Send double-opt in consent for an email address

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optInConsentOptions

@return OptInConsentSendResult

type ConsentStatusDto 

type ConsentStatusDto struct {
	Consented bool `json:"consented"`
}

ConsentStatusDto struct for ConsentStatusDto

type ContactControllerApiService 

type ContactControllerApiService service

ContactControllerApiService ContactControllerApi service

func (*ContactControllerApiService) CreateContact 

func (a *ContactControllerApiService) CreateContact(ctx _context.Context, createContactOptions CreateContactOptions) (ContactDto, *_nethttp.Response, error)

CreateContact Create a contact

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createContactOptions

@return ContactDto

func (*ContactControllerApiService) DeleteContact 

func (a *ContactControllerApiService) DeleteContact(ctx _context.Context, contactId string) (*_nethttp.Response, error)

DeleteContact Delete contact

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param contactId

func (*ContactControllerApiService) GetAllContacts 

func (a *ContactControllerApiService) GetAllContacts(ctx _context.Context, localVarOptionals *GetAllContactsOpts) (PageContactProjection, *_nethttp.Response, error)

GetAllContacts Get all contacts

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAllContactsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size in list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp
  • @param "Search" (optional.String) - Search terms

@return PageContactProjection

func (*ContactControllerApiService) GetContact 

func (a *ContactControllerApiService) GetContact(ctx _context.Context, contactId string) (ContactDto, *_nethttp.Response, error)

GetContact Get contact

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param contactId

@return ContactDto

func (*ContactControllerApiService) GetContactVCard 

func (a *ContactControllerApiService) GetContactVCard(ctx _context.Context, contactId string) (*_nethttp.Response, error)

GetContactVCard Get contact vCard vcf file

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param contactId

func (*ContactControllerApiService) GetContacts 

func (a *ContactControllerApiService) GetContacts(ctx _context.Context) ([]ContactProjection, *_nethttp.Response, error)

GetContacts Get all contacts

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []ContactProjection

type ContactDto 

type ContactDto struct {
	Id                  string                  `json:"id"`
	GroupId             *string                 `json:"groupId,omitempty"`
	FirstName           *string                 `json:"firstName,omitempty"`
	LastName            *string                 `json:"lastName,omitempty"`
	Company             *string                 `json:"company,omitempty"`
	EmailAddresses      []string                `json:"emailAddresses"`
	PrimaryEmailAddress *string                 `json:"primaryEmailAddress,omitempty"`
	Tags                []string                `json:"tags"`
	MetaData            *map[string]interface{} `json:"metaData,omitempty"`
	OptOut              *bool                   `json:"optOut,omitempty"`
	CreatedAt           time.Time               `json:"createdAt"`
}

ContactDto Contact object. For saving a user in contact book.

type ContactProjection 

type ContactProjection struct {
	Id             string    `json:"id"`
	GroupId        *string   `json:"groupId,omitempty"`
	EmailAddress   *string   `json:"emailAddress,omitempty"`
	CreatedAt      time.Time `json:"createdAt"`
	EmailAddresses *[]string `json:"emailAddresses,omitempty"`
	FirstName      *string   `json:"firstName,omitempty"`
	LastName       *string   `json:"lastName,omitempty"`
	Company        *string   `json:"company,omitempty"`
	OptOut         *bool     `json:"optOut,omitempty"`
}

ContactProjection Email contact for address book

type ContentMatchOptions 

type ContentMatchOptions struct {
	// Java style regex pattern. Do not include the typical `/` at start or end of regex in some languages. Given an example `your code is: 12345` the pattern to extract match looks like `code is: (\\d{6})`. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: `['code is: 123456', '123456']` See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns.
	Pattern string `json:"pattern"`
}

ContentMatchOptions Options for matching content using regex patterns based on Java Pattern syntax

type CountDto 

type CountDto struct {
	TotalElements int64 `json:"totalElements"`
}

CountDto Number of elements

type CreateAiTransformerMappingOptions 

type CreateAiTransformerMappingOptions struct {
	Name            *string                `json:"name,omitempty"`
	AiTransformId   string                 `json:"aiTransformId"`
	EntityId        *string                `json:"entityId,omitempty"`
	EntityType      string                 `json:"entityType"`
	ContentSelector *string                `json:"contentSelector,omitempty"`
	TriggerSelector *string                `json:"triggerSelector,omitempty"`
	SpreadRootArray *bool                  `json:"spreadRootArray,omitempty"`
	MatchOptions    *AiMappingMatchOptions `json:"matchOptions,omitempty"`
}

CreateAiTransformerMappingOptions struct for CreateAiTransformerMappingOptions

type CreateAliasOptions 

type CreateAliasOptions struct {
	// Email address to be hidden behind alias. Emails sent to the alias email address will be forwarded to this address. If you want to enable replies set useThreads true and the reply-to for the email will allow outbound communication via a thread. Some email addresses may require verification if they are not added as a contact first.
	EmailAddress string `json:"emailAddress"`
	// Optional inbox ID to attach to alias. Null by default means an a new inbox will be created for the alias. Use a custom inbox to control what email address the alias uses. To use custom email addresses create a domain and an inbox, the use the inbox ID with this call. Emails received by this inbox will be forwarded to the alias email address
	InboxId *string `json:"inboxId,omitempty"`
	// Optional name for alias
	Name *string `json:"name,omitempty"`
	// Enable threads options. If true emails will be sent with a unique reply-to thread address. This means you can reply to the forwarded email and it will be sent to the recipients via your alias address. That way a thread conversation is preserved.
	UseThreads bool `json:"useThreads"`
	// Custom domain ID to use when generating alias email addresses
	DomainId *string `json:"domainId,omitempty"`
	// Whether to verify the masked email address exists before sending an email to it
	VerifyEmailAddress *bool `json:"verifyEmailAddress,omitempty"`
}

CreateAliasOptions Create email alias options. Email aliases can be used to mask real email addresses behind an ID. You can also attach an inbox to an alias so that any email received by the inbox email address if forwarded to the alias email address.

type CreateCampaignProbeOptions 

type CreateCampaignProbeOptions struct {
	// Optional display name
	Name *string `json:"name,omitempty"`
	// Whether SES monitor ingestion is enabled for this probe
	Enabled *bool `json:"enabled,omitempty"`
	// Scheduled run interval in seconds
	IntervalSeconds *int64 `json:"intervalSeconds,omitempty"`
	// Whether scheduled campaign probe runs are enabled. Direct run-now remains available.
	SchedulingEnabled *bool `json:"schedulingEnabled,omitempty"`
}

CreateCampaignProbeOptions Create options for a campaign probe

type CreateCampaignProbeRunOptions 

type CreateCampaignProbeRunOptions struct {
	// Sender email address
	FromAddress *string `json:"fromAddress,omitempty"`
	// Message subject
	Subject *string `json:"subject,omitempty"`
	// Recipient email address for context
	Recipient *string `json:"recipient,omitempty"`
	// Caller supplied message id for dedupe/trace
	MessageId *string `json:"messageId,omitempty"`
	// HTML body content to analyze
	HtmlBody *string `json:"htmlBody,omitempty"`
	// Text body content to analyze when HTML is absent
	TextBody *string `json:"textBody,omitempty"`
}

CreateCampaignProbeRunOptions Direct invoke options for campaign probe analysis

type CreateConnectorImapConnectionOptions 

type CreateConnectorImapConnectionOptions struct {
	ImapSsl      *bool   `json:"imapSsl,omitempty"`
	ImapUsername *string `json:"imapUsername,omitempty"`
	ImapPassword *string `json:"imapPassword,omitempty"`
	// Optional folder to select during IMAP connection
	SelectFolder *string `json:"selectFolder,omitempty"`
	SearchTerms  *string `json:"searchTerms,omitempty"`
	// IMAP server port
	ImapPort *int32 `json:"imapPort,omitempty"`
	// IMAP server host
	ImapHost string `json:"imapHost"`
	// IMAP server enabled
	Enabled       *bool   `json:"enabled,omitempty"`
	StartTls      *bool   `json:"startTls,omitempty"`
	ProxyEnabled  *bool   `json:"proxyEnabled,omitempty"`
	ProxyPort     *int32  `json:"proxyPort,omitempty"`
	ProxyHost     *string `json:"proxyHost,omitempty"`
	LocalHostName *string `json:"localHostName,omitempty"`
	// List of IMAP mechanisms
	Mechanisms *[]string `json:"mechanisms,omitempty"`
	SslTrust   *string   `json:"sslTrust,omitempty"`
	// List of SSL protocols
	SslProtocols *[]string `json:"sslProtocols,omitempty"`
}

CreateConnectorImapConnectionOptions Options for IMAP connection to external email inbox. Allows syncing emails via IMAP.

type CreateConnectorOptions 

type CreateConnectorOptions struct {
	// Name of connector
	Name *string `json:"name,omitempty"`
	// Email address of external inbox
	EmailAddress *string `json:"emailAddress,omitempty"`
	// Is connector enabled
	Enabled *bool `json:"enabled,omitempty"`
}

CreateConnectorOptions Options for creating an inbox connection with an external mail provider

type CreateConnectorOpts 

type CreateConnectorOpts struct {
	InboxId optional.Interface
}

CreateConnectorOpts Optional parameters for the method 'CreateConnector'

type CreateConnectorSmtpConnectionOptions 

type CreateConnectorSmtpConnectionOptions struct {
	Enabled        *bool     `json:"enabled,omitempty"`
	SmtpHost       string    `json:"smtpHost"`
	SmtpPort       *int32    `json:"smtpPort,omitempty"`
	SmtpSsl        *bool     `json:"smtpSsl,omitempty"`
	SmtpUsername   *string   `json:"smtpUsername,omitempty"`
	SmtpPassword   *string   `json:"smtpPassword,omitempty"`
	SmtpMechanisms *[]string `json:"smtpMechanisms,omitempty"`
	StartTls       *bool     `json:"startTls,omitempty"`
	LocalHostName  *string   `json:"localHostName,omitempty"`
	ProxyHost      *string   `json:"proxyHost,omitempty"`
	ProxyPort      *int32    `json:"proxyPort,omitempty"`
	ProxyEnabled   *bool     `json:"proxyEnabled,omitempty"`
	SslTrust       *string   `json:"sslTrust,omitempty"`
	SslProtocols   *[]string `json:"sslProtocols,omitempty"`
}

CreateConnectorSmtpConnectionOptions struct for CreateConnectorSmtpConnectionOptions

type CreateConnectorSyncSettingsOptions 

type CreateConnectorSyncSettingsOptions struct {
	// Enable automatic background sync
	SyncEnabled *bool `json:"syncEnabled,omitempty"`
	// Sync schedule type
	SyncScheduleType *string `json:"syncScheduleType,omitempty"`
	// Sync interval in minutes
	SyncInterval *int32 `json:"syncInterval,omitempty"`
}

CreateConnectorSyncSettingsOptions Options for creating automatic syncing between an inbox connection and an external mail provider

type CreateConnectorWithOptions 

type CreateConnectorWithOptions struct {
	CreateConnectorOptions               CreateConnectorOptions               `json:"createConnectorOptions"`
	CreateConnectorImapConnectionOptions CreateConnectorImapConnectionOptions `json:"createConnectorImapConnectionOptions,omitempty"`
	CreateConnectorSmtpConnectionOptions CreateConnectorSmtpConnectionOptions `json:"createConnectorSmtpConnectionOptions,omitempty"`
	CreateConnectorSyncSettingsOptions   CreateConnectorSyncSettingsOptions   `json:"createConnectorSyncSettingsOptions,omitempty"`
}

CreateConnectorWithOptions Options for creating an inbox connection with an external mail provider including extra settings

type CreateConnectorWithOptionsOpts 

type CreateConnectorWithOptionsOpts struct {
	InboxId optional.Interface
}

CreateConnectorWithOptionsOpts Optional parameters for the method 'CreateConnectorWithOptions'

type CreateContactOptions 

type CreateContactOptions struct {
	FirstName *string `json:"firstName,omitempty"`
	LastName  *string `json:"lastName,omitempty"`
	Company   *string `json:"company,omitempty"`
	// Set of email addresses belonging to the contact
	EmailAddresses *[]string `json:"emailAddresses,omitempty"`
	// Tags that can be used to search and group contacts
	Tags     *[]string               `json:"tags,omitempty"`
	MetaData *map[string]interface{} `json:"metaData,omitempty"`
	// Has the user explicitly or implicitly opted out of being contacted? If so MailSlurp will ignore them in all actions.
	OptOut *bool `json:"optOut,omitempty"`
	// Group IDs that contact belongs to
	GroupId *string `json:"groupId,omitempty"`
	// Whether to validate contact email address exists
	VerifyEmailAddresses *bool `json:"verifyEmailAddresses,omitempty"`
}

CreateContactOptions Options for creating an email contact in address book

type CreateDeliverabilitySimulationJobOptions 

type CreateDeliverabilitySimulationJobOptions struct {
	// Sender inbox ID for INBOX scope tests
	SenderInboxId *string `json:"senderInboxId,omitempty"`
	// Sender phone ID for PHONE scope tests
	SenderPhoneId *string                               `json:"senderPhoneId,omitempty"`
	Email         *DeliverabilitySimulationEmailOptions `json:"email,omitempty"`
	Sms           *DeliverabilitySimulationSmsOptions   `json:"sms,omitempty"`
	// Delay between individual sends in milliseconds
	DelayMs *int64 `json:"delayMs,omitempty"`
	// Maximum sends processed per scheduler batch
	BatchSize *int32 `json:"batchSize,omitempty"`
	// Optional fixed sends per target. If omitted this is derived from test expectations.
	SendsPerTarget *int64 `json:"sendsPerTarget,omitempty"`
}

CreateDeliverabilitySimulationJobOptions Create a simulation job for a deliverability test

type CreateDeliverabilityTestOptions 

type CreateDeliverabilityTestOptions struct {
	// Optional name for the test
	Name *string `json:"name,omitempty"`
	// Optional description
	Description *string `json:"description,omitempty"`
	// Entity scope to evaluate
	Scope string `json:"scope"`
	// UTC instant when the receive window starts. Defaults to now if omitted.
	StartAt *time.Time `json:"startAt,omitempty"`
	// Optional timeout in seconds after startAt. If not all entities match before timeout the test transitions to FAILED.
	MaxDurationSeconds *int64 `json:"maxDurationSeconds,omitempty"`
	// Optional acceptable success threshold percentage (0,100]. If set, a timed-out test can complete successfully when matchedEntities/totalEntities reaches this percentage.
	SuccessThresholdPercent *float64                      `json:"successThresholdPercent,omitempty"`
	Selector                DeliverabilitySelectorOptions `json:"selector"`
	// One or more expectations to evaluate for each entity
	Expectations []DeliverabilityExpectation `json:"expectations"`
}

CreateDeliverabilityTestOptions Create a new deliverability/load test

type CreateDevicePreviewFeedbackOptions 

type CreateDevicePreviewFeedbackOptions struct {
	Source       string            `json:"source"`
	Category     string            `json:"category"`
	Status       string            `json:"status,omitempty"`
	Rating       int32             `json:"rating,omitempty"`
	RunId        string            `json:"runId,omitempty"`
	TargetId     string            `json:"targetId,omitempty"`
	ScreenshotId string            `json:"screenshotId,omitempty"`
	Provider     string            `json:"provider,omitempty"`
	Title        string            `json:"title,omitempty"`
	Comment      string            `json:"comment,omitempty"`
	InternalNote string            `json:"internalNote,omitempty"`
	SessionId    string            `json:"sessionId,omitempty"`
	LiveViewUrl  string            `json:"liveViewUrl,omitempty"`
	Metadata     map[string]string `json:"metadata,omitempty"`
}

CreateDevicePreviewFeedbackOptions struct for CreateDevicePreviewFeedbackOptions

type CreateDevicePreviewOptions 

type CreateDevicePreviewOptions struct {
	// Optional providers to request for rendering. Defaults to ESP_DEFAULT_PROVIDERS when set, otherwise GMAIL and OUTLOOK.
	Providers []string `json:"providers,omitempty"`
	// Optional flag to request all configured providers in ESP. Defaults to false when omitted
	IncludeAllConfiguredProviders bool `json:"includeAllConfiguredProviders,omitempty"`
}

CreateDevicePreviewOptions struct for CreateDevicePreviewOptions

type CreateDevicePreviewRunOpts 

type CreateDevicePreviewRunOpts struct {
	CreateDevicePreviewOptions optional.Interface
}

CreateDevicePreviewRunOpts Optional parameters for the method 'CreateDevicePreviewRun'

type CreateDevicePreviewRunResult 

type CreateDevicePreviewRunResult struct {
	Run     DevicePreviewRunDto `json:"run"`
	Created bool                `json:"created"`
}

CreateDevicePreviewRunResult struct for CreateDevicePreviewRunResult

type CreateDomainMonitorAlertSinkOptions 

type CreateDomainMonitorAlertSinkOptions struct {
	Type              string `json:"type"`
	Target            string `json:"target"`
	SeverityThreshold string `json:"severityThreshold,omitempty"`
	Enabled           bool   `json:"enabled,omitempty"`
}

CreateDomainMonitorAlertSinkOptions struct for CreateDomainMonitorAlertSinkOptions

type CreateDomainMonitorOptions 

type CreateDomainMonitorOptions struct {
	Domain string `json:"domain"`
	// Optional display name
	Name *string `json:"name,omitempty"`
	// Check interval in seconds
	IntervalSeconds *int64 `json:"intervalSeconds,omitempty"`
	// Whether scheduled monitor runs are enabled (legacy alias for schedulingEnabled)
	Enabled *bool `json:"enabled,omitempty"`
	// Whether scheduled monitor runs are enabled. Direct run-now is always permitted.
	SchedulingEnabled *bool `json:"schedulingEnabled,omitempty"`
}

CreateDomainMonitorOptions Create options for a domain monitor

type CreateDomainOptions 

type CreateDomainOptions struct {
	// The top level domain you wish to use with MailSlurp. Do not specify subdomain just the top level. So `test.com` covers all subdomains such as `mail.test.com`. Don't include a protocol such as `http://`. Once added you must complete the verification steps by adding the returned records to your domain.
	Domain string `json:"domain"`
	// Optional description of the domain.
	Description *string `json:"description,omitempty"`
	// Whether to create a catch all inbox for the domain. Any email sent to an address using your domain that cannot be matched to an existing inbox you created with the domain will be routed to the created catch all inbox. You can access emails using the regular methods on this inbox ID.
	CreatedCatchAllInbox *bool `json:"createdCatchAllInbox,omitempty"`
	// Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails.
	DomainType *string `json:"domainType,omitempty"`
}

CreateDomainOptions Options for creating a domain to use with MailSlurp. You must have ownership access to this domain in order to verify it. Domains will not function correctly until the domain has been verified. See https://www.mailslurp.com/guides/custom-domains for help. Domains can be either `HTTP` or `SMTP` type. The type of domain determines which inboxes can be used with it. `SMTP` inboxes use a mail server running `mxslurp.click` while `HTTP` inboxes are handled by AWS SES.

type CreateEmailAuditOptions 

type CreateEmailAuditOptions struct {
	// Optional sender address context
	FromAddress *string `json:"fromAddress,omitempty"`
	// Optional recipient context
	Recipient *string `json:"recipient,omitempty"`
	// Optional subject line context
	Subject *string `json:"subject,omitempty"`
	// Optional HTML email body
	HtmlBody *string `json:"htmlBody,omitempty"`
	// Optional text email body
	TextBody      *string        `json:"textBody,omitempty"`
	EmailAnalysis *EmailAnalysis `json:"emailAnalysis,omitempty"`
	// Whether the source email included attachments
	HasAttachments *bool `json:"hasAttachments,omitempty"`
}

CreateEmailAuditOptions Authenticated saved email audit request

type CreateEmergencyAddressOptions 

type CreateEmergencyAddressOptions struct {
	CustomerName   string `json:"customerName"`
	Address1       string `json:"address1"`
	City           string `json:"city"`
	Region         string `json:"region"`
	PostalCode     string `json:"postalCode"`
	IsoCountryCode string `json:"isoCountryCode"`
	DisplayName    string `json:"displayName,omitempty"`
}

CreateEmergencyAddressOptions struct for CreateEmergencyAddressOptions

type CreateGroupOptions 

type CreateGroupOptions struct {
	Name        string  `json:"name"`
	Description *string `json:"description,omitempty"`
}

CreateGroupOptions Create contact group options

type CreateInboxDto 

type CreateInboxDto struct {
	// A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
	EmailAddress *string `json:"emailAddress,omitempty"`
	// FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox.
	DomainName *string `json:"domainName,omitempty"`
	// ID of custom domain to use for email address.
	DomainId *string `json:"domainId,omitempty"`
	// Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails.
	Name *string `json:"name,omitempty"`
	// Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
	Description *string `json:"description,omitempty"`
	// Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types.
	UseDomainPool *bool `json:"useDomainPool,omitempty"`
	// Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
	Tags *[]string `json:"tags,omitempty"`
	// Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
	ExpiresAt *time.Time `json:"expiresAt,omitempty"`
	// Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering
	Favourite *bool `json:"favourite,omitempty"`
	// Number of milliseconds that inbox should exist for
	ExpiresIn *int64 `json:"expiresIn,omitempty"`
	// DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization.
	AllowTeamAccess *bool `json:"allowTeamAccess,omitempty"`
	// Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).
	InboxType *string `json:"inboxType,omitempty"`
	// Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending.
	VirtualInbox *bool `json:"virtualInbox,omitempty"`
	// Use a shorter email address under 31 characters
	UseShortAddress *bool `json:"useShortAddress,omitempty"`
	// Prefix to add before the email address for easier labelling or identification.
	Prefix *string `json:"prefix,omitempty"`
}

CreateInboxDto Options for creating an inbox. An inbox has a real email address that can send and receive emails. Inboxes can be permanent or expire at a given time. Inboxes are either `SMTP` or `HTTP` mailboxes. `SMTP` inboxes are processed by a mail server running at `mailslurp.mx` while `HTTP` inboxes are processed by AWS SES backed mailservers. An inbox email address is randomly assigned by default ending in either `mailslurp.com` or (if `useDomainPool` is enabled) ending in a similar domain such as `mailslurp.xyz` (selected at random). To specify an address use a custom domain: either pass the `emailAddress` options with `<your-recipient>@<your-domain>`. To create a randomized address for your domain set the `domainName` to the domain you have verified or pass the `domainId`. Virtual inboxes prevent outbound sending and instead trap mail.

type CreateInboxForwarderOptions 

type CreateInboxForwarderOptions struct {
	// Field to match against to trigger inbox forwarding for inbound email
	Field *string `json:"field,omitempty"`
	// String or wildcard style match for field specified when evaluating forwarding rules
	Match *string `json:"match,omitempty"`
	// Email addresses to forward an email to if it matches the field and match criteria of the forwarder
	ForwardToRecipients []string `json:"forwardToRecipients"`
	// Comparison mode for inbox automation matching.
	Should       *string                      `json:"should,omitempty"`
	MatchOptions *InboxAutomationMatchOptions `json:"matchOptions,omitempty"`
	// Method for extracting text from attachments.
	AttachmentTextExtractionMethod *string `json:"attachmentTextExtractionMethod,omitempty"`
}

CreateInboxForwarderOptions Options for creating an inbox forwarder

type CreateInboxOpts 

type CreateInboxOpts struct {
	EmailAddress    optional.String
	Tags            optional.Interface
	Name            optional.String
	Description     optional.String
	UseDomainPool   optional.Bool
	Favourite       optional.Bool
	ExpiresAt       optional.Time
	ExpiresIn       optional.Int64
	AllowTeamAccess optional.Bool
	InboxType       optional.String
	VirtualInbox    optional.Bool
	UseShortAddress optional.Bool
	DomainId        optional.Interface
	DomainName      optional.String
	Prefix          optional.String
}

CreateInboxOpts Optional parameters for the method 'CreateInbox'

type CreateInboxReplierOptions 

type CreateInboxReplierOptions struct {
	// Inbox ID to attach replier to
	InboxId *string `json:"inboxId,omitempty"`
	// Name for replier
	Name *string `json:"name,omitempty"`
	// Field to match against to trigger inbox replier for inbound email
	Field *string `json:"field,omitempty"`
	// String or wildcard style match for field specified when evaluating reply rules. Use `*` to match anything.
	Match *string `json:"match,omitempty"`
	// Reply-to email address when sending replying
	ReplyTo *string `json:"replyTo,omitempty"`
	// Subject override when replying to email
	Subject *string `json:"subject,omitempty"`
	// Send email from address
	From *string `json:"from,omitempty"`
	// Email reply charset
	Charset *string `json:"charset,omitempty"`
	// Ignore sender replyTo when responding. Send directly to the sender if enabled.
	IgnoreReplyTo *bool `json:"ignoreReplyTo,omitempty"`
	// Send HTML email
	IsHTML *bool `json:"isHTML,omitempty"`
	// Email body for reply
	Body *string `json:"body,omitempty"`
	// ID of template to use when sending a reply
	TemplateId *string `json:"templateId,omitempty"`
	// Template variable values
	TemplateVariables *map[string]map[string]interface{} `json:"templateVariables,omitempty"`
	// Comparison mode for inbox automation matching.
	Should       *string                      `json:"should,omitempty"`
	MatchOptions *InboxAutomationMatchOptions `json:"matchOptions,omitempty"`
}

CreateInboxReplierOptions Options for creating an inbox replier. Repliers can be attached to inboxes and send automated responses when an inbound email matches given criteria.

type CreateInboxRetentionPolicyForAccountOptions 

type CreateInboxRetentionPolicyForAccountOptions struct {
	RetentionDays int32 `json:"retentionDays"`
}

CreateInboxRetentionPolicyForAccountOptions struct for CreateInboxRetentionPolicyForAccountOptions

type CreateNewEmailAddressOpts 

type CreateNewEmailAddressOpts struct {
	AllowTeamAccess optional.Bool
	UseDomainPool   optional.Bool
	ExpiresAt       optional.Time
	ExpiresIn       optional.Int64
	EmailAddress    optional.String
	InboxType       optional.String
	Description     optional.String
	Name            optional.String
	Tags            optional.Interface
	Favourite       optional.Bool
	VirtualInbox    optional.Bool
	UseShortAddress optional.Bool
	DomainName      optional.String
	DomainId        optional.Interface
	Prefix          optional.String
}

CreateNewEmailAddressOpts Optional parameters for the method 'CreateNewEmailAddress'

type CreateNewInboxForwarderOpts 

type CreateNewInboxForwarderOpts struct {
	InboxId optional.Interface
}

CreateNewInboxForwarderOpts Optional parameters for the method 'CreateNewInboxForwarder'

type CreateNewRulesetOpts 

type CreateNewRulesetOpts struct {
	InboxId optional.Interface
	PhoneId optional.Interface
}

CreateNewRulesetOpts Optional parameters for the method 'CreateNewRuleset'

type CreatePhoneNumberOptions 

type CreatePhoneNumberOptions struct {
	PhoneCountry                string   `json:"phoneCountry"`
	Name                        string   `json:"name,omitempty"`
	Description                 string   `json:"description,omitempty"`
	Tags                        []string `json:"tags,omitempty"`
	Schedule                    string   `json:"schedule,omitempty"`
	PhoneNumberEndpointOverride string   `json:"phoneNumberEndpointOverride,omitempty"`
	PhoneNumberVariant          string   `json:"phoneNumberVariant,omitempty"`
	PhoneProvider               string   `json:"phoneProvider,omitempty"`
	// Line-quality preference for simple phone number provisioning
	PhoneLineFilter string `json:"phoneLineFilter,omitempty"`
}

CreatePhoneNumberOptions struct for CreatePhoneNumberOptions

type CreatePhonePoolOptions 

type CreatePhonePoolOptions struct {
	Name        string `json:"name"`
	Description string `json:"description,omitempty"`
}

CreatePhonePoolOptions struct for CreatePhonePoolOptions

type CreatePhoneProvisioningJobItemOptions 

type CreatePhoneProvisioningJobItemOptions struct {
	PhoneNumber       string `json:"phoneNumber"`
	ProviderLabel     string `json:"providerLabel,omitempty"`
	LineType          string `json:"lineType,omitempty"`
	CarrierName       string `json:"carrierName,omitempty"`
	MobileCountryCode string `json:"mobileCountryCode,omitempty"`
	MobileNetworkCode string `json:"mobileNetworkCode,omitempty"`
}

CreatePhoneProvisioningJobItemOptions struct for CreatePhoneProvisioningJobItemOptions

type CreatePhoneProvisioningJobOptions 

type CreatePhoneProvisioningJobOptions struct {
	PhoneCountry string                                  `json:"phoneCountry"`
	PhoneVariant *string                                 `json:"phoneVariant,omitempty"`
	Items        []CreatePhoneProvisioningJobItemOptions `json:"items"`
}

CreatePhoneProvisioningJobOptions Create an advanced phone provisioning job

type CreatePortalOptions 

type CreatePortalOptions struct {
	Name        string `json:"name,omitempty"`
	DomainId    string `json:"domainId,omitempty"`
	Description string `json:"description,omitempty"`
	LinkHelp    string `json:"linkHelp,omitempty"`
}

CreatePortalOptions struct for CreatePortalOptions

type CreatePortalUserOptions 

type CreatePortalUserOptions struct {
	Password           string         `json:"password,omitempty"`
	Name               string         `json:"name,omitempty"`
	Username           string         `json:"username,omitempty"`
	SkipInboxCreation  bool           `json:"skipInboxCreation,omitempty"`
	InboxId            string         `json:"inboxId,omitempty"`
	CreateInboxOptions CreateInboxDto `json:"createInboxOptions,omitempty"`
}

CreatePortalUserOptions struct for CreatePortalUserOptions

type CreateRandomInboxOpts 

type CreateRandomInboxOpts struct {
	AllowTeamAccess optional.Bool
	UseDomainPool   optional.Bool
	ExpiresAt       optional.Time
	ExpiresIn       optional.Int64
	EmailAddress    optional.String
	InboxType       optional.String
	Description     optional.String
	Name            optional.String
	Tags            optional.Interface
	Favourite       optional.Bool
	VirtualInbox    optional.Bool
	UseShortAddress optional.Bool
	DomainName      optional.String
	DomainId        optional.Interface
	Prefix          optional.String
}

CreateRandomInboxOpts Optional parameters for the method 'CreateRandomInbox'

type CreateRulesetOptions 

type CreateRulesetOptions struct {
	// What type of emails actions to apply ruleset to. Either `SENDING_EMAILS` or `RECEIVING_EMAILS` will apply action and target to any sending or receiving of emails respectively.
	Scope string `json:"scope"`
	// Action to be taken when the ruleset matches an email for the given scope. For example: `BLOCK` action with target `*` and scope `SENDING_EMAILS` blocks sending to all recipients. Note `ALLOW` takes precedent over `BLOCK`. `FILTER_REMOVE` is like block but will remove offending email addresses during a send or receive event instead of blocking the action.
	Action string `json:"action"`
	// Target to match emails with. Can be a wild-card type pattern or a valid email address. For instance `*@gmail.com` matches all gmail addresses while `test@gmail.com` matches one address exactly. The target is applied to every recipient field email address when `SENDING_EMAILS` is the scope and is applied to sender of email when `RECEIVING_EMAILS`.
	Target string `json:"target"`
}

CreateRulesetOptions Options for creating inbox rulesets. Inbox rulesets can be used to block, allow, filter, or forward emails when sending or receiving using the inbox.

type CreateTemplateOptions 

type CreateTemplateOptions struct {
	// Name of template
	Name string `json:"name"`
	// Template content. Can include moustache style variables such as {{var_name}}
	Content string `json:"content"`
}

CreateTemplateOptions Create template options

type CreateTotpDeviceBase32SecretKeyOptions 

type CreateTotpDeviceBase32SecretKeyOptions struct {
	// Base32 secret key for TOTP device as alternative to OTP Auth URI or QR code.
	Base32SecretKey string `json:"base32SecretKey"`
	// Name for labeling the TOTP device
	Name *string `json:"name,omitempty"`
	// Optional username for the TOTP device
	Username *string `json:"username,omitempty"`
	// Optional issuer override for the TOTP device
	Issuer *string `json:"issuer,omitempty"`
	// Optional number of digits in TOTP code
	Digits *int32 `json:"digits,omitempty"`
	// Optional period in seconds for TOTP code expiration
	Period *int32 `json:"period,omitempty"`
	// Optional algorithm override
	Algorithm *string `json:"algorithm,omitempty"`
}

CreateTotpDeviceBase32SecretKeyOptions struct for CreateTotpDeviceBase32SecretKeyOptions

type CreateTotpDeviceCustomOptions 

type CreateTotpDeviceCustomOptions struct {
	// The base32 encoded secret provided by the identity provider for the TOTP device.
	Secret string `json:"secret"`
	// Name for labeling the TOTP device
	Name *string `json:"name,omitempty"`
	// Optional username for the TOTP device
	Username *string `json:"username,omitempty"`
	// Optional issuer override for the TOTP device
	Issuer *string `json:"issuer,omitempty"`
	// Optional number of digits in TOTP code
	Digits *int32 `json:"digits,omitempty"`
	// Optional period in seconds for TOTP code expiration
	Period *int32 `json:"period,omitempty"`
	// Optional algorithm override
	Algorithm *string `json:"algorithm,omitempty"`
}

CreateTotpDeviceCustomOptions struct for CreateTotpDeviceCustomOptions

type CreateTotpDeviceOtpAuthUrlOptions 

type CreateTotpDeviceOtpAuthUrlOptions struct {
	// OTP Auth URI for connecting a TOTP device.
	OtpAuthUrl string `json:"otpAuthUrl"`
	// Name for labeling the TOTP device
	Name *string `json:"name,omitempty"`
	// Optional username for the TOTP device
	Username *string `json:"username,omitempty"`
	// Optional issuer override for the TOTP device
	Issuer *string `json:"issuer,omitempty"`
	// Optional number of digits in TOTP code
	Digits *int32 `json:"digits,omitempty"`
	// Optional period in seconds for TOTP code expiration
	Period *int32 `json:"period,omitempty"`
	// Optional algorithm override
	Algorithm *string `json:"algorithm,omitempty"`
}

CreateTotpDeviceOtpAuthUrlOptions struct for CreateTotpDeviceOtpAuthUrlOptions

type CreateTrackingPixelOptions 

type CreateTrackingPixelOptions struct {
	Name      *string `json:"name,omitempty"`
	Recipient *string `json:"recipient,omitempty"`
}

CreateTrackingPixelOptions Options for creating a tracking pixel for email open tracking

type CreateWebhookOptions 

type CreateWebhookOptions struct {
	// Public URL on your server that MailSlurp can post WebhookNotification payload to when an email is received or an event is trigger. The payload of the submitted JSON is dependent on the webhook event type. See docs.mailslurp.com/webhooks for event payload documentation.
	Url       string            `json:"url"`
	BasicAuth *BasicAuthOptions `json:"basicAuth,omitempty"`
	// Optional name for the webhook
	Name *string `json:"name,omitempty"`
	// Optional webhook event name. Default is `EMAIL_RECEIVED` and is triggered when an email is received by the inbox associated with the webhook. Payload differ according to the webhook event name.
	EventName      *string        `json:"eventName,omitempty"`
	IncludeHeaders WebhookHeaders `json:"includeHeaders,omitempty"`
	// Template for the JSON body of the webhook request that will be sent to your server. Use Moustache style `{{variableName}}` templating to use parts of the standard webhook payload for the given event.
	RequestBodyTemplate *string `json:"requestBodyTemplate,omitempty"`
	// AI Transform ID to apply to the webhook event and send a payload matching transform output schema
	AiTransformId *string `json:"aiTransformId,omitempty"`
	// Use static IP range when calling webhook endpoint
	UseStaticIpRange *bool `json:"useStaticIpRange,omitempty"`
	// Ignore insecure SSL certificates when sending request. Useful for self-signed certs.
	IgnoreInsecureSslCertificates *bool `json:"ignoreInsecureSslCertificates,omitempty"`
	// Optional list of tags
	Tags *[]string `json:"tags,omitempty"`
}

CreateWebhookOptions Options for creating a webhook. Webhooks can be attached to inboxes and MailSlurp will POST a webhook payload to the URL specified whenever the webhook's event is triggered. Webhooks are great for processing many inbound emails and responding to other events at scale. Customize the payload sent to your endpoint by setting the `requestBodyTemplate` property to a string with moustache style variables. Property names from the standard payload model for the given event are available as variables.

type DeleteAllWebhooksOpts 

type DeleteAllWebhooksOpts struct {
	Before optional.Time
}

DeleteAllWebhooksOpts Optional parameters for the method 'DeleteAllWebhooks'

type DeleteDevicePreviewRunResult 

type DeleteDevicePreviewRunResult struct {
	RunId                  string `json:"runId"`
	Deleted                bool   `json:"deleted"`
	RemoteCleanupAttempted bool   `json:"remoteCleanupAttempted"`
	RemoteCleanupSucceeded bool   `json:"remoteCleanupSucceeded"`
}

DeleteDevicePreviewRunResult struct for DeleteDevicePreviewRunResult

type DeleteInboxForwardersOpts 

type DeleteInboxForwardersOpts struct {
	InboxId optional.Interface
}

DeleteInboxForwardersOpts Optional parameters for the method 'DeleteInboxForwarders'

type DeleteInboxRepliersOpts 

type DeleteInboxRepliersOpts struct {
	InboxId optional.Interface
}

DeleteInboxRepliersOpts Optional parameters for the method 'DeleteInboxRepliers'

type DeleteResult 

type DeleteResult struct {
	Status string `json:"status"`
}

DeleteResult struct for DeleteResult

type DeleteRulesetsOpts 

type DeleteRulesetsOpts struct {
	InboxId optional.Interface
	PhoneId optional.Interface
}

DeleteRulesetsOpts Optional parameters for the method 'DeleteRulesets'

type DeleteSentSmsMessagesOpts 

type DeleteSentSmsMessagesOpts struct {
	PhoneNumberId optional.Interface
}

DeleteSentSmsMessagesOpts Optional parameters for the method 'DeleteSentSmsMessages'

type DeleteSmsMessagesOpts 

type DeleteSmsMessagesOpts struct {
	PhoneNumberId optional.Interface
}

DeleteSmsMessagesOpts Optional parameters for the method 'DeleteSmsMessages'

type DeliverabilityAnalyticsRunDto 

type DeliverabilityAnalyticsRunDto struct {
	Id                      string     `json:"id"`
	Name                    *string    `json:"name,omitempty"`
	Scope                   string     `json:"scope"`
	Status                  string     `json:"status"`
	CreatedAt               time.Time  `json:"createdAt"`
	StartAt                 time.Time  `json:"startAt"`
	CompletedAt             *time.Time `json:"completedAt,omitempty"`
	TotalEntities           int64      `json:"totalEntities"`
	MatchedEntities         int64      `json:"matchedEntities"`
	UnmatchedEntities       int64      `json:"unmatchedEntities"`
	CompletionPercentage    float64    `json:"completionPercentage"`
	SuccessThresholdPercent *float64   `json:"successThresholdPercent,omitempty"`
	ThresholdStatus         string     `json:"thresholdStatus"`
}

DeliverabilityAnalyticsRunDto Run-level metrics for analytics tables

type DeliverabilityAnalyticsSeriesDto 

type DeliverabilityAnalyticsSeriesDto struct {
	Since   time.Time                               `json:"since"`
	Before  time.Time                               `json:"before"`
	Scope   *string                                 `json:"scope,omitempty"`
	Bucket  string                                  `json:"bucket"`
	Summary DeliverabilityAnalyticsSummaryDto       `json:"summary"`
	Runs    []DeliverabilityAnalyticsRunDto         `json:"runs"`
	Points  []DeliverabilityAnalyticsSeriesPointDto `json:"points"`
}

DeliverabilityAnalyticsSeriesDto Deliverability analytics response for time-range comparison

type DeliverabilityAnalyticsSeriesPointDto 

type DeliverabilityAnalyticsSeriesPointDto struct {
	BucketStart time.Time                         `json:"bucketStart"`
	BucketEnd   time.Time                         `json:"bucketEnd"`
	Metrics     DeliverabilityAnalyticsSummaryDto `json:"metrics"`
}

DeliverabilityAnalyticsSeriesPointDto Bucketed deliverability analytics point for charts/tables

type DeliverabilityAnalyticsSummaryDto 

type DeliverabilityAnalyticsSummaryDto struct {
	TotalRuns                   int64   `json:"totalRuns"`
	CompleteRuns                int64   `json:"completeRuns"`
	FailedRuns                  int64   `json:"failedRuns"`
	StoppedRuns                 int64   `json:"stoppedRuns"`
	RunningRuns                 int64   `json:"runningRuns"`
	ScheduledRuns               int64   `json:"scheduledRuns"`
	PausedRuns                  int64   `json:"pausedRuns"`
	CreatedRuns                 int64   `json:"createdRuns"`
	ThresholdConfiguredRuns     int64   `json:"thresholdConfiguredRuns"`
	ThresholdMetRuns            int64   `json:"thresholdMetRuns"`
	AverageCompletionPercentage float64 `json:"averageCompletionPercentage"`
	AverageMatchedEntities      float64 `json:"averageMatchedEntities"`
	AverageUnmatchedEntities    float64 `json:"averageUnmatchedEntities"`
}

DeliverabilityAnalyticsSummaryDto Aggregated deliverability metrics for a given set of runs

type DeliverabilityEntityResultDto 

type DeliverabilityEntityResultDto struct {
	EntityId                string                               `json:"entityId"`
	EntityLabel             string                               `json:"entityLabel"`
	Matched                 bool                                 `json:"matched"`
	MatchedExpectationCount int32                                `json:"matchedExpectationCount"`
	TotalExpectationCount   int32                                `json:"totalExpectationCount"`
	PhoneCountry            *string                              `json:"phoneCountry,omitempty"`
	PhoneVariant            *string                              `json:"phoneVariant,omitempty"`
	EvaluatedAt             *time.Time                           `json:"evaluatedAt,omitempty"`
	ExpectationResults      []DeliverabilityExpectationResultDto `json:"expectationResults"`
}

DeliverabilityEntityResultDto Entity-level deliverability result

type DeliverabilityEntityResultPageDto 

type DeliverabilityEntityResultPageDto struct {
	Test          DeliverabilityTestDto           `json:"test"`
	Content       []DeliverabilityEntityResultDto `json:"content"`
	Page          int32                           `json:"page"`
	Size          int32                           `json:"size"`
	TotalElements int64                           `json:"totalElements"`
	TotalPages    int32                           `json:"totalPages"`
	Matched       *bool                           `json:"matched,omitempty"`
	Cached        bool                            `json:"cached"`
	NextRefreshAt *time.Time                      `json:"nextRefreshAt,omitempty"`
}

DeliverabilityEntityResultPageDto Paged entity results for a deliverability test

type DeliverabilityExpectation 

type DeliverabilityExpectation struct {
	// Optional label for this expectation
	Name *string `json:"name,omitempty"`
	// Minimum number of matching messages required for this expectation to pass
	MinCount int64 `json:"minCount"`
	// Optional sender filter. Matching is case-insensitive contains against inbound sender/from values.
	From *string `json:"from,omitempty"`
	// Optional recipient filter. Matching is case-insensitive contains against recipient/to values.
	To *string `json:"to,omitempty"`
	// Optional subject filter for INBOX scope tests. Ignored for PHONE scope tests.
	Subject *string `json:"subject,omitempty"`
}

DeliverabilityExpectation Single expectation to evaluate against each selected entity

type DeliverabilityExpectationResultDto 

type DeliverabilityExpectationResultDto struct {
	ExpectationIndex int32   `json:"expectationIndex"`
	ExpectationName  *string `json:"expectationName,omitempty"`
	MinCount         int64   `json:"minCount"`
	ActualCount      int64   `json:"actualCount"`
	Passed           bool    `json:"passed"`
	From             *string `json:"from,omitempty"`
	To               *string `json:"to,omitempty"`
	Subject          *string `json:"subject,omitempty"`
}

DeliverabilityExpectationResultDto Expectation evaluation result for a single entity

type DeliverabilityFailureEntityHotspotDto 

type DeliverabilityFailureEntityHotspotDto struct {
	EntityId              string  `json:"entityId"`
	EntityLabel           string  `json:"entityLabel"`
	Scope                 string  `json:"scope"`
	PhoneCountry          *string `json:"phoneCountry,omitempty"`
	PhoneVariant          *string `json:"phoneVariant,omitempty"`
	FailedRunCount        int64   `json:"failedRunCount"`
	TotalRunCount         int64   `json:"totalRunCount"`
	FailureRatePercentage float64 `json:"failureRatePercentage"`
}

DeliverabilityFailureEntityHotspotDto Most common failing entity across deliverability runs

type DeliverabilityFailureHotspotsDto 

type DeliverabilityFailureHotspotsDto struct {
	Since                  time.Time                                       `json:"since"`
	Before                 time.Time                                       `json:"before"`
	Scope                  *string                                         `json:"scope,omitempty"`
	EntityHotspots         []DeliverabilityFailureEntityHotspotDto         `json:"entityHotspots"`
	PhoneDimensionHotspots []DeliverabilityFailurePhoneDimensionHotspotDto `json:"phoneDimensionHotspots"`
}

DeliverabilityFailureHotspotsDto Deliverability failure hotspot response for range comparisons

type DeliverabilityFailurePhoneDimensionHotspotDto 

type DeliverabilityFailurePhoneDimensionHotspotDto struct {
	PhoneCountry          *string `json:"phoneCountry,omitempty"`
	PhoneVariant          *string `json:"phoneVariant,omitempty"`
	FailedRunCount        int64   `json:"failedRunCount"`
	TotalRunCount         int64   `json:"totalRunCount"`
	FailureRatePercentage float64 `json:"failureRatePercentage"`
}

DeliverabilityFailurePhoneDimensionHotspotDto Most common failing phone country/variant dimensions

type DeliverabilityPollStatusResultDto 

type DeliverabilityPollStatusResultDto struct {
	Test               DeliverabilityTestDto `json:"test"`
	Cached             bool                  `json:"cached"`
	CacheWindowSeconds int64                 `json:"cacheWindowSeconds"`
	NextRefreshAt      *time.Time            `json:"nextRefreshAt,omitempty"`
}

DeliverabilityPollStatusResultDto Polling response for deliverability test progress

type DeliverabilitySelectorOptions 

type DeliverabilitySelectorOptions struct {
	// Selection mode
	Type string `json:"type"`
	// Wildcard pattern for PATTERN selection. Supports '*' and '?' wildcards. If no wildcard is present the value is treated as a case-insensitive contains match.
	Pattern *string `json:"pattern,omitempty"`
	// Optional phone-country filter for PHONE scope selection (e.g. ALL phones in US). Must be null for INBOX scope.
	PhoneCountry *string `json:"phoneCountry,omitempty"`
	// Explicit entity IDs for EXPLICIT selection
	EntityIds *[]string `json:"entityIds,omitempty"`
	// Optional entity IDs to exclude from the resolved selection (applies after ALL/PATTERN/EXPLICIT selection).
	ExcludeEntityIds *[]string `json:"excludeEntityIds,omitempty"`
}

DeliverabilitySelectorOptions How entities are selected for a deliverability test

type DeliverabilitySimulationEmailOptions 

type DeliverabilitySimulationEmailOptions struct {
	// Optional from override for each sent email
	FromOverride *string `json:"fromOverride,omitempty"`
	// Optional email subject fallback used when template subject is omitted
	Subject *string `json:"subject,omitempty"`
	// Optional email body template. Supports {{targetLabel}}, {{sendIndex}}, {{attempt}}.
	BodyTemplate *string `json:"bodyTemplate,omitempty"`
}

DeliverabilitySimulationEmailOptions Simulation options for email deliverability tests

type DeliverabilitySimulationJobConfigDto 

type DeliverabilitySimulationJobConfigDto struct {
	SenderInboxId     *string `json:"senderInboxId,omitempty"`
	SenderPhoneId     *string `json:"senderPhoneId,omitempty"`
	EmailSubject      *string `json:"emailSubject,omitempty"`
	EmailFromOverride *string `json:"emailFromOverride,omitempty"`
	EmailBodyTemplate *string `json:"emailBodyTemplate,omitempty"`
	SmsBodyTemplate   *string `json:"smsBodyTemplate,omitempty"`
	DelayMs           int64   `json:"delayMs"`
	BatchSize         int32   `json:"batchSize"`
	SendsPerTarget    int64   `json:"sendsPerTarget"`
}

DeliverabilitySimulationJobConfigDto Simulation job configuration snapshot

type DeliverabilitySimulationJobDto 

type DeliverabilitySimulationJobDto struct {
	Id                   string                                     `json:"id"`
	TestId               string                                     `json:"testId"`
	Scope                string                                     `json:"scope"`
	Status               string                                     `json:"status"`
	CreatedAt            time.Time                                  `json:"createdAt"`
	UpdatedAt            time.Time                                  `json:"updatedAt"`
	StartedAt            *time.Time                                 `json:"startedAt,omitempty"`
	CompletedAt          *time.Time                                 `json:"completedAt,omitempty"`
	TotalTargets         int64                                      `json:"totalTargets"`
	TotalPlannedSends    int64                                      `json:"totalPlannedSends"`
	NextSendIndex        int64                                      `json:"nextSendIndex"`
	SentCount            int64                                      `json:"sentCount"`
	SuccessCount         int64                                      `json:"successCount"`
	FailureCount         int64                                      `json:"failureCount"`
	ProgressPercent      float64                                    `json:"progressPercent"`
	ActiveTargetLabel    *string                                    `json:"activeTargetLabel,omitempty"`
	EstimatedRemainingMs *int64                                     `json:"estimatedRemainingMs,omitempty"`
	ConfigSnapshot       DeliverabilitySimulationJobConfigDto       `json:"configSnapshot"`
	ErrorSummary         DeliverabilitySimulationJobErrorSummaryDto `json:"errorSummary"`
}

DeliverabilitySimulationJobDto Deliverability simulation job status

type DeliverabilitySimulationJobErrorSummaryDto 

type DeliverabilitySimulationJobErrorSummaryDto struct {
	LastError *string                                  `json:"lastError,omitempty"`
	TopErrors []DeliverabilitySimulationJobTopErrorDto `json:"topErrors"`
}

DeliverabilitySimulationJobErrorSummaryDto Simulation error summary

type DeliverabilitySimulationJobEventDto 

type DeliverabilitySimulationJobEventDto struct {
	Id              string    `json:"id"`
	EventType       string    `json:"eventType"`
	SendIndex       *int64    `json:"sendIndex,omitempty"`
	EntityId        *string   `json:"entityId,omitempty"`
	TargetLabel     *string   `json:"targetLabel,omitempty"`
	ExpectationName *string   `json:"expectationName,omitempty"`
	Attempt         *int32    `json:"attempt,omitempty"`
	Message         *string   `json:"message,omitempty"`
	Error           *string   `json:"error,omitempty"`
	CreatedAt       time.Time `json:"createdAt"`
}

DeliverabilitySimulationJobEventDto Single event for a deliverability simulation job

type DeliverabilitySimulationJobEventPageDto 

type DeliverabilitySimulationJobEventPageDto struct {
	Job           DeliverabilitySimulationJobDto        `json:"job"`
	Content       []DeliverabilitySimulationJobEventDto `json:"content"`
	Page          int32                                 `json:"page"`
	Size          int32                                 `json:"size"`
	TotalElements int64                                 `json:"totalElements"`
	TotalPages    int32                                 `json:"totalPages"`
}

DeliverabilitySimulationJobEventPageDto Paged simulation events

type DeliverabilitySimulationJobTopErrorDto 

type DeliverabilitySimulationJobTopErrorDto struct {
	Message string `json:"message"`
	Count   int64  `json:"count"`
}

DeliverabilitySimulationJobTopErrorDto Top simulation error summary item

type DeliverabilitySimulationSmsOptions 

type DeliverabilitySimulationSmsOptions struct {
	// Optional SMS body template. Supports {{targetLabel}}, {{sendIndex}}, {{attempt}}.
	BodyTemplate *string `json:"bodyTemplate,omitempty"`
}

DeliverabilitySimulationSmsOptions Simulation options for SMS deliverability tests

type DeliverabilityTestControllerApiService 

type DeliverabilityTestControllerApiService service

DeliverabilityTestControllerApiService DeliverabilityTestControllerApi service

func (*DeliverabilityTestControllerApiService) CancelDeliverabilitySimulationJob 

func (a *DeliverabilityTestControllerApiService) CancelDeliverabilitySimulationJob(ctx _context.Context, testId string, jobId string) (DeliverabilitySimulationJobDto, *_nethttp.Response, error)

CancelDeliverabilitySimulationJob Cancel deliverability simulation job Cancel a running or paused simulation job.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testId
  • @param jobId

@return DeliverabilitySimulationJobDto

func (*DeliverabilityTestControllerApiService) CreateDeliverabilitySimulationJob 

func (a *DeliverabilityTestControllerApiService) CreateDeliverabilitySimulationJob(ctx _context.Context, testId string, createDeliverabilitySimulationJobOptions CreateDeliverabilitySimulationJobOptions) (DeliverabilitySimulationJobDto, *_nethttp.Response, error)

CreateDeliverabilitySimulationJob Create deliverability simulation job Create and start a simulation job for a running deliverability test. Only one active simulation job is allowed per user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testId
  • @param createDeliverabilitySimulationJobOptions

@return DeliverabilitySimulationJobDto

func (*DeliverabilityTestControllerApiService) CreateDeliverabilityTest 

func (a *DeliverabilityTestControllerApiService) CreateDeliverabilityTest(ctx _context.Context, createDeliverabilityTestOptions CreateDeliverabilityTestOptions) (DeliverabilityTestDto, *_nethttp.Response, error)

CreateDeliverabilityTest Create deliverability/load test Create a deliverability test for inboxes or phone numbers using ALL, PATTERN, or EXPLICIT selector scope.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createDeliverabilityTestOptions

@return DeliverabilityTestDto

func (*DeliverabilityTestControllerApiService) DeleteDeliverabilityTest 

func (a *DeliverabilityTestControllerApiService) DeleteDeliverabilityTest(ctx _context.Context, testId string) (DeleteResult, *_nethttp.Response, error)

DeleteDeliverabilityTest Delete deliverability/load test Delete test and all persisted entity-level results.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testId

@return DeleteResult

func (*DeliverabilityTestControllerApiService) DuplicateDeliverabilityTest 

func (a *DeliverabilityTestControllerApiService) DuplicateDeliverabilityTest(ctx _context.Context, testId string) (DeliverabilityTestDto, *_nethttp.Response, error)

DuplicateDeliverabilityTest Duplicate deliverability/load test Create a fresh deliverability test using an existing test configuration, including selector scope, exclusions, and expectations.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testId

@return DeliverabilityTestDto

func (*DeliverabilityTestControllerApiService) ExportDeliverabilityTestReport 

func (a *DeliverabilityTestControllerApiService) ExportDeliverabilityTestReport(ctx _context.Context, testId string) (*_nethttp.Response, error)

ExportDeliverabilityTestReport Export deliverability/load test report as PDF Export a PDF report for a terminal deliverability test (COMPLETE, FAILED, or STOPPED), including configuration, summary outcomes, and detailed entity-level results.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testId

func (*DeliverabilityTestControllerApiService) ExportDeliverabilityTestResults 

func (a *DeliverabilityTestControllerApiService) ExportDeliverabilityTestResults(ctx _context.Context, testId string, localVarOptionals *ExportDeliverabilityTestResultsOpts) (*_nethttp.Response, error)

ExportDeliverabilityTestResults Export deliverability/load test entity results as CSV Export per-entity deliverability results including expectation-level pass/fail counts. The latest status is evaluated with the same polling safeguards before export.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testId
  • @param optional nil or *ExportDeliverabilityTestResultsOpts - Optional Parameters:
  • @param "Matched" (optional.Bool) -

func (*DeliverabilityTestControllerApiService) GetDeliverabilityAnalyticsSeries 

func (a *DeliverabilityTestControllerApiService) GetDeliverabilityAnalyticsSeries(ctx _context.Context, localVarOptionals *GetDeliverabilityAnalyticsSeriesOpts) (DeliverabilityAnalyticsSeriesDto, *_nethttp.Response, error)

GetDeliverabilityAnalyticsSeries Get deliverability analytics time series Compare deliverability runs over a time range with bucketed chart metrics and run-level rows for table views.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetDeliverabilityAnalyticsSeriesOpts - Optional Parameters:
  • @param "Since" (optional.Time) -
  • @param "Before" (optional.Time) -
  • @param "Scope" (optional.String) -
  • @param "Bucket" (optional.String) -
  • @param "RunLimit" (optional.Int32) -

@return DeliverabilityAnalyticsSeriesDto

func (*DeliverabilityTestControllerApiService) GetDeliverabilityFailureHotspots 

func (a *DeliverabilityTestControllerApiService) GetDeliverabilityFailureHotspots(ctx _context.Context, localVarOptionals *GetDeliverabilityFailureHotspotsOpts) (DeliverabilityFailureHotspotsDto, *_nethttp.Response, error)

GetDeliverabilityFailureHotspots Get deliverability failure hotspots Find commonly failing entities and phone country/variant dimensions across deliverability runs in a time range.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetDeliverabilityFailureHotspotsOpts - Optional Parameters:
  • @param "Since" (optional.Time) -
  • @param "Before" (optional.Time) -
  • @param "Scope" (optional.String) -
  • @param "Limit" (optional.Int32) -

@return DeliverabilityFailureHotspotsDto

func (*DeliverabilityTestControllerApiService) GetDeliverabilitySimulationJob 

func (a *DeliverabilityTestControllerApiService) GetDeliverabilitySimulationJob(ctx _context.Context, testId string, jobId string) (DeliverabilitySimulationJobDto, *_nethttp.Response, error)

GetDeliverabilitySimulationJob Get deliverability simulation job Get simulation job status and progress counters.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testId
  • @param jobId

@return DeliverabilitySimulationJobDto

func (*DeliverabilityTestControllerApiService) GetDeliverabilitySimulationJobEvents 

func (a *DeliverabilityTestControllerApiService) GetDeliverabilitySimulationJobEvents(ctx _context.Context, testId string, jobId string, localVarOptionals *GetDeliverabilitySimulationJobEventsOpts) (DeliverabilitySimulationJobEventPageDto, *_nethttp.Response, error)

GetDeliverabilitySimulationJobEvents Get deliverability simulation job events Get paged simulation events including send successes and failures.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testId
  • @param jobId
  • @param optional nil or *GetDeliverabilitySimulationJobEventsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) -
  • @param "Size" (optional.Int32) -
  • @param "Sort" (optional.String) -

@return DeliverabilitySimulationJobEventPageDto

func (*DeliverabilityTestControllerApiService) GetDeliverabilityTest 

func (a *DeliverabilityTestControllerApiService) GetDeliverabilityTest(ctx _context.Context, testId string) (DeliverabilityTestDto, *_nethttp.Response, error)

GetDeliverabilityTest Get deliverability/load test Get deliverability test configuration and latest progress counters.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testId

@return DeliverabilityTestDto

func (*DeliverabilityTestControllerApiService) GetDeliverabilityTestResults 

func (a *DeliverabilityTestControllerApiService) GetDeliverabilityTestResults(ctx _context.Context, testId string, localVarOptionals *GetDeliverabilityTestResultsOpts) (DeliverabilityEntityResultPageDto, *_nethttp.Response, error)

GetDeliverabilityTestResults Get deliverability/load test entity results Get paged per-entity expectation results with optional matched/unmatched filtering.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testId
  • @param optional nil or *GetDeliverabilityTestResultsOpts - Optional Parameters:
  • @param "Matched" (optional.Bool) -
  • @param "Page" (optional.Int32) -
  • @param "Size" (optional.Int32) -
  • @param "Sort" (optional.String) -

@return DeliverabilityEntityResultPageDto

func (*DeliverabilityTestControllerApiService) GetDeliverabilityTests 

func (a *DeliverabilityTestControllerApiService) GetDeliverabilityTests(ctx _context.Context, localVarOptionals *GetDeliverabilityTestsOpts) (DeliverabilityTestPageDto, *_nethttp.Response, error)

GetDeliverabilityTests List deliverability/load tests List deliverability tests for the authenticated account.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetDeliverabilityTestsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Page index
  • @param "Size" (optional.Int32) - Page size
  • @param "Sort" (optional.String) - Sort direction

@return DeliverabilityTestPageDto

func (*DeliverabilityTestControllerApiService) GetLatestDeliverabilitySimulationJob 

func (a *DeliverabilityTestControllerApiService) GetLatestDeliverabilitySimulationJob(ctx _context.Context, testId string) (DeliverabilitySimulationJobDto, *_nethttp.Response, error)

GetLatestDeliverabilitySimulationJob Get latest deliverability simulation job Get the most recent simulation job for a deliverability test.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testId

@return DeliverabilitySimulationJobDto

func (*DeliverabilityTestControllerApiService) PauseDeliverabilitySimulationJob 

func (a *DeliverabilityTestControllerApiService) PauseDeliverabilitySimulationJob(ctx _context.Context, testId string, jobId string) (DeliverabilitySimulationJobDto, *_nethttp.Response, error)

PauseDeliverabilitySimulationJob Pause deliverability simulation job Pause a running simulation job.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testId
  • @param jobId

@return DeliverabilitySimulationJobDto

func (*DeliverabilityTestControllerApiService) PauseDeliverabilityTest 

func (a *DeliverabilityTestControllerApiService) PauseDeliverabilityTest(ctx _context.Context, testId string) (DeliverabilityTestDto, *_nethttp.Response, error)

PauseDeliverabilityTest Pause deliverability/load test Pause a RUNNING or SCHEDULED deliverability test.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testId

@return DeliverabilityTestDto

func (*DeliverabilityTestControllerApiService) PollDeliverabilityTestStatus 

func (a *DeliverabilityTestControllerApiService) PollDeliverabilityTestStatus(ctx _context.Context, testId string) (DeliverabilityPollStatusResultDto, *_nethttp.Response, error)

PollDeliverabilityTestStatus Poll deliverability/load test status Poll test progress. Evaluation is throttled with a 5-second cache window to protect backing data stores.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testId

@return DeliverabilityPollStatusResultDto

func (*DeliverabilityTestControllerApiService) ResumeDeliverabilitySimulationJob 

func (a *DeliverabilityTestControllerApiService) ResumeDeliverabilitySimulationJob(ctx _context.Context, testId string, jobId string) (DeliverabilitySimulationJobDto, *_nethttp.Response, error)

ResumeDeliverabilitySimulationJob Resume deliverability simulation job Resume a paused simulation job.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testId
  • @param jobId

@return DeliverabilitySimulationJobDto

func (*DeliverabilityTestControllerApiService) StartDeliverabilityTest 

func (a *DeliverabilityTestControllerApiService) StartDeliverabilityTest(ctx _context.Context, testId string) (DeliverabilityTestDto, *_nethttp.Response, error)

StartDeliverabilityTest Start or resume deliverability/load test Start a CREATED test or resume a PAUSED/SCHEDULED test.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testId

@return DeliverabilityTestDto

func (*DeliverabilityTestControllerApiService) StopDeliverabilityTest 

func (a *DeliverabilityTestControllerApiService) StopDeliverabilityTest(ctx _context.Context, testId string) (DeliverabilityTestDto, *_nethttp.Response, error)

StopDeliverabilityTest Stop deliverability/load test Stop a deliverability test and mark it terminal.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testId

@return DeliverabilityTestDto

func (*DeliverabilityTestControllerApiService) UpdateDeliverabilityTest 

func (a *DeliverabilityTestControllerApiService) UpdateDeliverabilityTest(ctx _context.Context, testId string, updateDeliverabilityTestOptions UpdateDeliverabilityTestOptions) (DeliverabilityTestDto, *_nethttp.Response, error)

UpdateDeliverabilityTest Update deliverability/load test Update metadata, timeout, and expectations for a non-running non-terminal test.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testId
  • @param updateDeliverabilityTestOptions

@return DeliverabilityTestDto

type DeliverabilityTestDto 

type DeliverabilityTestDto struct {
	Id                      string                        `json:"id"`
	Name                    *string                       `json:"name,omitempty"`
	Description             *string                       `json:"description,omitempty"`
	Scope                   string                        `json:"scope"`
	Selector                DeliverabilitySelectorOptions `json:"selector"`
	SelectedEntityCount     int64                         `json:"selectedEntityCount"`
	Expectations            []DeliverabilityExpectation   `json:"expectations"`
	Status                  string                        `json:"status"`
	StartAt                 time.Time                     `json:"startAt"`
	StartedAt               *time.Time                    `json:"startedAt,omitempty"`
	CompletedAt             *time.Time                    `json:"completedAt,omitempty"`
	MaxDurationSeconds      *int64                        `json:"maxDurationSeconds,omitempty"`
	SuccessThresholdPercent *float64                      `json:"successThresholdPercent,omitempty"`
	ThresholdStatus         string                        `json:"thresholdStatus"`
	ThresholdMet            *bool                         `json:"thresholdMet,omitempty"`
	LastEvaluatedAt         *time.Time                    `json:"lastEvaluatedAt,omitempty"`
	TotalEntities           int64                         `json:"totalEntities"`
	MatchedEntities         int64                         `json:"matchedEntities"`
	UnmatchedEntities       int64                         `json:"unmatchedEntities"`
	CompletionPercentage    float64                       `json:"completionPercentage"`
	TimedOut                bool                          `json:"timedOut"`
	FailureReason           *string                       `json:"failureReason,omitempty"`
	CreatedAt               time.Time                     `json:"createdAt"`
	UpdatedAt               time.Time                     `json:"updatedAt"`
}

DeliverabilityTestDto Deliverability test configuration and progress summary

type DeliverabilityTestPageDto 

type DeliverabilityTestPageDto struct {
	Content       []DeliverabilityTestDto `json:"content"`
	Page          int32                   `json:"page"`
	Size          int32                   `json:"size"`
	TotalElements int64                   `json:"totalElements"`
	TotalPages    int32                   `json:"totalPages"`
}

DeliverabilityTestPageDto Paged list of deliverability tests

type DeliveryStatusDto 

type DeliveryStatusDto struct {
	Id                   string    `json:"id"`
	UserId               string    `json:"userId"`
	SentId               string    `json:"sentId,omitempty"`
	RemoteMtaIp          string    `json:"remoteMtaIp,omitempty"`
	InboxId              string    `json:"inboxId,omitempty"`
	ReportingMta         string    `json:"reportingMta,omitempty"`
	Recipients           []string  `json:"recipients,omitempty"`
	SmtpResponse         string    `json:"smtpResponse,omitempty"`
	SmtpStatusCode       int32     `json:"smtpStatusCode,omitempty"`
	ProcessingTimeMillis int64     `json:"processingTimeMillis,omitempty"`
	Received             time.Time `json:"received,omitempty"`
	Subject              string    `json:"subject,omitempty"`
	CreatedAt            time.Time `json:"createdAt"`
	UpdatedAt            time.Time `json:"updatedAt"`
}

DeliveryStatusDto struct for DeliveryStatusDto

type DescribeDomainOptions 

type DescribeDomainOptions struct {
	Domain string `json:"domain"`
}

DescribeDomainOptions Domain record description

type DescribeMailServerDomainResult 

type DescribeMailServerDomainResult struct {
	MxRecords []NameServerRecord `json:"mxRecords"`
	Domain    string             `json:"domain"`
	Message   *string            `json:"message,omitempty"`
}

DescribeMailServerDomainResult Name Server lookup result

type DevicePreviewFeedbackDto 

type DevicePreviewFeedbackDto struct {
	FeedbackId   string            `json:"feedbackId"`
	UserId       string            `json:"userId"`
	Source       string            `json:"source"`
	Category     string            `json:"category"`
	Status       string            `json:"status"`
	Rating       int32             `json:"rating,omitempty"`
	RunId        string            `json:"runId,omitempty"`
	TargetId     string            `json:"targetId,omitempty"`
	ScreenshotId string            `json:"screenshotId,omitempty"`
	Provider     string            `json:"provider,omitempty"`
	Title        string            `json:"title,omitempty"`
	Comment      string            `json:"comment,omitempty"`
	InternalNote string            `json:"internalNote,omitempty"`
	SessionId    string            `json:"sessionId,omitempty"`
	LiveViewUrl  string            `json:"liveViewUrl,omitempty"`
	Metadata     map[string]string `json:"metadata,omitempty"`
	CreatedAt    time.Time         `json:"createdAt,omitempty"`
	UpdatedAt    time.Time         `json:"updatedAt,omitempty"`
}

DevicePreviewFeedbackDto struct for DevicePreviewFeedbackDto

type DevicePreviewFeedbackListDto 

type DevicePreviewFeedbackListDto struct {
	TotalElements int64                      `json:"totalElements"`
	Page          int32                      `json:"page"`
	Size          int32                      `json:"size"`
	Items         []DevicePreviewFeedbackDto `json:"items"`
}

DevicePreviewFeedbackListDto struct for DevicePreviewFeedbackListDto

type DevicePreviewProviderProgressDto 

type DevicePreviewProviderProgressDto struct {
	Run            DevicePreviewRunDto          `json:"run"`
	Provider       string                       `json:"provider"`
	Status         string                       `json:"status"`
	TargetCount    int64                        `json:"targetCount"`
	ReadyCount     int64                        `json:"readyCount"`
	FailedCount    int64                        `json:"failedCount"`
	CapturingCount int64                        `json:"capturingCount"`
	PendingCount   int64                        `json:"pendingCount"`
	Targets        []DevicePreviewTargetDto     `json:"targets"`
	Screenshots    []DevicePreviewScreenshotDto `json:"screenshots"`
}

DevicePreviewProviderProgressDto struct for DevicePreviewProviderProgressDto

type DevicePreviewRunDto 

type DevicePreviewRunDto struct {
	RunId               string            `json:"runId"`
	EmailId             string            `json:"emailId"`
	Status              string            `json:"status"`
	PrimaryScreenshotId string            `json:"primaryScreenshotId,omitempty"`
	RequestedProviders  []string          `json:"requestedProviders,omitempty"`
	ImportedProviders   []string          `json:"importedProviders,omitempty"`
	Warnings            []string          `json:"warnings,omitempty"`
	ProviderMessageIds  map[string]string `json:"providerMessageIds,omitempty"`
	TargetCount         int64             `json:"targetCount"`
	ScreenshotCount     int64             `json:"screenshotCount"`
	CreatedAt           time.Time         `json:"createdAt"`
	UpdatedAt           time.Time         `json:"updatedAt"`
}

DevicePreviewRunDto struct for DevicePreviewRunDto

type DevicePreviewRunResultsDto 

type DevicePreviewRunResultsDto struct {
	Run         DevicePreviewRunDto          `json:"run"`
	Targets     []DevicePreviewTargetDto     `json:"targets"`
	Screenshots []DevicePreviewScreenshotDto `json:"screenshots"`
}

DevicePreviewRunResultsDto struct for DevicePreviewRunResultsDto

type DevicePreviewScreenshotDto 

type DevicePreviewScreenshotDto struct {
	ScreenshotId     string    `json:"screenshotId"`
	RunId            string    `json:"runId"`
	TargetId         string    `json:"targetId,omitempty"`
	Variant          string    `json:"variant,omitempty"`
	Title            string    `json:"title,omitempty"`
	Description      string    `json:"description,omitempty"`
	IsPrimary        bool      `json:"isPrimary"`
	DisplayOrder     int32     `json:"displayOrder"`
	StorageKey       string    `json:"storageKey,omitempty"`
	AccessUrl        string    `json:"accessUrl,omitempty"`
	LiveViewUrl      string    `json:"liveViewUrl,omitempty"`
	SessionId        string    `json:"sessionId,omitempty"`
	BrowserContextId string    `json:"browserContextId,omitempty"`
	DeepLinkUrl      string    `json:"deepLinkUrl,omitempty"`
	Width            int32     `json:"width,omitempty"`
	Height           int32     `json:"height,omitempty"`
	CreatedAt        time.Time `json:"createdAt"`
	UpdatedAt        time.Time `json:"updatedAt"`
}

DevicePreviewScreenshotDto struct for DevicePreviewScreenshotDto

type DevicePreviewTargetDto 

type DevicePreviewTargetDto struct {
	Id                  string    `json:"id"`
	RunId               string    `json:"runId"`
	Provider            string    `json:"provider,omitempty"`
	ClientProfile       string    `json:"clientProfile,omitempty"`
	DeviceType          string    `json:"deviceType,omitempty"`
	BrowserFamily       string    `json:"browserFamily,omitempty"`
	Platform            string    `json:"platform,omitempty"`
	ColorScheme         string    `json:"colorScheme,omitempty"`
	Status              string    `json:"status,omitempty"`
	FailureCode         string    `json:"failureCode,omitempty"`
	PrimaryScreenshotId string    `json:"primaryScreenshotId,omitempty"`
	CreatedAt           time.Time `json:"createdAt"`
	UpdatedAt           time.Time `json:"updatedAt"`
}

DevicePreviewTargetDto struct for DevicePreviewTargetDto

type DevicePreviewsControllerApiService 

type DevicePreviewsControllerApiService service

DevicePreviewsControllerApiService DevicePreviewsControllerApi service

func (*DevicePreviewsControllerApiService) CancelDevicePreviewRun 

func (a *DevicePreviewsControllerApiService) CancelDevicePreviewRun(ctx _context.Context, runId string, localVarOptionals *CancelDevicePreviewRunOpts) (CancelDevicePreviewRunResult, *_nethttp.Response, error)

CancelDevicePreviewRun Cancel a running device preview run

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param runId
  • @param optional nil or *CancelDevicePreviewRunOpts - Optional Parameters:
  • @param "CancelDevicePreviewRunOptions" (optional.Interface of CancelDevicePreviewRunOptions) -

@return CancelDevicePreviewRunResult

func (*DevicePreviewsControllerApiService) CreateDevicePreviewFeedback 

func (a *DevicePreviewsControllerApiService) CreateDevicePreviewFeedback(ctx _context.Context, createDevicePreviewFeedbackOptions CreateDevicePreviewFeedbackOptions) (DevicePreviewFeedbackDto, *_nethttp.Response, error)

CreateDevicePreviewFeedback Create device preview feedback

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createDevicePreviewFeedbackOptions

@return DevicePreviewFeedbackDto

func (*DevicePreviewsControllerApiService) CreateDevicePreviewRun 

func (a *DevicePreviewsControllerApiService) CreateDevicePreviewRun(ctx _context.Context, emailId string, localVarOptionals *CreateDevicePreviewRunOpts) (CreateDevicePreviewRunResult, *_nethttp.Response, error)

CreateDevicePreviewRun Create a new device preview run for an email

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId
  • @param optional nil or *CreateDevicePreviewRunOpts - Optional Parameters:
  • @param "CreateDevicePreviewOptions" (optional.Interface of CreateDevicePreviewOptions) -

@return CreateDevicePreviewRunResult

func (*DevicePreviewsControllerApiService) DeleteDevicePreviewRun 

func (a *DevicePreviewsControllerApiService) DeleteDevicePreviewRun(ctx _context.Context, runId string) (DeleteDevicePreviewRunResult, *_nethttp.Response, error)

DeleteDevicePreviewRun Delete local device preview run data

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param runId

@return DeleteDevicePreviewRunResult

func (*DevicePreviewsControllerApiService) EnsureDevicePreviewRun 

func (a *DevicePreviewsControllerApiService) EnsureDevicePreviewRun(ctx _context.Context, emailId string, localVarOptionals *EnsureDevicePreviewRunOpts) (CreateDevicePreviewRunResult, *_nethttp.Response, error)

EnsureDevicePreviewRun Return active run for email or create one when none exists

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId
  • @param optional nil or *EnsureDevicePreviewRunOpts - Optional Parameters:
  • @param "CreateDevicePreviewOptions" (optional.Interface of CreateDevicePreviewOptions) -

@return CreateDevicePreviewRunResult

func (*DevicePreviewsControllerApiService) GetDevicePreviewFeedback 

func (a *DevicePreviewsControllerApiService) GetDevicePreviewFeedback(ctx _context.Context, feedbackId string) (DevicePreviewFeedbackDto, *_nethttp.Response, error)

GetDevicePreviewFeedback Get a single device preview feedback item

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param feedbackId

@return DevicePreviewFeedbackDto

func (*DevicePreviewsControllerApiService) GetDevicePreviewFeedbackItems 

func (a *DevicePreviewsControllerApiService) GetDevicePreviewFeedbackItems(ctx _context.Context, localVarOptionals *GetDevicePreviewFeedbackItemsOpts) (DevicePreviewFeedbackListDto, *_nethttp.Response, error)

GetDevicePreviewFeedbackItems List device preview feedback

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetDevicePreviewFeedbackItemsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) -
  • @param "Size" (optional.Int32) -
  • @param "Source" (optional.String) -
  • @param "RunId" (optional.Interface of string) -
  • @param "Status" (optional.String) -
  • @param "Provider" (optional.String) -
  • @param "Category" (optional.String) -
  • @param "Search" (optional.String) -

@return DevicePreviewFeedbackListDto

func (*DevicePreviewsControllerApiService) GetDevicePreviewRun 

func (a *DevicePreviewsControllerApiService) GetDevicePreviewRun(ctx _context.Context, runId string) (DevicePreviewRunDto, *_nethttp.Response, error)

GetDevicePreviewRun Get device preview run status

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param runId

@return DevicePreviewRunDto

func (*DevicePreviewsControllerApiService) GetDevicePreviewRunProviderProgress 

func (a *DevicePreviewsControllerApiService) GetDevicePreviewRunProviderProgress(ctx _context.Context, runId string, provider string) (DevicePreviewProviderProgressDto, *_nethttp.Response, error)

GetDevicePreviewRunProviderProgress Get provider-level progress for a device preview run

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param runId
  • @param provider

@return DevicePreviewProviderProgressDto

func (*DevicePreviewsControllerApiService) GetDevicePreviewRunResults 

func (a *DevicePreviewsControllerApiService) GetDevicePreviewRunResults(ctx _context.Context, runId string) (DevicePreviewRunResultsDto, *_nethttp.Response, error)

GetDevicePreviewRunResults Get device preview run results

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param runId

@return DevicePreviewRunResultsDto

func (*DevicePreviewsControllerApiService) GetDevicePreviewRunScreenshot 

func (a *DevicePreviewsControllerApiService) GetDevicePreviewRunScreenshot(ctx _context.Context, runId string, screenshotId string) (string, *_nethttp.Response, error)

GetDevicePreviewRunScreenshot Get a seeded device preview screenshot image

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param runId
  • @param screenshotId

@return string

func (*DevicePreviewsControllerApiService) GetDevicePreviewRuns 

func (a *DevicePreviewsControllerApiService) GetDevicePreviewRuns(ctx _context.Context, emailId string, localVarOptionals *GetDevicePreviewRunsOpts) ([]DevicePreviewRunDto, *_nethttp.Response, error)

GetDevicePreviewRuns List previous device preview runs for an email

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId
  • @param optional nil or *GetDevicePreviewRunsOpts - Optional Parameters:
  • @param "Limit" (optional.Int32) -

@return []DevicePreviewRunDto

func (*DevicePreviewsControllerApiService) GetDevicePreviewRunsForAccount 

func (a *DevicePreviewsControllerApiService) GetDevicePreviewRunsForAccount(ctx _context.Context, localVarOptionals *GetDevicePreviewRunsForAccountOpts) ([]DevicePreviewRunDto, *_nethttp.Response, error)

GetDevicePreviewRunsForAccount List previous device preview runs for account

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetDevicePreviewRunsForAccountOpts - Optional Parameters:
  • @param "Limit" (optional.Int32) -

@return []DevicePreviewRunDto

func (*DevicePreviewsControllerApiService) GetDevicePreviewRunsOffsetPaginated 

func (a *DevicePreviewsControllerApiService) GetDevicePreviewRunsOffsetPaginated(ctx _context.Context, emailId string, localVarOptionals *GetDevicePreviewRunsOffsetPaginatedOpts) (PageDevicePreviewRunProjection, *_nethttp.Response, error)

GetDevicePreviewRunsOffsetPaginated List previous device preview runs for an email in paginated form

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId
  • @param optional nil or *GetDevicePreviewRunsOffsetPaginatedOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size for paginated result list.
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC

@return PageDevicePreviewRunProjection

func (*DevicePreviewsControllerApiService) UpdateDevicePreviewFeedback 

func (a *DevicePreviewsControllerApiService) UpdateDevicePreviewFeedback(ctx _context.Context, feedbackId string, updateDevicePreviewFeedbackOptions UpdateDevicePreviewFeedbackOptions) (DevicePreviewFeedbackDto, *_nethttp.Response, error)

UpdateDevicePreviewFeedback Update device preview feedback

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param feedbackId
  • @param updateDevicePreviewFeedbackOptions

@return DevicePreviewFeedbackDto

type DmarcReportMetadata 

type DmarcReportMetadata struct {
	OrgName         *string    `json:"orgName,omitempty"`
	Email           *string    `json:"email,omitempty"`
	ReportId        *string    `json:"reportId,omitempty"`
	Domain          *string    `json:"domain,omitempty"`
	Adkim           *string    `json:"adkim,omitempty"`
	Aspf            *string    `json:"aspf,omitempty"`
	Policy          *string    `json:"policy,omitempty"`
	SubdomainPolicy *string    `json:"subdomainPolicy,omitempty"`
	Percentage      *int32     `json:"percentage,omitempty"`
	DateRangeBegin  *time.Time `json:"dateRangeBegin,omitempty"`
	DateRangeEnd    *time.Time `json:"dateRangeEnd,omitempty"`
}

DmarcReportMetadata DMARC aggregate report metadata and policy information

type DmarcReportSourceSummary 

type DmarcReportSourceSummary struct {
	SourceIp    string  `json:"sourceIp"`
	Count       int32   `json:"count"`
	Disposition *string `json:"disposition,omitempty"`
	DkimAligned bool    `json:"dkimAligned"`
	SpfAligned  bool    `json:"spfAligned"`
	HeaderFrom  *string `json:"headerFrom,omitempty"`
}

DmarcReportSourceSummary Summarized DMARC results for a single source IP

type DnsLookupOptions 

type DnsLookupOptions struct {
	// List of record types you wish to query such as MX, DNS, TXT, NS, A etc.
	Hostname string `json:"hostname"`
	// List of record types you wish to query such as MX, DNS, TXT, NS, A etc.
	RecordTypes []string `json:"recordTypes"`
	// Optionally control whether to omit the final dot in full DNS name values.
	OmitFinalDNSDot bool `json:"omitFinalDNSDot"`
}

DnsLookupOptions Options for DNS query.

type DnsLookupResult 

type DnsLookupResult struct {
	// Domain Name Server Record Types
	RecordType    string   `json:"recordType"`
	Ttl           int64    `json:"ttl"`
	RecordEntries []string `json:"recordEntries"`
	Name          string   `json:"name"`
}

DnsLookupResult DNS lookup result. Includes record type, time to live, raw response, and name value for the name server response.

type DnsLookupResults 

type DnsLookupResults struct {
	Results []DnsLookupResult `json:"results"`
}

DnsLookupResults Results of query on domain name servers

type DnsLookupsOptions 

type DnsLookupsOptions struct {
	Lookups []DnsLookupOptions `json:"lookups"`
}

DnsLookupsOptions Options for multiple DNS queries

type DnsPropagationResolverResult 

type DnsPropagationResolverResult struct {
	Resolver             string   `json:"resolver"`
	Records              []string `json:"records"`
	Responded            bool     `json:"responded"`
	MatchedExpectedValue *bool    `json:"matchedExpectedValue,omitempty"`
}

DnsPropagationResolverResult Propagation results from a single DNS resolver

type DoesInboxExistOpts 

type DoesInboxExistOpts struct {
	AllowCatchAll optional.Bool
	IpAddress     optional.String
	Sender        optional.String
}

DoesInboxExistOpts Optional parameters for the method 'DoesInboxExist'

type DomainControllerApiService 

type DomainControllerApiService service

DomainControllerApiService DomainControllerApi service

func (*DomainControllerApiService) AddDomainWildcardCatchAll 

func (a *DomainControllerApiService) AddDomainWildcardCatchAll(ctx _context.Context, id string) (DomainDto, *_nethttp.Response, error)

AddDomainWildcardCatchAll Add catch all wild card inbox to domain Add a catch all inbox to a domain so that any emails sent to it that cannot be matched will be sent to the catch all inbox generated

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

@return DomainDto

func (*DomainControllerApiService) CreateDomain 

func (a *DomainControllerApiService) CreateDomain(ctx _context.Context, createDomainOptions CreateDomainOptions) (DomainDto, *_nethttp.Response, error)

CreateDomain Create Domain Link a domain that you own with MailSlurp so you can create email addresses using it. Endpoint returns DNS records used for validation. You must add these verification records to your host provider&#39;s DNS setup to verify the domain.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createDomainOptions

@return DomainDto

func (*DomainControllerApiService) DeleteDomain 

func (a *DomainControllerApiService) DeleteDomain(ctx _context.Context, id string) ([]string, *_nethttp.Response, error)

DeleteDomain Delete a domain Delete a domain. This will disable any existing inboxes that use this domain.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

@return []string

func (*DomainControllerApiService) GetAvailableDomainRegions 

func (a *DomainControllerApiService) GetAvailableDomainRegions(ctx _context.Context, localVarOptionals *GetAvailableDomainRegionsOpts) (DomainRegionGroupsDto, *_nethttp.Response, error)

GetAvailableDomainRegions Get all usable domains with account region status List all domains available for use with email address creation, including account-region and create/send enablement flags.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAvailableDomainRegionsOpts - Optional Parameters:
  • @param "InboxType" (optional.String) -

@return DomainRegionGroupsDto

func (*DomainControllerApiService) GetAvailableDomains 

func (a *DomainControllerApiService) GetAvailableDomains(ctx _context.Context, localVarOptionals *GetAvailableDomainsOpts) (DomainGroupsDto, *_nethttp.Response, error)

GetAvailableDomains Get all usable domains List all domains available for use with email address creation

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAvailableDomainsOpts - Optional Parameters:
  • @param "InboxType" (optional.String) -

@return DomainGroupsDto

func (*DomainControllerApiService) GetDomain 

func (a *DomainControllerApiService) GetDomain(ctx _context.Context, id string, localVarOptionals *GetDomainOpts) (DomainDto, *_nethttp.Response, error)

GetDomain Get a domain Returns domain verification status and tokens for a given domain

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param optional nil or *GetDomainOpts - Optional Parameters:
  • @param "CheckForErrors" (optional.Bool) -

@return DomainDto

func (*DomainControllerApiService) GetDomainIssues 

func (a *DomainControllerApiService) GetDomainIssues(ctx _context.Context) (DomainIssuesDto, *_nethttp.Response, error)

GetDomainIssues Get domain issues List domain issues for domains you have created

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return DomainIssuesDto

func (*DomainControllerApiService) GetDomainWildcardCatchAllInbox 

func (a *DomainControllerApiService) GetDomainWildcardCatchAllInbox(ctx _context.Context, id string) (InboxDto, *_nethttp.Response, error)

GetDomainWildcardCatchAllInbox Get catch all wild card inbox for domain Get the catch all inbox for a domain for missed emails

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

@return InboxDto

func (*DomainControllerApiService) GetDomains 

func (a *DomainControllerApiService) GetDomains(ctx _context.Context) ([]DomainPreview, *_nethttp.Response, error)

GetDomains Get domains List all custom domains you have created

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []DomainPreview

func (*DomainControllerApiService) GetMailSlurpDomains 

func (a *DomainControllerApiService) GetMailSlurpDomains(ctx _context.Context, localVarOptionals *GetMailSlurpDomainsOpts) (DomainGroupsDto, *_nethttp.Response, error)

GetMailSlurpDomains Get MailSlurp domains List all MailSlurp domains used with non-custom email addresses

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetMailSlurpDomainsOpts - Optional Parameters:
  • @param "InboxType" (optional.String) -

@return DomainGroupsDto

func (*DomainControllerApiService) UpdateDomain 

func (a *DomainControllerApiService) UpdateDomain(ctx _context.Context, id string, updateDomainOptions UpdateDomainOptions) (DomainDto, *_nethttp.Response, error)

UpdateDomain Update a domain Update values on a domain. Note you cannot change the domain name as it is immutable. Recreate the domain if you need to alter this.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param updateDomainOptions

@return DomainDto

type DomainDto 

type DomainDto struct {
	Id     string `json:"id"`
	UserId string `json:"userId"`
	// Custom domain name
	Domain string `json:"domain"`
	// Verification tokens
	VerificationToken string `json:"verificationToken"`
	// Unique token DKIM tokens
	DkimTokens []string `json:"dkimTokens"`
	// If the domain is duplicate records.
	DuplicateRecordsMessage *string `json:"duplicateRecordsMessage,omitempty"`
	// Whether the domain has duplicated required records. If true then see the domain in the dashboard app.
	HasDuplicateRecords bool `json:"hasDuplicateRecords"`
	// If the domain is missing records then show which pairs are missing.
	MissingRecordsMessage *string `json:"missingRecordsMessage,omitempty"`
	// Whether the domain has missing required records. If true then see the domain in the dashboard app.
	HasMissingRecords bool `json:"hasMissingRecords"`
	// Whether domain has been verified or not. If the domain is not verified after 72 hours there is most likely an issue with the domains DNS records.
	IsVerified bool `json:"isVerified"`
	// List of DNS domain name records (C, MX, TXT) etc that you must add to the DNS server associated with your domain provider.
	DomainNameRecords []DomainNameRecord `json:"domainNameRecords"`
	// The optional catch all inbox that will receive emails sent to the domain that cannot be matched.
	CatchAllInboxId *string   `json:"catchAllInboxId,omitempty"`
	CreatedAt       time.Time `json:"createdAt"`
	UpdatedAt       time.Time `json:"updatedAt"`
	// Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails.
	DomainType string `json:"domainType"`
}

DomainDto Domain plus verification records and status

type DomainGroup 

type DomainGroup struct {
	Label   string              `json:"label"`
	Domains []DomainInformation `json:"domains"`
}

DomainGroup struct for DomainGroup

type DomainGroupsDto 

type DomainGroupsDto struct {
	DomainGroups []DomainGroup `json:"domainGroups"`
}

DomainGroupsDto struct for DomainGroupsDto

type DomainInformation 

type DomainInformation struct {
	DomainName string `json:"domainName"`
	Verified   bool   `json:"verified"`
	// Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails.
	DomainType string `json:"domainType"`
}

DomainInformation struct for DomainInformation

type DomainIssuesDto 

type DomainIssuesDto struct {
	HasIssues bool `json:"hasIssues"`
}

DomainIssuesDto struct for DomainIssuesDto

type DomainMonitorAlertSinkDto 

type DomainMonitorAlertSinkDto struct {
	Id                string    `json:"id"`
	MonitorId         string    `json:"monitorId"`
	UserId            string    `json:"userId"`
	Type              string    `json:"type"`
	Target            string    `json:"target"`
	SeverityThreshold string    `json:"severityThreshold"`
	Enabled           bool      `json:"enabled"`
	CreatedAt         time.Time `json:"createdAt"`
	UpdatedAt         time.Time `json:"updatedAt"`
}

DomainMonitorAlertSinkDto struct for DomainMonitorAlertSinkDto

type DomainMonitorControllerApiService 

type DomainMonitorControllerApiService service

DomainMonitorControllerApiService DomainMonitorControllerApi service

func (*DomainMonitorControllerApiService) CompareDomainMonitorRuns 

func (a *DomainMonitorControllerApiService) CompareDomainMonitorRuns(ctx _context.Context, monitorId string, runId string, otherRunId string) (DomainMonitorRunComparisonDto, *_nethttp.Response, error)

CompareDomainMonitorRuns Compare two monitor runs

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorId
  • @param runId
  • @param otherRunId

@return DomainMonitorRunComparisonDto

func (*DomainMonitorControllerApiService) CreateDomainMonitor 

func (a *DomainMonitorControllerApiService) CreateDomainMonitor(ctx _context.Context, createDomainMonitorOptions CreateDomainMonitorOptions) (DomainMonitorDto, *_nethttp.Response, error)

CreateDomainMonitor Create domain monitor

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createDomainMonitorOptions

@return DomainMonitorDto

func (*DomainMonitorControllerApiService) CreateDomainMonitorAlertSink 

func (a *DomainMonitorControllerApiService) CreateDomainMonitorAlertSink(ctx _context.Context, monitorId string, createDomainMonitorAlertSinkOptions CreateDomainMonitorAlertSinkOptions) (DomainMonitorAlertSinkDto, *_nethttp.Response, error)

CreateDomainMonitorAlertSink Create alert sink for monitor

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorId
  • @param createDomainMonitorAlertSinkOptions

@return DomainMonitorAlertSinkDto

func (*DomainMonitorControllerApiService) DeleteDomainMonitor 

func (a *DomainMonitorControllerApiService) DeleteDomainMonitor(ctx _context.Context, monitorId string) (*_nethttp.Response, error)

DeleteDomainMonitor Delete domain monitor

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorId

func (*DomainMonitorControllerApiService) DeleteDomainMonitorAlertSink 

func (a *DomainMonitorControllerApiService) DeleteDomainMonitorAlertSink(ctx _context.Context, monitorId string, sinkId string) (*_nethttp.Response, error)

DeleteDomainMonitorAlertSink Delete monitor alert sink

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorId
  • @param sinkId

func (*DomainMonitorControllerApiService) GetDomainMonitor 

func (a *DomainMonitorControllerApiService) GetDomainMonitor(ctx _context.Context, monitorId string) (DomainMonitorDto, *_nethttp.Response, error)

GetDomainMonitor Get domain monitor

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorId

@return DomainMonitorDto

func (*DomainMonitorControllerApiService) GetDomainMonitorAlertSinks 

func (a *DomainMonitorControllerApiService) GetDomainMonitorAlertSinks(ctx _context.Context, monitorId string) ([]DomainMonitorAlertSinkDto, *_nethttp.Response, error)

GetDomainMonitorAlertSinks List alert sinks for monitor

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorId

@return []DomainMonitorAlertSinkDto

func (*DomainMonitorControllerApiService) GetDomainMonitorAuthStack 

func (a *DomainMonitorControllerApiService) GetDomainMonitorAuthStack(ctx _context.Context, monitorId string, localVarOptionals *GetDomainMonitorAuthStackOpts) (CheckEmailAuthStackResults, *_nethttp.Response, error)

GetDomainMonitorAuthStack Get current auth stack for monitor domain

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorId
  • @param optional nil or *GetDomainMonitorAuthStackOpts - Optional Parameters:
  • @param "DkimSelector" (optional.String) -

@return CheckEmailAuthStackResults

func (*DomainMonitorControllerApiService) GetDomainMonitorInsights 

func (a *DomainMonitorControllerApiService) GetDomainMonitorInsights(ctx _context.Context, monitorId string, localVarOptionals *GetDomainMonitorInsightsOpts) (DomainMonitorInsightsDto, *_nethttp.Response, error)

GetDomainMonitorInsights Get monitor insights

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorId
  • @param optional nil or *GetDomainMonitorInsightsOpts - Optional Parameters:
  • @param "Since" (optional.Time) -
  • @param "Before" (optional.Time) -

@return DomainMonitorInsightsDto

func (*DomainMonitorControllerApiService) GetDomainMonitorRun 

func (a *DomainMonitorControllerApiService) GetDomainMonitorRun(ctx _context.Context, monitorId string, runId string) (DomainMonitorRunDto, *_nethttp.Response, error)

GetDomainMonitorRun Get monitor run

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorId
  • @param runId

@return DomainMonitorRunDto

func (*DomainMonitorControllerApiService) GetDomainMonitorRuns 

func (a *DomainMonitorControllerApiService) GetDomainMonitorRuns(ctx _context.Context, monitorId string, localVarOptionals *GetDomainMonitorRunsOpts) ([]DomainMonitorRunDto, *_nethttp.Response, error)

GetDomainMonitorRuns List monitor runs

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorId
  • @param optional nil or *GetDomainMonitorRunsOpts - Optional Parameters:
  • @param "Since" (optional.Time) -
  • @param "Before" (optional.Time) -
  • @param "Status" (optional.String) -
  • @param "Limit" (optional.Int32) -

@return []DomainMonitorRunDto

func (*DomainMonitorControllerApiService) GetDomainMonitorSeries 

func (a *DomainMonitorControllerApiService) GetDomainMonitorSeries(ctx _context.Context, monitorId string, localVarOptionals *GetDomainMonitorSeriesOpts) (DomainMonitorSeriesDto, *_nethttp.Response, error)

GetDomainMonitorSeries Get monitor trend series

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorId
  • @param optional nil or *GetDomainMonitorSeriesOpts - Optional Parameters:
  • @param "Since" (optional.Time) -
  • @param "Before" (optional.Time) -
  • @param "Bucket" (optional.String) -

@return DomainMonitorSeriesDto

func (*DomainMonitorControllerApiService) GetDomainMonitorSummary 

func (a *DomainMonitorControllerApiService) GetDomainMonitorSummary(ctx _context.Context, monitorId string, localVarOptionals *GetDomainMonitorSummaryOpts) (DomainMonitorSummaryDto, *_nethttp.Response, error)

GetDomainMonitorSummary Get domain monitor summary

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorId
  • @param optional nil or *GetDomainMonitorSummaryOpts - Optional Parameters:
  • @param "DkimSelector" (optional.String) -

@return DomainMonitorSummaryDto

func (*DomainMonitorControllerApiService) GetDomainMonitors 

func (a *DomainMonitorControllerApiService) GetDomainMonitors(ctx _context.Context) ([]DomainMonitorDto, *_nethttp.Response, error)

GetDomainMonitors List domain monitors

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []DomainMonitorDto

func (*DomainMonitorControllerApiService) RunDomainMonitorNow 

func (a *DomainMonitorControllerApiService) RunDomainMonitorNow(ctx _context.Context, monitorId string) (DomainMonitorRunNowResult, *_nethttp.Response, error)

RunDomainMonitorNow Run monitor now

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorId

@return DomainMonitorRunNowResult

func (*DomainMonitorControllerApiService) RunDueDomainMonitors 

func (a *DomainMonitorControllerApiService) RunDueDomainMonitors(ctx _context.Context, localVarOptionals *RunDueDomainMonitorsOpts) (DomainMonitorRunDueResult, *_nethttp.Response, error)

RunDueDomainMonitors Run due monitors for user

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *RunDueDomainMonitorsOpts - Optional Parameters:
  • @param "MaxRuns" (optional.Int32) -

@return DomainMonitorRunDueResult

func (*DomainMonitorControllerApiService) UpdateDomainMonitor 

func (a *DomainMonitorControllerApiService) UpdateDomainMonitor(ctx _context.Context, monitorId string, updateDomainMonitorOptions UpdateDomainMonitorOptions) (DomainMonitorDto, *_nethttp.Response, error)

UpdateDomainMonitor Update domain monitor

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param monitorId
  • @param updateDomainMonitorOptions

@return DomainMonitorDto

type DomainMonitorDto 

type DomainMonitorDto struct {
	Id                string    `json:"id"`
	UserId            string    `json:"userId"`
	Domain            string    `json:"domain"`
	Name              string    `json:"name,omitempty"`
	IntervalSeconds   int64     `json:"intervalSeconds,omitempty"`
	Enabled           bool      `json:"enabled"`
	SchedulingEnabled bool      `json:"schedulingEnabled"`
	LastStatus        string    `json:"lastStatus,omitempty"`
	HealthScore       int32     `json:"healthScore,omitempty"`
	LastRunAt         time.Time `json:"lastRunAt,omitempty"`
	NextRunAt         time.Time `json:"nextRunAt,omitempty"`
	CreatedAt         time.Time `json:"createdAt"`
	UpdatedAt         time.Time `json:"updatedAt"`
}

DomainMonitorDto struct for DomainMonitorDto

type DomainMonitorInsightsDto 

type DomainMonitorInsightsDto struct {
	MonitorId              string              `json:"monitorId"`
	Since                  time.Time           `json:"since"`
	Before                 time.Time           `json:"before"`
	TotalRuns              int32               `json:"totalRuns"`
	HealthyRuns            int32               `json:"healthyRuns"`
	DegradedRuns           int32               `json:"degradedRuns"`
	CriticalRuns           int32               `json:"criticalRuns"`
	FailedRuns             int32               `json:"failedRuns"`
	SuccessRate            float64             `json:"successRate"`
	AverageHealthScore     float64             `json:"averageHealthScore"`
	CurrentHealthyStreak   int32               `json:"currentHealthyStreak"`
	BestHealthyStreak      int32               `json:"bestHealthyStreak"`
	GoodPerformanceSignals []string            `json:"goodPerformanceSignals"`
	AttentionSignals       []string            `json:"attentionSignals"`
	TopFindings            []string            `json:"topFindings"`
	LatestRun              DomainMonitorRunDto `json:"latestRun,omitempty"`
}

DomainMonitorInsightsDto struct for DomainMonitorInsightsDto

type DomainMonitorRunComparisonDto 

type DomainMonitorRunComparisonDto struct {
	Baseline             DomainMonitorRunDto `json:"baseline"`
	Current              DomainMonitorRunDto `json:"current"`
	HealthScoreDelta     int32               `json:"healthScoreDelta"`
	StatusChanged        bool                `json:"statusChanged"`
	PassingChecksDelta   int32               `json:"passingChecksDelta"`
	FailingChecksDelta   int32               `json:"failingChecksDelta"`
	SpfChanged           bool                `json:"spfChanged"`
	DmarcChanged         bool                `json:"dmarcChanged"`
	DmarcEnforcedChanged bool                `json:"dmarcEnforcedChanged"`
	MxChanged            bool                `json:"mxChanged"`
	AddedInsights        []string            `json:"addedInsights"`
	RemovedInsights      []string            `json:"removedInsights"`
}

DomainMonitorRunComparisonDto struct for DomainMonitorRunComparisonDto

type DomainMonitorRunDto 

type DomainMonitorRunDto struct {
	Id            string    `json:"id"`
	MonitorId     string    `json:"monitorId"`
	UserId        string    `json:"userId"`
	Domain        string    `json:"domain"`
	Status        string    `json:"status"`
	TriggerSource string    `json:"triggerSource"`
	HealthScore   int32     `json:"healthScore"`
	TotalChecks   int32     `json:"totalChecks"`
	PassingChecks int32     `json:"passingChecks"`
	FailingChecks int32     `json:"failingChecks"`
	SpfOk         bool      `json:"spfOk"`
	DmarcOk       bool      `json:"dmarcOk"`
	DmarcEnforced bool      `json:"dmarcEnforced"`
	MxOk          bool      `json:"mxOk"`
	Insights      []string  `json:"insights"`
	ErrorMessage  string    `json:"errorMessage,omitempty"`
	CreatedAt     time.Time `json:"createdAt"`
	UpdatedAt     time.Time `json:"updatedAt"`
}

DomainMonitorRunDto struct for DomainMonitorRunDto

type DomainMonitorRunDueResult 

type DomainMonitorRunDueResult struct {
	TriggerSource    string    `json:"triggerSource"`
	RunCount         int32     `json:"runCount"`
	RequestedMaxRuns int32     `json:"requestedMaxRuns"`
	ExecutedAt       time.Time `json:"executedAt"`
}

DomainMonitorRunDueResult struct for DomainMonitorRunDueResult

type DomainMonitorRunNowResult 

type DomainMonitorRunNowResult struct {
	Monitor DomainMonitorDto    `json:"monitor"`
	Run     DomainMonitorRunDto `json:"run"`
}

DomainMonitorRunNowResult struct for DomainMonitorRunNowResult

type DomainMonitorSeriesDto 

type DomainMonitorSeriesDto struct {
	MonitorId string                        `json:"monitorId"`
	Since     time.Time                     `json:"since"`
	Before    time.Time                     `json:"before"`
	Bucket    string                        `json:"bucket"`
	Points    []DomainMonitorSeriesPointDto `json:"points"`
}

DomainMonitorSeriesDto struct for DomainMonitorSeriesDto

type DomainMonitorSeriesPointDto 

type DomainMonitorSeriesPointDto struct {
	BucketStart        time.Time `json:"bucketStart"`
	RunCount           int32     `json:"runCount"`
	HealthyCount       int32     `json:"healthyCount"`
	DegradedCount      int32     `json:"degradedCount"`
	CriticalCount      int32     `json:"criticalCount"`
	FailedCount        int32     `json:"failedCount"`
	HealthyRate        float64   `json:"healthyRate"`
	AverageHealthScore float64   `json:"averageHealthScore"`
}

DomainMonitorSeriesPointDto struct for DomainMonitorSeriesPointDto

type DomainMonitorSummaryDto 

type DomainMonitorSummaryDto struct {
	Monitor   DomainMonitorDto           `json:"monitor"`
	LatestRun DomainMonitorRunDto        `json:"latestRun,omitempty"`
	Insights  DomainMonitorInsightsDto   `json:"insights"`
	AuthStack CheckEmailAuthStackResults `json:"authStack"`
}

DomainMonitorSummaryDto struct for DomainMonitorSummaryDto

type DomainNameRecord 

type DomainNameRecord struct {
	// Domain Name Server Record Label
	Label    string `json:"label"`
	Required bool   `json:"required"`
	// Domain Name Server Record Types
	RecordType               string    `json:"recordType"`
	Name                     string    `json:"name"`
	RecordEntries            []string  `json:"recordEntries"`
	Ttl                      int64     `json:"ttl"`
	AlternativeRecordEntries *[]string `json:"alternativeRecordEntries,omitempty"`
}

DomainNameRecord DNS Record required for verification of a domain. Record vary depending on domain type.

type DomainPreview 

type DomainPreview struct {
	Id              string    `json:"id"`
	Domain          string    `json:"domain"`
	CatchAllInboxId *string   `json:"catchAllInboxId,omitempty"`
	CreatedAt       time.Time `json:"createdAt"`
	// Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails.
	DomainType        string `json:"domainType"`
	IsVerified        bool   `json:"isVerified"`
	HasMissingRecords bool   `json:"hasMissingRecords"`
}

DomainPreview Preview object for domain entity

type DomainRegionGroup 

type DomainRegionGroup struct {
	Label   string                    `json:"label"`
	Domains []DomainRegionInformation `json:"domains"`
}

DomainRegionGroup struct for DomainRegionGroup

type DomainRegionGroupsDto 

type DomainRegionGroupsDto struct {
	DomainGroups []DomainRegionGroup `json:"domainGroups"`
}

DomainRegionGroupsDto Grouped available domains including account-region policy status.

type DomainRegionInformation 

type DomainRegionInformation struct {
	DomainName string `json:"domainName"`
	Verified   bool   `json:"verified"`
	// Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails.
	DomainType      string  `json:"domainType"`
	AccountRegion   *string `json:"accountRegion,omitempty"`
	CreationEnabled bool    `json:"creationEnabled"`
	SendingEnabled  bool    `json:"sendingEnabled"`
	Active          bool    `json:"active"`
}

DomainRegionInformation struct for DomainRegionInformation

type DownloadAttachmentDto 

type DownloadAttachmentDto struct {
	// Base64 encoded string of attachment bytes. Decode the base64 encoded string to get the raw contents. If the file has a content type such as `text/html` you can read the contents directly by converting it to string using `utf-8` encoding.
	Base64FileContents string `json:"base64FileContents"`
	// Content type of attachment. Examples are `image/png`, `application/msword`, `text/csv` etc.
	ContentType string `json:"contentType"`
	// Size in bytes of attachment content
	SizeBytes int64 `json:"sizeBytes"`
}

DownloadAttachmentDto Content of attachment

type DownloadAttachmentOpts 

type DownloadAttachmentOpts struct {
	ApiKey optional.String
}

DownloadAttachmentOpts Optional parameters for the method 'DownloadAttachment'

type Email 

type Email struct {
	// ID of the email entity
	Id string `json:"id"`
	// ID of user that email belongs to
	UserId string `json:"userId"`
	// ID of the inbox that received the email
	InboxId string `json:"inboxId"`
	// ID of the domain that received the email
	DomainId *string `json:"domainId,omitempty"`
	// List of `To` recipient email addresses that the email was addressed to. See recipients object for names.
	To []string `json:"to"`
	// Who the email was sent from. An email address - see fromName for the sender name.
	From       *string          `json:"from,omitempty"`
	Sender     *Sender          `json:"sender,omitempty"`
	Recipients *EmailRecipients `json:"recipients,omitempty"`
	// The `replyTo` field on the received email message
	ReplyTo *string `json:"replyTo,omitempty"`
	// List of `CC` recipients email addresses that the email was addressed to. See recipients object for names.
	Cc *[]string `json:"cc,omitempty"`
	// List of `BCC` recipients email addresses that the email was addressed to. See recipients object for names.
	Bcc *[]string `json:"bcc,omitempty"`
	// Collection of SMTP headers attached to email
	Headers *map[string]string `json:"headers,omitempty"`
	// Multi-value map of SMTP headers attached to email
	HeadersMap *map[string][]string `json:"headersMap,omitempty"`
	// List of IDs of attachments found in the email. Use these IDs with the Inbox and Email Controllers to download attachments and attachment meta data such as filesize, name, extension.
	Attachments *[]string `json:"attachments,omitempty"`
	// The subject line of the email message as specified by SMTP subject header
	Subject *string `json:"subject,omitempty"`
	// The body of the email message as text parsed from the SMTP message body (does not include attachments). Fetch the raw content to access the SMTP message and use the attachments property to access attachments. The body is stored separately to the email entity so the body is not returned in paginated results only in full single email or wait requests.
	Body *string `json:"body,omitempty"`
	// An excerpt of the body of the email message for quick preview. Takes HTML content part if exists falls back to TEXT content part if not
	BodyExcerpt *string `json:"bodyExcerpt,omitempty"`
	// An excerpt of the body of the email message for quick preview. Takes TEXT content part if exists
	TextExcerpt *string `json:"textExcerpt,omitempty"`
	// A hash signature of the email message using MD5. Useful for comparing emails without fetching full body.
	BodyMD5Hash *string `json:"bodyMD5Hash,omitempty"`
	// Is the email body content type HTML?
	IsHTML *bool `json:"isHTML,omitempty"`
	// Detected character set of the email body such as UTF-8
	Charset  *string        `json:"charset,omitempty"`
	Analysis *EmailAnalysis `json:"analysis,omitempty"`
	// When was the email received by MailSlurp
	CreatedAt time.Time `json:"createdAt"`
	// When was the email last updated
	UpdatedAt time.Time `json:"updatedAt"`
	// Read flag. Has the email ever been viewed in the dashboard or fetched via the API with a hydrated body? If so the email is marked as read. Paginated results do not affect read status. Read status is different to email opened event as it depends on your own account accessing the email. Email opened is determined by tracking pixels sent to other uses if enable during sending. You can listened for both email read and email opened events using webhooks.
	Read bool `json:"read"`
	// Can the email be accessed by organization team members
	TeamAccess bool `json:"teamAccess"`
	// Is the email body content type x-amp-html Amp4Email?
	IsXAmpHtml *bool `json:"isXAmpHtml,omitempty"`
	// A list of detected multipart mime message body part content types such as text/plain and text/html. Can be used with email bodyPart endpoints to fetch individual body parts.
	BodyPartContentTypes *[]string `json:"bodyPartContentTypes,omitempty"`
	// UID used by external IMAP server to identify email
	ExternalId *string `json:"externalId,omitempty"`
	// RFC 5322 Message-ID header value without angle brackets.
	MessageId *string `json:"messageId,omitempty"`
	// MailSlurp thread ID for email chain that enables lookup for In-Reply-To and References fields.
	ThreadId *string `json:"threadId,omitempty"`
	// Parsed value of In-Reply-To header. A Message-ID in a thread.
	InReplyTo *string `json:"inReplyTo,omitempty"`
	// Is email favourited
	Favourite *bool `json:"favourite,omitempty"`
	// Size of raw email message in bytes
	SizeBytes *int64 `json:"sizeBytes,omitempty"`
	Html      bool   `json:"html,omitempty"`
	XampHtml  bool   `json:"xampHtml,omitempty"`
}

Email Email entity (also known as EmailDto). When an SMTP email message is received by MailSlurp it is parsed. The body and attachments are written to disk and the fields such as to, from, subject etc are stored in a database. The `body` contains the email content. If you want the original SMTP message see the `getRawEmail` endpoints. The attachments can be fetched using the AttachmentController

type EmailAnalysis 

type EmailAnalysis struct {
	// Verdict of spam ranking analysis
	SpamVerdict *string `json:"spamVerdict,omitempty"`
	// Verdict of virus scan analysis
	VirusVerdict *string `json:"virusVerdict,omitempty"`
	// Verdict of Send Policy Framework record spoofing analysis
	SpfVerdict *string `json:"spfVerdict,omitempty"`
	// Verdict of DomainKeys Identified Mail analysis
	DkimVerdict *string `json:"dkimVerdict,omitempty"`
	// Verdict of Domain-based Message Authentication Reporting and Conformance analysis
	DmarcVerdict *string `json:"dmarcVerdict,omitempty"`
}

EmailAnalysis Analysis result for email. Each verdict property is a string PASS|FAIL|GRAY or dynamic error message

type EmailAuditAnalysisResult 

type EmailAuditAnalysisResult struct {
	// Health status for a one-shot email audit
	Status                         string                    `json:"status"`
	HealthScore                    int32                     `json:"healthScore"`
	TotalChecks                    int32                     `json:"totalChecks"`
	PassingChecks                  int32                     `json:"passingChecks"`
	FailingChecks                  int32                     `json:"failingChecks"`
	DetectedLinks                  int32                     `json:"detectedLinks"`
	CheckedLinks                   int32                     `json:"checkedLinks"`
	DetectedImages                 int32                     `json:"detectedImages"`
	CheckedImages                  int32                     `json:"checkedImages"`
	LinkIssueCount                 int32                     `json:"linkIssueCount"`
	ImageIssueCount                int32                     `json:"imageIssueCount"`
	SpellingIssueCount             int32                     `json:"spellingIssueCount"`
	BrokenLinks                    []EmailAuditUrlIssue      `json:"brokenLinks"`
	BrokenImages                   []EmailAuditUrlIssue      `json:"brokenImages"`
	SpellingIssues                 []EmailAuditSpellingIssue `json:"spellingIssues"`
	CompatibilityWarningCount      int32                     `json:"compatibilityWarningCount"`
	CompatibilityNotSupportedCount int32                     `json:"compatibilityNotSupportedCount"`
	CompatibilityUnknownCount      int32                     `json:"compatibilityUnknownCount"`
	FeatureSupport                 EmailFeatureSupportResult `json:"featureSupport,omitempty"`
	HtmlErrorCount                 int32                     `json:"htmlErrorCount"`
	HtmlWarningCount               int32                     `json:"htmlWarningCount"`
	HtmlInfoCount                  int32                     `json:"htmlInfoCount"`
	HtmlValidation                 *HtmlValidationResult     `json:"htmlValidation,omitempty"`
	ReputationFailureCount         int32                     `json:"reputationFailureCount"`
	AttachmentMentionIssueCount    int32                     `json:"attachmentMentionIssueCount"`
	ExternalCheckSkippedCount      int32                     `json:"externalCheckSkippedCount"`
	Insights                       []string                  `json:"insights"`
	ErrorMessage                   *string                   `json:"errorMessage,omitempty"`
}

EmailAuditAnalysisResult Combined email audit analysis across validation, client support, links, and images

type EmailAuditComparisonDto 

type EmailAuditComparisonDto struct {
	Baseline                       EmailAuditDto `json:"baseline"`
	Current                        EmailAuditDto `json:"current"`
	HealthScoreDelta               int32         `json:"healthScoreDelta"`
	StatusChanged                  bool          `json:"statusChanged"`
	BrokenLinkDelta                int32         `json:"brokenLinkDelta"`
	BrokenImageDelta               int32         `json:"brokenImageDelta"`
	SpellingIssueDelta             int32         `json:"spellingIssueDelta"`
	HtmlErrorDelta                 int32         `json:"htmlErrorDelta"`
	HtmlWarningDelta               int32         `json:"htmlWarningDelta"`
	CompatibilityWarningDelta      int32         `json:"compatibilityWarningDelta"`
	CompatibilityNotSupportedDelta int32         `json:"compatibilityNotSupportedDelta"`
	ReputationFailureDelta         int32         `json:"reputationFailureDelta"`
	AttachmentMentionIssueDelta    int32         `json:"attachmentMentionIssueDelta"`
	AddedInsights                  []string      `json:"addedInsights"`
	RemovedInsights                []string      `json:"removedInsights"`
}

EmailAuditComparisonDto struct for EmailAuditComparisonDto

type EmailAuditControllerApiService 

type EmailAuditControllerApiService service

EmailAuditControllerApiService EmailAuditControllerApi service

func (*EmailAuditControllerApiService) CompareEmailAudits 

func (a *EmailAuditControllerApiService) CompareEmailAudits(ctx _context.Context, auditId string, otherAuditId string) (EmailAuditComparisonDto, *_nethttp.Response, error)

CompareEmailAudits Compare two email audits

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param auditId
  • @param otherAuditId

@return EmailAuditComparisonDto

func (*EmailAuditControllerApiService) CreateEmailAudit 

func (a *EmailAuditControllerApiService) CreateEmailAudit(ctx _context.Context, createEmailAuditOptions CreateEmailAuditOptions) (EmailAuditDto, *_nethttp.Response, error)

CreateEmailAudit Create email audit

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createEmailAuditOptions

@return EmailAuditDto

func (*EmailAuditControllerApiService) DeleteEmailAudit 

func (a *EmailAuditControllerApiService) DeleteEmailAudit(ctx _context.Context, auditId string) (*_nethttp.Response, error)

DeleteEmailAudit Delete email audit

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param auditId

func (*EmailAuditControllerApiService) GetEmailAudit 

func (a *EmailAuditControllerApiService) GetEmailAudit(ctx _context.Context, auditId string) (EmailAuditDto, *_nethttp.Response, error)

GetEmailAudit Get email audit

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param auditId

@return EmailAuditDto

func (*EmailAuditControllerApiService) GetEmailAudits 

func (a *EmailAuditControllerApiService) GetEmailAudits(ctx _context.Context, localVarOptionals *GetEmailAuditsOpts) ([]EmailAuditDto, *_nethttp.Response, error)

GetEmailAudits List email audits

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetEmailAuditsOpts - Optional Parameters:
  • @param "EmailId" (optional.Interface of string) -
  • @param "Since" (optional.Time) -
  • @param "Before" (optional.Time) -
  • @param "Limit" (optional.Int32) -

@return []EmailAuditDto

type EmailAuditDto 

type EmailAuditDto struct {
	Id          string                   `json:"id"`
	UserId      string                   `json:"userId"`
	EmailId     *string                  `json:"emailId,omitempty"`
	FromAddress *string                  `json:"fromAddress,omitempty"`
	Recipient   *string                  `json:"recipient,omitempty"`
	Subject     *string                  `json:"subject,omitempty"`
	Analysis    EmailAuditAnalysisResult `json:"analysis"`
	CreatedAt   time.Time                `json:"createdAt"`
	UpdatedAt   time.Time                `json:"updatedAt"`
}

EmailAuditDto Persisted email audit result

type EmailAuditSpellingIssue 

type EmailAuditSpellingIssue struct {
	Group      *string `json:"group,omitempty"`
	Suggestion *string `json:"suggestion,omitempty"`
	Severity   *string `json:"severity,omitempty"`
	Message    string  `json:"message"`
}

EmailAuditSpellingIssue A single spelling or content-quality issue discovered during email audit checks

type EmailAuditUrlIssue 

type EmailAuditUrlIssue struct {
	Url        string `json:"url"`
	StatusCode *int32 `json:"statusCode,omitempty"`
	Message    string `json:"message"`
}

EmailAuditUrlIssue A single URL issue discovered during email audit checks

type EmailAvailableResult 

type EmailAvailableResult struct {
	Available bool `json:"available"`
}

EmailAvailableResult struct for EmailAvailableResult

type EmailBlacklistIpResult 

type EmailBlacklistIpResult struct {
	IpAddress string                        `json:"ipAddress"`
	Source    string                        `json:"source"`
	Listings  []EmailBlacklistListingResult `json:"listings"`
}

EmailBlacklistIpResult Blacklist lookup results for a single IP address

type EmailBlacklistListingResult 

type EmailBlacklistListingResult struct {
	Zone             string   `json:"zone"`
	Listed           bool     `json:"listed"`
	ResponseCodes    []string `json:"responseCodes"`
	ResponseMessages []string `json:"responseMessages"`
}

EmailBlacklistListingResult Blacklist lookup result for a single zone

type EmailContentMatchResult 

type EmailContentMatchResult struct {
	Pattern string   `json:"pattern"`
	Matches []string `json:"matches"`
}

EmailContentMatchResult Matches for the given pattern

type EmailContentPartResult 

type EmailContentPartResult struct {
	Content *string `json:"content,omitempty"`
}

EmailContentPartResult struct for EmailContentPartResult

type EmailControllerApiService 

type EmailControllerApiService service

EmailControllerApiService EmailControllerApi service

func (*EmailControllerApiService) ApplyImapFlagOperation 

func (a *EmailControllerApiService) ApplyImapFlagOperation(ctx _context.Context, emailId string, imapFlagOperationOptions ImapFlagOperationOptions) (EmailPreview, *_nethttp.Response, error)

ApplyImapFlagOperation Set IMAP flags associated with a message. Only supports '\\Seen' flag. Applies RFC3501 IMAP flag operations on a message. Current implementation supports read/unread semantics via the &#x60;\\\\Seen&#x60; flag only.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId
  • @param imapFlagOperationOptions

@return EmailPreview

func (*EmailControllerApiService) CanSend 

func (a *EmailControllerApiService) CanSend(ctx _context.Context, inboxId string, sendEmailOptions SendEmailOptions) (CanSendEmailResults, *_nethttp.Response, error)

CanSend Check whether an email send would be accepted Validates sender/inbox context and recipient eligibility before attempting a send. Useful for preflight checks in UI or test workflows.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId ID of the inbox you want to send the email from
  • @param sendEmailOptions

@return CanSendEmailResults

func (*EmailControllerApiService) CheckEmailAudit1 

func (a *EmailControllerApiService) CheckEmailAudit1(ctx _context.Context, emailId string) (EmailAuditAnalysisResult, *_nethttp.Response, error)

CheckEmailAudit1 Run aggregate email audit for a stored email Runs the same message-level audit bundle used by the email audit dashboard in one request. Combines content checks, HTML validation, compatibility analysis, and reputation verdict rollup when available.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId

@return EmailAuditAnalysisResult

func (*EmailControllerApiService) CheckEmailBody 

func (a *EmailControllerApiService) CheckEmailBody(ctx _context.Context, emailId string) (CheckEmailBodyResults, *_nethttp.Response, error)

CheckEmailBody Check email body for broken links, images, and spelling issues Runs content quality checks against hydrated email body content. This endpoint performs outbound HTTP checks for linked resources, so avoid use with sensitive or stateful URLs.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId

@return CheckEmailBodyResults

func (*EmailControllerApiService) CheckEmailBodyFeatureSupport 

func (a *EmailControllerApiService) CheckEmailBodyFeatureSupport(ctx _context.Context, emailId string) (CheckEmailBodyFeatureSupportResults, *_nethttp.Response, error)

CheckEmailBodyFeatureSupport Check client support for features used in a stored email body Detects HTML/CSS features in the target email body and reports compatibility across major email clients and devices.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId

@return CheckEmailBodyFeatureSupportResults

func (*EmailControllerApiService) CheckEmailClientSupport 

func (a *EmailControllerApiService) CheckEmailClientSupport(ctx _context.Context, checkEmailClientSupportOptions CheckEmailClientSupportOptions) (CheckEmailClientSupportResults, *_nethttp.Response, error)

CheckEmailClientSupport Check email-client support for a provided HTML body Evaluates HTML/CSS features in the supplied body and reports support coverage across major email clients and platforms.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param checkEmailClientSupportOptions

@return CheckEmailClientSupportResults

func (*EmailControllerApiService) CreateEmailAuditForEmail 

func (a *EmailControllerApiService) CreateEmailAuditForEmail(ctx _context.Context, emailId string) (EmailAuditDto, *_nethttp.Response, error)

CreateEmailAuditForEmail Persist aggregate email audit for a stored email Runs the aggregate audit bundle for the target email and stores the resulting audit record for later review and history tracking.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId

@return EmailAuditDto

func (*EmailControllerApiService) DeleteAllEmails 

func (a *EmailControllerApiService) DeleteAllEmails(ctx _context.Context) (*_nethttp.Response, error)

DeleteAllEmails Delete all emails in all inboxes. Deletes all emails for the authenticated account context. This operation is destructive and cannot be undone.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*EmailControllerApiService) DeleteEmail 

func (a *EmailControllerApiService) DeleteEmail(ctx _context.Context, emailId string) (*_nethttp.Response, error)

DeleteEmail Delete an email Deletes a single email from account scope. Operation is destructive and not reversible.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId ID of email to delete

func (*EmailControllerApiService) DownloadAttachment 

func (a *EmailControllerApiService) DownloadAttachment(ctx _context.Context, emailId string, attachmentId string, localVarOptionals *DownloadAttachmentOpts) (string, *_nethttp.Response, error)

DownloadAttachment Get email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string. Returns attachment bytes by attachment ID. Use attachment IDs from email payloads or attachment listing endpoints.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId ID of email
  • @param attachmentId ID of attachment
  • @param optional nil or *DownloadAttachmentOpts - Optional Parameters:
  • @param "ApiKey" (optional.String) - Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly.

@return string

func (*EmailControllerApiService) DownloadAttachmentBase64 

func (a *EmailControllerApiService) DownloadAttachmentBase64(ctx _context.Context, emailId string, attachmentId string) (DownloadAttachmentDto, *_nethttp.Response, error)

DownloadAttachmentBase64 Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`. Returns attachment payload as base64 in JSON. Useful for clients that cannot reliably consume binary streaming responses.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId ID of email
  • @param attachmentId ID of attachment

@return DownloadAttachmentDto

func (*EmailControllerApiService) DownloadBody 

func (a *EmailControllerApiService) DownloadBody(ctx _context.Context, emailId string) (string, *_nethttp.Response, error)

DownloadBody Get email body as string. Returned as `plain/text` with content type header. Returns hydrated email body text as a string with content type aligned to the underlying body format.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId ID of email

@return string

func (*EmailControllerApiService) DownloadBodyBytes 

func (a *EmailControllerApiService) DownloadBodyBytes(ctx _context.Context, emailId string) (string, *_nethttp.Response, error)

DownloadBodyBytes Get email body in bytes. Returned as `octet-stream` with content type header. Streams hydrated email body bytes with content type derived from the message body format.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId ID of email

@return string

func (*EmailControllerApiService) ForwardEmail 

func (a *EmailControllerApiService) ForwardEmail(ctx _context.Context, emailId string, forwardEmailOptions ForwardEmailOptions) (SentEmailDto, *_nethttp.Response, error)

ForwardEmail Forward email to recipients Forwards an existing email to new recipients. Uses the owning inbox context unless overridden by allowed sender options.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId ID of email
  • @param forwardEmailOptions

@return SentEmailDto

func (*EmailControllerApiService) GetAttachmentMetaData 

func (a *EmailControllerApiService) GetAttachmentMetaData(ctx _context.Context, emailId string, attachmentId string) (AttachmentMetaData, *_nethttp.Response, error)

GetAttachmentMetaData Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods. Returns metadata for a specific attachment ID (name, content type, and size fields).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId ID of email
  • @param attachmentId ID of attachment

@return AttachmentMetaData

func (*EmailControllerApiService) GetEmail 

func (a *EmailControllerApiService) GetEmail(ctx _context.Context, emailId string) (Email, *_nethttp.Response, error)

GetEmail Get hydrated email (headers and body) Returns parsed email content including headers and body fields. Accessing hydrated content may mark the email as read depending on read-state rules.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId

@return Email

func (*EmailControllerApiService) GetEmailAttachments 

func (a *EmailControllerApiService) GetEmailAttachments(ctx _context.Context, emailId string) ([]AttachmentMetaData, *_nethttp.Response, error)

GetEmailAttachments List attachment metadata for an email Returns metadata for all attachment IDs associated with the email (name, content type, size, and IDs).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId ID of email

@return []AttachmentMetaData

func (*EmailControllerApiService) GetEmailCodes 

func (a *EmailControllerApiService) GetEmailCodes(ctx _context.Context, emailId string, localVarOptionals *GetEmailCodesOpts) (ExtractCodesResult, *_nethttp.Response, error)

GetEmailCodes Extract verification codes from an email Extracts one-time passcodes and similar tokens from email content using the selected extraction method and fallback options.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId ID of email to extract codes from
  • @param optional nil or *GetEmailCodesOpts - Optional Parameters:
  • @param "ExtractCodesOptions" (optional.Interface of ExtractCodesOptions) -

@return ExtractCodesResult

func (*EmailControllerApiService) GetEmailContentMatch 

func (a *EmailControllerApiService) GetEmailContentMatch(ctx _context.Context, emailId string, contentMatchOptions ContentMatchOptions) (EmailContentMatchResult, *_nethttp.Response, error)

GetEmailContentMatch Run regex against hydrated email body and return matches Executes a Java regex pattern over hydrated email body text and returns the full match plus capture groups. Pattern syntax follows Java &#x60;Pattern&#x60; rules.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId ID of email to match against
  • @param contentMatchOptions

@return EmailContentMatchResult

func (*EmailControllerApiService) GetEmailContentPart 

func (a *EmailControllerApiService) GetEmailContentPart(ctx _context.Context, emailId string, contentType string, localVarOptionals *GetEmailContentPartOpts) (EmailContentPartResult, *_nethttp.Response, error)

GetEmailContentPart Get email content part by content type Extracts one MIME body part by &#x60;contentType&#x60; and optional &#x60;index&#x60;, returned in a structured DTO with metadata.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId ID of email to match against
  • @param contentType Content type
  • @param optional nil or *GetEmailContentPartOpts - Optional Parameters:
  • @param "Strict" (optional.Bool) - Strict content type match
  • @param "Index" (optional.Int32) - Index of content type part if multiple

@return EmailContentPartResult

func (*EmailControllerApiService) GetEmailContentPartContent 

func (a *EmailControllerApiService) GetEmailContentPartContent(ctx _context.Context, emailId string, contentType string, localVarOptionals *GetEmailContentPartContentOpts) (string, *_nethttp.Response, error)

GetEmailContentPartContent Get multipart content part as raw response Extracts one MIME body part by &#x60;contentType&#x60; and optional &#x60;index&#x60;, and returns raw content with matching response content type when valid.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId ID of email to match against
  • @param contentType Content type
  • @param optional nil or *GetEmailContentPartContentOpts - Optional Parameters:
  • @param "Strict" (optional.Bool) - Strict content type match
  • @param "Index" (optional.Int32) - Index of content type part if multiple. Starts from 0 and applies to the result list after selecting for your content type. Content type parts are sorted by order found in original MIME message.

@return string

func (*EmailControllerApiService) GetEmailCount 

func (a *EmailControllerApiService) GetEmailCount(ctx _context.Context, localVarOptionals *GetEmailCountOpts) (CountDto, *_nethttp.Response, error)

GetEmailCount Get email count Returns total email count for the authenticated user, or count scoped to a specific inbox when &#x60;inboxId&#x60; is provided.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetEmailCountOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) -

@return CountDto

func (*EmailControllerApiService) GetEmailHTML 

func (a *EmailControllerApiService) GetEmailHTML(ctx _context.Context, emailId string, localVarOptionals *GetEmailHTMLOpts) (string, *_nethttp.Response, error)

GetEmailHTML Get hydrated email HTML for browser rendering Returns hydrated HTML body directly with &#x60;text/html&#x60; content type. Supports temporary access/browser usage and optional CID replacement for inline asset rendering.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId
  • @param optional nil or *GetEmailHTMLOpts - Optional Parameters:
  • @param "ReplaceCidImages" (optional.Bool) -

@return string

func (*EmailControllerApiService) GetEmailHTMLJson 

func (a *EmailControllerApiService) GetEmailHTMLJson(ctx _context.Context, emailId string, localVarOptionals *GetEmailHTMLJsonOpts) (EmailHtmlDto, *_nethttp.Response, error)

GetEmailHTMLJson Get hydrated email HTML wrapped in JSON Returns hydrated HTML body and subject in a JSON DTO. Useful for API clients that need structured response payloads instead of raw HTML responses.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId
  • @param optional nil or *GetEmailHTMLJsonOpts - Optional Parameters:
  • @param "ReplaceCidImages" (optional.Bool) -

@return EmailHtmlDto

func (*EmailControllerApiService) GetEmailHTMLQuery 

func (a *EmailControllerApiService) GetEmailHTMLQuery(ctx _context.Context, emailId string, htmlSelector string) (EmailTextLinesResult, *_nethttp.Response, error)

GetEmailHTMLQuery Query hydrated HTML body and return matching text lines Applies a JSoup/CSS selector to hydrated HTML email body and returns matching text lines.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId ID of email to perform HTML query on
  • @param htmlSelector HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information.

@return EmailTextLinesResult 

func (a *EmailControllerApiService) GetEmailLinks(ctx _context.Context, emailId string, localVarOptionals *GetEmailLinksOpts) (EmailLinksResult, *_nethttp.Response, error)

GetEmailLinks Extract links from an email HTML body Parses HTML content and extracts link URLs (&#x60;href&#x60;). For non-HTML emails this endpoint returns a validation error.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId ID of email to fetch text for
  • @param optional nil or *GetEmailLinksOpts - Optional Parameters:
  • @param "Selector" (optional.String) - Optional HTML query selector for links

@return EmailLinksResult

func (*EmailControllerApiService) GetEmailPreviewURLs 

func (a *EmailControllerApiService) GetEmailPreviewURLs(ctx _context.Context, emailId string) (EmailPreviewUrls, *_nethttp.Response, error)

GetEmailPreviewURLs Get email URLs for viewing in browser or downloading Returns precomputed URLs for preview and raw message access for the specified email.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId

@return EmailPreviewUrls

func (*EmailControllerApiService) GetEmailScreenshotAsBase64 

func (a *EmailControllerApiService) GetEmailScreenshotAsBase64(ctx _context.Context, emailId string, getEmailScreenshotOptions GetEmailScreenshotOptions) (EmailScreenshotResult, *_nethttp.Response, error)

GetEmailScreenshotAsBase64 Take a screenshot of an email in a browser and return base64 encoded string Renders the email in a browser engine and returns PNG data as base64. Useful for APIs and dashboards that cannot easily stream binary responses.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId
  • @param getEmailScreenshotOptions

@return EmailScreenshotResult

func (*EmailControllerApiService) GetEmailScreenshotAsBinary 

func (a *EmailControllerApiService) GetEmailScreenshotAsBinary(ctx _context.Context, emailId string, getEmailScreenshotOptions GetEmailScreenshotOptions) (*_nethttp.Response, error)

GetEmailScreenshotAsBinary Take a screenshot of an email in a browser Renders the email in a browser engine and returns PNG bytes. Intended for visual QA and rendering regression checks.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId
  • @param getEmailScreenshotOptions

func (*EmailControllerApiService) GetEmailSignature 

func (a *EmailControllerApiService) GetEmailSignature(ctx _context.Context, emailId string) (EmailSignatureParseResult, *_nethttp.Response, error)

GetEmailSignature Extract signature from an inbound email Attempts to parse a sender signature block from an email body. Uses raw MIME content parts when possible and falls back to hydrated body parsing. This is heuristic and may not be accurate for all email clients or formats.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId ID of email to extract signature from

@return EmailSignatureParseResult

func (*EmailControllerApiService) GetEmailSummary 

func (a *EmailControllerApiService) GetEmailSummary(ctx _context.Context, emailId string, localVarOptionals *GetEmailSummaryOpts) (EmailPreview, *_nethttp.Response, error)

GetEmailSummary Get email summary (headers/metadata only) Returns lightweight metadata and headers for an email. Use &#x60;getEmail&#x60; for hydrated body content or &#x60;getRawEmail&#x60; for original SMTP content.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId
  • @param optional nil or *GetEmailSummaryOpts - Optional Parameters:
  • @param "Decode" (optional.Bool) - Deprecated and ignored. Retained for backwards compatibility.

@return EmailPreview

func (*EmailControllerApiService) GetEmailTextLines 

func (a *EmailControllerApiService) GetEmailTextLines(ctx _context.Context, emailId string, localVarOptionals *GetEmailTextLinesOpts) (EmailTextLinesResult, *_nethttp.Response, error)

GetEmailTextLines Extract normalized text lines from email body Converts email body content to line-based plain text with optional HTML entity decoding and custom line separator.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId ID of email to fetch text for
  • @param optional nil or *GetEmailTextLinesOpts - Optional Parameters:
  • @param "DecodeHtmlEntities" (optional.Bool) - Decode HTML entities
  • @param "LineSeparator" (optional.String) - Line separator character

@return EmailTextLinesResult

func (*EmailControllerApiService) GetEmailThread 

func (a *EmailControllerApiService) GetEmailThread(ctx _context.Context, threadId string) (EmailThreadDto, *_nethttp.Response, error)

GetEmailThread Get email thread metadata by thread ID Returns thread metadata built from RFC 5322 &#x60;Message-ID&#x60;, &#x60;In-Reply-To&#x60;, and &#x60;References&#x60; headers. Use &#x60;getEmailThreadItems&#x60; to fetch the thread messages.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param threadId

@return EmailThreadDto

func (*EmailControllerApiService) GetEmailThreadItems 

func (a *EmailControllerApiService) GetEmailThreadItems(ctx _context.Context, threadId string, localVarOptionals *GetEmailThreadItemsOpts) (EmailThreadItemsDto, *_nethttp.Response, error)

GetEmailThreadItems Get messages in a specific email thread Returns all messages in a thread ordered by &#x60;createdAt&#x60; using the requested sort direction.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param threadId
  • @param optional nil or *GetEmailThreadItemsOpts - Optional Parameters:
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC

@return EmailThreadItemsDto

func (*EmailControllerApiService) GetEmailThreads 

func (a *EmailControllerApiService) GetEmailThreads(ctx _context.Context, localVarOptionals *GetEmailThreadsOpts) (PageEmailThreadProjection, *_nethttp.Response, error)

GetEmailThreads List email threads in paginated form Lists conversation threads inferred from &#x60;Message-ID&#x60;, &#x60;In-Reply-To&#x60;, and &#x60;References&#x60;. Supports filtering by inbox, search text, and time range.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetEmailThreadsOpts - Optional Parameters:
  • @param "HtmlSelector" (optional.Interface of string) - Optional inbox filter. Query parameter name is `htmlSelector` for legacy compatibility.
  • @param "Page" (optional.Int32) - Optional page index in email thread pagination
  • @param "Size" (optional.Int32) - Optional page size in email thread pagination. Maximum size is 100. Use page index and sort to page through larger results
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "SearchFilter" (optional.String) - Optional search filter search filter for email threads.
  • @param "Since" (optional.Time) - Optional filter email threads created since time
  • @param "Before" (optional.Time) - Optional filter emails threads created before given date time

@return PageEmailThreadProjection

func (*EmailControllerApiService) GetEmailsOffsetPaginated 

func (a *EmailControllerApiService) GetEmailsOffsetPaginated(ctx _context.Context, localVarOptionals *GetEmailsOffsetPaginatedOpts) (PageEmailProjection, *_nethttp.Response, error)

GetEmailsOffsetPaginated Get all emails in all inboxes in paginated form. Email API list all. Offset-style pagination endpoint for listing emails across inboxes. Supports inbox filters, unread-only, search, date boundaries, favourites, connector sync, plus-address filtering, and explicit include IDs.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetEmailsOffsetPaginatedOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of []string) - Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
  • @param "Page" (optional.Int32) - Optional page index in email list pagination
  • @param "Size" (optional.Int32) - Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "UnreadOnly" (optional.Bool) - Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
  • @param "SearchFilter" (optional.String) - Optional search filter. Full email addresses match sender and receiving inbox email or receiving plus-address full address exactly. Address-like fragments containing @ (for example +alias@) also match sender, receiving inbox email, and receiving plus-address full address by contains. General text search matches sender, subject, and ID.
  • @param "Since" (optional.Time) - Optional filter emails received after given date time
  • @param "Before" (optional.Time) - Optional filter emails received before given date time
  • @param "Favourited" (optional.Bool) - Optional filter emails that are favourited
  • @param "SyncConnectors" (optional.Bool) - Sync connectors
  • @param "PlusAddressId" (optional.Interface of string) - Optional plus address ID filter
  • @param "Include" (optional.Interface of []string) - Optional list of IDs to include in result

@return PageEmailProjection

func (*EmailControllerApiService) GetEmailsPaginated 

func (a *EmailControllerApiService) GetEmailsPaginated(ctx _context.Context, localVarOptionals *GetEmailsPaginatedOpts) (PageEmailProjection, *_nethttp.Response, error)

GetEmailsPaginated Get all emails in all inboxes in paginated form. Email API list all. Primary paginated email listing endpoint. Returns emails across inboxes with support for inbox filters, unread-only, search, date boundaries, favourites, connector sync, and plus-address filtering.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetEmailsPaginatedOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of []string) - Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
  • @param "Page" (optional.Int32) - Optional page index in email list pagination
  • @param "Size" (optional.Int32) - Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "UnreadOnly" (optional.Bool) - Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
  • @param "SearchFilter" (optional.String) - Optional search filter. Full email addresses match sender and receiving inbox email or receiving plus-address full address exactly. Address-like fragments containing @ (for example +alias@) also match sender, receiving inbox email, and receiving plus-address full address by contains. General text search matches sender, subject, and ID.
  • @param "Since" (optional.Time) - Optional filter emails received after given date time. If unset will use time 24hours prior to now.
  • @param "Before" (optional.Time) - Optional filter emails received before given date time
  • @param "SyncConnectors" (optional.Bool) - Sync connectors
  • @param "PlusAddressId" (optional.Interface of string) - Optional plus address ID filter
  • @param "Favourited" (optional.Bool) - Optional filter emails that are favourited

@return PageEmailProjection

func (*EmailControllerApiService) GetGravatarUrlForEmailAddress 

func (a *EmailControllerApiService) GetGravatarUrlForEmailAddress(ctx _context.Context, emailAddress string, localVarOptionals *GetGravatarUrlForEmailAddressOpts) (GravatarUrl, *_nethttp.Response, error)

GetGravatarUrlForEmailAddress Get Gravatar URL for an email address Builds a Gravatar image URL from the provided email address and optional size. This endpoint does not fetch image bytes; it only returns the computed URL.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailAddress
  • @param optional nil or *GetGravatarUrlForEmailAddressOpts - Optional Parameters:
  • @param "Size" (optional.String) -

@return GravatarUrl

func (*EmailControllerApiService) GetLatestEmail 

func (a *EmailControllerApiService) GetLatestEmail(ctx _context.Context, localVarOptionals *GetLatestEmailOpts) (Email, *_nethttp.Response, error)

GetLatestEmail Get latest email in all inboxes. Most recently received. Returns the most recently received email across all inboxes or an optional subset of inbox IDs.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetLatestEmailOpts - Optional Parameters:
  • @param "InboxIds" (optional.Interface of []string) - Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes

@return Email

func (*EmailControllerApiService) GetLatestEmailInInbox1 

func (a *EmailControllerApiService) GetLatestEmailInInbox1(ctx _context.Context, inboxId string) (Email, *_nethttp.Response, error)

GetLatestEmailInInbox1 Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. Returns the newest email for the specified inbox ID. For polling/wait semantics use wait endpoints.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId ID of the inbox you want to get the latest email from

@return Email

func (*EmailControllerApiService) GetOrganizationEmailsPaginated 

func (a *EmailControllerApiService) GetOrganizationEmailsPaginated(ctx _context.Context, localVarOptionals *GetOrganizationEmailsPaginatedOpts) (PageEmailProjection, *_nethttp.Response, error)

GetOrganizationEmailsPaginated List organization-visible emails Returns paginated emails visible through organization/team access. Supports inbox filtering, unread-only filtering, search, favourites, plus-address filtering, and optional connector sync.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetOrganizationEmailsPaginatedOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of []string) - Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
  • @param "Page" (optional.Int32) - Optional page index in email list pagination
  • @param "Size" (optional.Int32) - Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "UnreadOnly" (optional.Bool) - Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
  • @param "SearchFilter" (optional.String) - Optional search filter search filter for emails.
  • @param "Since" (optional.Time) - Optional filter emails received after given date time. If unset will use time 24hours prior to now.
  • @param "Before" (optional.Time) - Optional filter emails received before given date time
  • @param "SyncConnectors" (optional.Bool) - Sync connectors
  • @param "Favourited" (optional.Bool) - Search only favorited emails
  • @param "PlusAddressId" (optional.Interface of string) - Optional plus address ID filter

@return PageEmailProjection

func (*EmailControllerApiService) GetRawEmailContents 

func (a *EmailControllerApiService) GetRawEmailContents(ctx _context.Context, emailId string) (*_nethttp.Response, error)

GetRawEmailContents Get raw email string. Returns unparsed raw SMTP message with headers and body. Returns the original unparsed SMTP/MIME message as &#x60;text/plain&#x60;. Use JSON variant if your client expects JSON transport.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId ID of email

func (*EmailControllerApiService) GetRawEmailJson 

func (a *EmailControllerApiService) GetRawEmailJson(ctx _context.Context, emailId string) (RawEmailJson, *_nethttp.Response, error)

GetRawEmailJson Get raw email in JSON. Unparsed SMTP message in JSON wrapper format. Returns the original unparsed SMTP/MIME message wrapped in a JSON DTO for API clients that avoid plain-text stream responses.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId ID of email

@return RawEmailJson

func (*EmailControllerApiService) GetUnreadEmailCount 

func (a *EmailControllerApiService) GetUnreadEmailCount(ctx _context.Context, localVarOptionals *GetUnreadEmailCountOpts) (UnreadCount, *_nethttp.Response, error)

GetUnreadEmailCount Get unread email count Returns unread email count. An email is considered read after dashboard/API retrieval depending on your read workflow.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetUnreadEmailCountOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Inbox ID filter for unread count scope

@return UnreadCount

func (*EmailControllerApiService) MarkAllAsRead 

func (a *EmailControllerApiService) MarkAllAsRead(ctx _context.Context, localVarOptionals *MarkAllAsReadOpts) (*_nethttp.Response, error)

MarkAllAsRead Mark all emails as read or unread Sets read state for all emails, optionally scoped to one inbox. Use &#x60;read&#x3D;false&#x60; to reset unread state in bulk.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *MarkAllAsReadOpts - Optional Parameters:
  • @param "Read" (optional.Bool) - What value to assign to email read property. Default true.
  • @param "InboxId" (optional.Interface of string) - Optional inbox ID filter

func (*EmailControllerApiService) MarkAsRead 

func (a *EmailControllerApiService) MarkAsRead(ctx _context.Context, emailId string, localVarOptionals *MarkAsReadOpts) (EmailPreview, *_nethttp.Response, error)

MarkAsRead Mark an email as read or unread Sets read state for one email. Useful when implementing custom mailbox workflows that treat viewed messages as unread.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId
  • @param optional nil or *MarkAsReadOpts - Optional Parameters:
  • @param "Read" (optional.Bool) - What value to assign to email read property. Default true.

@return EmailPreview

func (*EmailControllerApiService) ReplyToEmail 

func (a *EmailControllerApiService) ReplyToEmail(ctx _context.Context, emailId string, replyToEmailOptions ReplyToEmailOptions) (SentEmailDto, *_nethttp.Response, error)

ReplyToEmail Reply to an email Sends a reply using the original conversation context (subject/thread headers). Reply target resolution honors sender/reply-to semantics.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId ID of the email that should be replied to
  • @param replyToEmailOptions

@return SentEmailDto

func (*EmailControllerApiService) SearchEmails 

func (a *EmailControllerApiService) SearchEmails(ctx _context.Context, searchEmailsOptions SearchEmailsOptions, localVarOptionals *SearchEmailsOpts) (PageEmailProjection, *_nethttp.Response, error)

SearchEmails Get all emails by search criteria. Return in paginated form. Searches emails by sender/recipient/address/subject/id fields and returns paginated matches. Does not perform full-text body search.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param searchEmailsOptions
  • @param optional nil or *SearchEmailsOpts - Optional Parameters:
  • @param "SyncConnectors" (optional.Bool) - Sync connectors
  • @param "Favourited" (optional.Bool) - Search only favourited emails
  • @param "PlusAddressId" (optional.Interface of string) - Optional plus address ID filter

@return PageEmailProjection

func (*EmailControllerApiService) SendEmailSourceOptional 

func (a *EmailControllerApiService) SendEmailSourceOptional(ctx _context.Context, sendEmailOptions SendEmailOptions, localVarOptionals *SendEmailSourceOptionalOpts) (*_nethttp.Response, error)

SendEmailSourceOptional Send email Sends an email from an existing inbox, or creates a temporary inbox when &#x60;inboxId&#x60; is not provided. Supports &#x60;useDomainPool&#x60; and &#x60;virtualSend&#x60; inbox creation behavior for convenience sends.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param sendEmailOptions
  • @param optional nil or *SendEmailSourceOptionalOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - ID of the inbox you want to send the email from
  • @param "UseDomainPool" (optional.Bool) - Use domain pool. Optionally create inbox to send from using the mailslurp domain pool.
  • @param "VirtualSend" (optional.Bool) - Optionally create inbox to send from that is a virtual inbox and won't send to external addresses

func (*EmailControllerApiService) SetEmailFavourited 

func (a *EmailControllerApiService) SetEmailFavourited(ctx _context.Context, emailId string, favourited bool) (*_nethttp.Response, error)

SetEmailFavourited Set email favourited state Sets favourite state for an email for dashboard/search workflows.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId ID of email to set favourite state
  • @param favourited

func (*EmailControllerApiService) ValidateEmail 

func (a *EmailControllerApiService) ValidateEmail(ctx _context.Context, emailId string) (ValidationDto, *_nethttp.Response, error)

ValidateEmail Validate email HTML contents Runs HTML validation on the email body when HTML is present. Non-HTML emails are treated as valid for this check.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId ID of email

@return ValidationDto

type EmailFeatureCategoryName 

type EmailFeatureCategoryName struct {
	Slug string `json:"slug"`
	Name string `json:"name"`
}

EmailFeatureCategoryName struct for EmailFeatureCategoryName

type EmailFeatureFamilyName 

type EmailFeatureFamilyName struct {
	Slug string `json:"slug"`
	Name string `json:"name"`
}

EmailFeatureFamilyName struct for EmailFeatureFamilyName

type EmailFeatureFamilyStatistics 

type EmailFeatureFamilyStatistics struct {
	Feature   string                           `json:"feature"`
	Family    string                           `json:"family"`
	Platforms []EmailFeaturePlatformStatistics `json:"platforms"`
}

EmailFeatureFamilyStatistics struct for EmailFeatureFamilyStatistics

type EmailFeatureNames 

type EmailFeatureNames struct {
	Family   []EmailFeatureFamilyName   `json:"family"`
	Platform []EmailFeaturePlatformName `json:"platform"`
	Category []EmailFeatureCategoryName `json:"category"`
}

EmailFeatureNames struct for EmailFeatureNames

type EmailFeatureOverview 

type EmailFeatureOverview struct {
	Feature           string                         `json:"feature"`
	Title             string                         `json:"title,omitempty"`
	Description       string                         `json:"description,omitempty"`
	Category          string                         `json:"category,omitempty"`
	Notes             string                         `json:"notes,omitempty"`
	NotesNumbers      map[string]string              `json:"notesNumbers,omitempty"`
	FeatureStatistics []EmailFeatureFamilyStatistics `json:"featureStatistics,omitempty"`
	Statuses          []string                       `json:"statuses"`
}

EmailFeatureOverview struct for EmailFeatureOverview

type EmailFeaturePlatformName 

type EmailFeaturePlatformName struct {
	Slug string `json:"slug"`
	Name string `json:"name"`
}

EmailFeaturePlatformName struct for EmailFeaturePlatformName

type EmailFeaturePlatformStatistics 

type EmailFeaturePlatformStatistics struct {
	Platform string                          `json:"platform"`
	Versions []EmailFeatureVersionStatistics `json:"versions"`
}

EmailFeaturePlatformStatistics struct for EmailFeaturePlatformStatistics

type EmailFeatureSupportFlags 

type EmailFeatureSupportFlags struct {
	Status string   `json:"status"`
	Notes  []string `json:"notes,omitempty"`
}

EmailFeatureSupportFlags struct for EmailFeatureSupportFlags

type EmailFeatureSupportResult 

type EmailFeatureSupportResult struct {
	Names              EmailFeatureNames                     `json:"names"`
	DetectedFeatures   []string                              `json:"detectedFeatures"`
	FeatureOverviews   []EmailFeatureOverview                `json:"featureOverviews"`
	FeaturePercentages []EmailFeatureSupportStatusPercentage `json:"featurePercentages"`
}

EmailFeatureSupportResult struct for EmailFeatureSupportResult

type EmailFeatureSupportStatusPercentage 

type EmailFeatureSupportStatusPercentage struct {
	Status     string  `json:"status"`
	Percentage float32 `json:"percentage"`
}

EmailFeatureSupportStatusPercentage struct for EmailFeatureSupportStatusPercentage

type EmailFeatureVersionStatistics 

type EmailFeatureVersionStatistics struct {
	Version      string                   `json:"version"`
	SupportFlags EmailFeatureSupportFlags `json:"supportFlags"`
}

EmailFeatureVersionStatistics struct for EmailFeatureVersionStatistics

type EmailHeaderAnalysisSummary 

type EmailHeaderAnalysisSummary struct {
	Spf              string `json:"spf,omitempty"`
	Dkim             string `json:"dkim,omitempty"`
	Dmarc            string `json:"dmarc,omitempty"`
	FromDomain       string `json:"fromDomain,omitempty"`
	ReturnPathDomain string `json:"returnPathDomain,omitempty"`
}

EmailHeaderAnalysisSummary struct for EmailHeaderAnalysisSummary

type EmailHeaderReceivedHop 

type EmailHeaderReceivedHop struct {
	From      string `json:"from,omitempty"`
	By        string `json:"by,omitempty"`
	WithValue string `json:"withValue,omitempty"`
	Timestamp string `json:"timestamp,omitempty"`
	DelayMs   int64  `json:"delayMs,omitempty"`
}

EmailHeaderReceivedHop struct for EmailHeaderReceivedHop

type EmailHtmlDto 

type EmailHtmlDto struct {
	Subject string `json:"subject,omitempty"`
	Body    string `json:"body,omitempty"`
}

EmailHtmlDto struct for EmailHtmlDto

type EmailIntelligenceListResult 

type EmailIntelligenceListResult struct {
	Content       []EmailIntelligenceResultDto `json:"content"`
	Page          int32                        `json:"page"`
	Size          int32                        `json:"size"`
	TotalElements int64                        `json:"totalElements"`
	TotalPages    int32                        `json:"totalPages"`
	// Number of non-cached evaluations billed in this request. Internal or privileged requests always report 0.
	BillableCount int64 `json:"billableCount"`
}

EmailIntelligenceListResult Paginated email intelligence results.

type EmailIntelligenceOptions 

type EmailIntelligenceOptions struct {
	// Email addresses or domains to score.
	Targets []string `json:"targets"`
	// Zero-based page index for processing a subset of the target list.
	Page *int32 `json:"page,omitempty"`
	// Page size for processing a subset of the target list.
	Size *int32 `json:"size,omitempty"`
	// Ignore cached intelligence values and force recomputation.
	IgnoreCache *bool `json:"ignoreCache,omitempty"`
	// Also run mailbox safety verification using the existing verification client for email inputs.
	IncludeEmailValidation *bool                          `json:"includeEmailValidation,omitempty"`
	Tests                  *EmailIntelligenceTestsOptions `json:"tests,omitempty"`
}

EmailIntelligenceOptions Request options for running email intelligence checks on one or more inputs.

type EmailIntelligenceResultDto 

type EmailIntelligenceResultDto struct {
	// Original input value before normalization.
	Input string `json:"input"`
	// Score from 0 to 100 where higher is better.
	TotalScore     int32                              `json:"totalScore"`
	ScoreBreakdown EmailIntelligenceScoreBreakdownDto `json:"scoreBreakdown"`
	Signals        EmailIntelligenceSignalsDto        `json:"signals"`
}

EmailIntelligenceResultDto Email intelligence result for a single input.

type EmailIntelligenceScoreBreakdownDto 

type EmailIntelligenceScoreBreakdownDto struct {
	RandomnessPenalty      int32 `json:"randomnessPenalty"`
	FreeProviderPenalty    int32 `json:"freeProviderPenalty"`
	HttpsWebsitePenalty    int32 `json:"httpsWebsitePenalty"`
	DnsPenalty             int32 `json:"dnsPenalty"`
	DomainAgePenalty       int32 `json:"domainAgePenalty"`
	EmailValidationPenalty int32 `json:"emailValidationPenalty"`
	TotalPenalty           int32 `json:"totalPenalty"`
}

EmailIntelligenceScoreBreakdownDto Penalty breakdown used to compute email intelligence score.

type EmailIntelligenceSignalsDto 

type EmailIntelligenceSignalsDto struct {
	NormalizedTarget      string   `json:"normalizedTarget"`
	EmailAddress          *string  `json:"emailAddress,omitempty"`
	Domain                string   `json:"domain"`
	LocalPart             *string  `json:"localPart,omitempty"`
	RandomLocalPart       *bool    `json:"randomLocalPart,omitempty"`
	LocalPartEntropy      *float64 `json:"localPartEntropy,omitempty"`
	FreeEmailProvider     *bool    `json:"freeEmailProvider,omitempty"`
	HasHttpsWebsite       *bool    `json:"hasHttpsWebsite,omitempty"`
	DnsARecordPresent     *bool    `json:"dnsARecordPresent,omitempty"`
	DnsMxRecordPresent    *bool    `json:"dnsMxRecordPresent,omitempty"`
	SoaRecordPresent      *bool    `json:"soaRecordPresent,omitempty"`
	DomainAgeHintDays     *int64   `json:"domainAgeHintDays,omitempty"`
	NeverBounceSafeToSend *bool    `json:"neverBounceSafeToSend,omitempty"`
	Notes                 []string `json:"notes"`
}

EmailIntelligenceSignalsDto Computed signals for an email intelligence result.

type EmailIntelligenceTestsOptions 

type EmailIntelligenceTestsOptions struct {
	// Check local-part randomness for email inputs.
	CheckRandomLocalPart *bool `json:"checkRandomLocalPart,omitempty"`
	// Check if domain is a known free email provider.
	CheckFreeProvider *bool `json:"checkFreeProvider,omitempty"`
	// Check if the domain has a reachable HTTPS website.
	CheckHttpsWebsite *bool `json:"checkHttpsWebsite,omitempty"`
	// Check DNS records (A, MX, SOA) for the domain.
	CheckDns *bool `json:"checkDns,omitempty"`
	// Derive a domain age hint from DNS SOA serial when possible.
	CheckDomainAgeHint *bool `json:"checkDomainAgeHint,omitempty"`
}

EmailIntelligenceTestsOptions Optional test toggles for email intelligence scoring.

type EmailLinksResult 

type EmailLinksResult struct {
	Links []string `json:"links"`
	Body  string   `json:"body"`
}

EmailLinksResult Links found in HTML

type EmailPreview 

type EmailPreview struct {
	// ID of the email entity
	Id string `json:"id"`
	// ID of the inbox that received the email
	InboxId *string `json:"inboxId,omitempty"`
	// ID of the domain that received the email
	DomainId *string `json:"domainId,omitempty"`
	// The subject line of the email message as specified by SMTP subject header
	Subject *string `json:"subject,omitempty"`
	// List of `To` recipient email addresses that the email was addressed to. See recipients object for names.
	To *[]string `json:"to"`
	// Who the email was sent from. An email address - see fromName for the sender name.
	From *string `json:"from,omitempty"`
	// List of `BCC` recipients email addresses that the email was addressed to. See recipients object for names.
	Bcc *[]string `json:"bcc,omitempty"`
	// List of `CC` recipients email addresses that the email was addressed to. See recipients object for names.
	Cc *[]string `json:"cc,omitempty"`
	// When was the email received by MailSlurp
	CreatedAt time.Time `json:"createdAt"`
	// Read flag. Has the email ever been viewed in the dashboard or fetched via the API with a hydrated body? If so the email is marked as read. Paginated results do not affect read status. Read status is different to email opened event as it depends on your own account accessing the email. Email opened is determined by tracking pixels sent to other uses if enable during sending. You can listened for both email read and email opened events using webhooks.
	Read bool `json:"read"`
	// List of IDs of attachments found in the email. Use these IDs with the Inbox and Email Controllers to download attachments and attachment meta data such as filesize, name, extension.
	Attachments *[]string `json:"attachments,omitempty"`
	// MailSlurp thread ID for email chain that enables lookup for In-Reply-To and References fields.
	ThreadId *string `json:"threadId,omitempty"`
	// RFC 5322 Message-ID header value without angle brackets.
	MessageId *string `json:"messageId,omitempty"`
	// Parsed value of In-Reply-To header. A Message-ID in a thread.
	InReplyTo            *string          `json:"inReplyTo,omitempty"`
	Sender               *Sender          `json:"sender,omitempty"`
	Recipients           *EmailRecipients `json:"recipients,omitempty"`
	Favourite            *bool            `json:"favourite,omitempty"`
	BodyPartContentTypes *[]string        `json:"bodyPartContentTypes,omitempty"`
	PlusAddress          *string          `json:"plusAddress,omitempty"`
	SizeBytes            *int64           `json:"sizeBytes,omitempty"`
}

EmailPreview Preview of an email message. For full message (including body and attachments) call the `getEmail` or other email endpoints with the provided email ID.

type EmailPreviewUrls 

type EmailPreviewUrls struct {
	RawSmtpMessageUrl string `json:"rawSmtpMessageUrl"`
	PlainHtmlBodyUrl  string `json:"plainHtmlBodyUrl"`
	Origin            string `json:"origin"`
}

EmailPreviewUrls URLs for email body

type EmailProjection 

type EmailProjection struct {
	Id                   string           `json:"id"`
	ThreadId             *string          `json:"threadId,omitempty"`
	From                 *string          `json:"from"`
	Subject              *string          `json:"subject,omitempty"`
	Sender               *Sender          `json:"sender,omitempty"`
	Recipients           *EmailRecipients `json:"recipients,omitempty"`
	InboxId              string           `json:"inboxId"`
	Attachments          *[]string        `json:"attachments,omitempty"`
	SizeBytes            *int64           `json:"sizeBytes,omitempty"`
	CreatedAt            time.Time        `json:"createdAt"`
	To                   []string         `json:"to"`
	Cc                   *[]string        `json:"cc,omitempty"`
	Bcc                  *[]string        `json:"bcc,omitempty"`
	MessageId            *string          `json:"messageId,omitempty"`
	Favourite            *bool            `json:"favourite,omitempty"`
	DomainId             *string          `json:"domainId,omitempty"`
	PlusAddress          *string          `json:"plusAddress,omitempty"`
	ImapUid              *int64           `json:"imapUid,omitempty"`
	InReplyTo            *string          `json:"inReplyTo,omitempty"`
	Read                 bool             `json:"read"`
	BodyExcerpt          *string          `json:"bodyExcerpt,omitempty"`
	TextExcerpt          *string          `json:"textExcerpt,omitempty"`
	BodyPartContentTypes *[]string        `json:"bodyPartContentTypes,omitempty"`
	BodyMD5Hash          *string          `json:"bodyMD5Hash,omitempty"`
	TeamAccess           bool             `json:"teamAccess"`
}

EmailProjection A compact representation of a full email. Used in list endpoints to keep response sizes low. Body and attachments are not included. To get all fields of the email use the `getEmail` method with the email projection's ID. See `EmailDto` for documentation on projection properties.

type EmailRecipients 

type EmailRecipients struct {
	To  []Recipient `json:"to,omitempty"`
	Cc  []Recipient `json:"cc,omitempty"`
	Bcc []Recipient `json:"bcc,omitempty"`
}

EmailRecipients The `To`,`CC`,`BCC` recipients stored in object form with email address and name accessible.

type EmailRecipientsProjection 

type EmailRecipientsProjection struct {
	To  []RecipientProjection `json:"to,omitempty"`
	Cc  []RecipientProjection `json:"cc,omitempty"`
	Bcc []RecipientProjection `json:"bcc,omitempty"`
}

EmailRecipientsProjection Recipients of original email in thread

type EmailScreenshotResult 

type EmailScreenshotResult struct {
	Base64EncodedImage string `json:"base64EncodedImage"`
}

EmailScreenshotResult struct for EmailScreenshotResult

type EmailSignature 

type EmailSignature struct {
	// Extracted signature text
	Body string `json:"body"`
	// Source used for extraction. Examples: RAW_TEXT_PART, RAW_HTML_SELECTOR
	Source string `json:"source"`
	// Matched marker or selector that identified the signature
	Marker *string `json:"marker,omitempty"`
	// Detection strategy used. Examples: DELIMITER, MOBILE_FOOTER, VALEDICTION
	DetectionType string `json:"detectionType"`
}

EmailSignature Parsed signature block detected in an email

type EmailSignatureParseResult 

type EmailSignatureParseResult struct {
	// True when a signature block was detected
	Present   bool            `json:"present"`
	Signature *EmailSignature `json:"signature,omitempty"`
}

EmailSignatureParseResult Result of attempting to parse an email signature

type EmailTextLinesResult 

type EmailTextLinesResult struct {
	Lines []string `json:"lines"`
	Body  string   `json:"body"`
}

EmailTextLinesResult Parsed text of an email

type EmailThreadDto 

type EmailThreadDto struct {
	// ID of email thread
	Id string `json:"id"`
	// User ID
	UserId string `json:"userId"`
	// Inbox ID
	InboxId string `json:"inboxId,omitempty"`
	// From sender
	From string `json:"from,omitempty"`
	// To recipients
	To []string `json:"to"`
	// CC recipients
	Cc []string `json:"cc,omitempty"`
	// BCC recipients
	Bcc        []string         `json:"bcc,omitempty"`
	Sender     *Sender          `json:"sender,omitempty"`
	Recipients *EmailRecipients `json:"recipients,omitempty"`
	// Thread topic subject
	Subject string `json:"subject,omitempty"`
	// Created at DateTime
	CreatedAt time.Time `json:"createdAt"`
	// Updated at DateTime
	UpdatedAt time.Time `json:"updatedAt"`
}

EmailThreadDto struct for EmailThreadDto

type EmailThreadItem 

type EmailThreadItem struct {
	ItemType    string           `json:"itemType"`
	EntityId    string           `json:"entityId"`
	BodyExcerpt *string          `json:"bodyExcerpt,omitempty"`
	TextExcerpt *string          `json:"textExcerpt,omitempty"`
	Subject     *string          `json:"subject,omitempty"`
	To          []string         `json:"to"`
	From        *string          `json:"from,omitempty"`
	Bcc         *[]string        `json:"bcc,omitempty"`
	Cc          *[]string        `json:"cc,omitempty"`
	Attachments *[]string        `json:"attachments,omitempty"`
	CreatedAt   time.Time        `json:"createdAt"`
	Read        bool             `json:"read"`
	InReplyTo   *string          `json:"inReplyTo,omitempty"`
	MessageId   *string          `json:"messageId,omitempty"`
	ThreadId    *string          `json:"threadId,omitempty"`
	Sender      *Sender          `json:"sender,omitempty"`
	Recipients  *EmailRecipients `json:"recipients,omitempty"`
}

EmailThreadItem struct for EmailThreadItem

type EmailThreadItemsDto 

type EmailThreadItemsDto struct {
	Items []EmailThreadItem `json:"items"`
}

EmailThreadItemsDto struct for EmailThreadItemsDto

type EmailThreadProjection 

type EmailThreadProjection struct {
	// ID of email thread
	Id string `json:"id"`
	// From sender
	From string `json:"from,omitempty"`
	// Thread topic subject
	Subject    string                    `json:"subject,omitempty"`
	Sender     SenderProjection          `json:"sender,omitempty"`
	Recipients EmailRecipientsProjection `json:"recipients,omitempty"`
	// User ID
	UserId string `json:"userId"`
	// Inbox ID
	InboxId string `json:"inboxId,omitempty"`
	// Updated at DateTime
	UpdatedAt time.Time `json:"updatedAt"`
	// Created at DateTime
	CreatedAt time.Time `json:"createdAt"`
	// To recipients
	To []string `json:"to"`
	// CC recipients
	Cc []string `json:"cc,omitempty"`
	// BCC recipients
	Bcc []string `json:"bcc,omitempty"`
	// Has attachments
	HasAttachments bool `json:"hasAttachments"`
	// Has unread
	Unread bool `json:"unread"`
	// Number of messages in the thread
	MessageCount int32 `json:"messageCount"`
	// Last body excerpt
	LastBodyExcerpt string `json:"lastBodyExcerpt,omitempty"`
	// Last text excerpt
	LastTextExcerpt string `json:"lastTextExcerpt,omitempty"`
	// Last email created time
	LastCreatedAt time.Time `json:"lastCreatedAt,omitempty"`
	// Last sender
	LastFrom   string           `json:"lastFrom,omitempty"`
	LastSender SenderProjection `json:"lastSender,omitempty"`
}

EmailThreadProjection An email thread is a message thread created for a email based on Message-ID, In-Reply-To, and References headers

type EmailValidationRequestDto 

type EmailValidationRequestDto struct {
	Id           string    `json:"id"`
	UserId       string    `json:"userId"`
	EmailAddress string    `json:"emailAddress"`
	IsValid      bool      `json:"isValid"`
	CreatedAt    time.Time `json:"createdAt"`
	UpdatedAt    time.Time `json:"updatedAt"`
}

EmailValidationRequestDto Email validation request

type EmailVerificationControllerApiService 

type EmailVerificationControllerApiService service

EmailVerificationControllerApiService EmailVerificationControllerApi service

func (*EmailVerificationControllerApiService) DeleteAllValidationRequests 

func (a *EmailVerificationControllerApiService) DeleteAllValidationRequests(ctx _context.Context) (*_nethttp.Response, error)

DeleteAllValidationRequests Delete all validation requests Remove validation requests

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*EmailVerificationControllerApiService) DeleteValidationRequest 

func (a *EmailVerificationControllerApiService) DeleteValidationRequest(ctx _context.Context, id string) (*_nethttp.Response, error)

DeleteValidationRequest Delete a validation record Delete a validation record

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

func (*EmailVerificationControllerApiService) GetEmailIntelligence 

func (a *EmailVerificationControllerApiService) GetEmailIntelligence(ctx _context.Context, emailIntelligenceOptions EmailIntelligenceOptions) (EmailIntelligenceListResult, *_nethttp.Response, error)

GetEmailIntelligence Get intelligence score and breakdown for email/domain targets. Per unit billing for non-cached evaluations. Run email intelligence scoring for one or more email addresses or domains. Submitting a single target in the list supports one-off checks.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailIntelligenceOptions

@return EmailIntelligenceListResult

func (*EmailVerificationControllerApiService) GetValidationRequests 

func (a *EmailVerificationControllerApiService) GetValidationRequests(ctx _context.Context, localVarOptionals *GetValidationRequestsOpts) (PageEmailValidationRequest, *_nethttp.Response, error)

GetValidationRequests Validate a list of email addresses. Per unit billing. See your plan for pricing. List email verification requests

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetValidationRequestsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size for paginated result list.
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "SearchFilter" (optional.String) - Optional search filter
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp
  • @param "IsValid" (optional.Bool) - Filter where email is valid is true or false

@return PageEmailValidationRequest

func (*EmailVerificationControllerApiService) ValidateEmailAddressList 

func (a *EmailVerificationControllerApiService) ValidateEmailAddressList(ctx _context.Context, validateEmailAddressListOptions ValidateEmailAddressListOptions) (ValidateEmailAddressListResult, *_nethttp.Response, error)

ValidateEmailAddressList Validate a list of email addresses. Per unit billing. See your plan for pricing. Verify a list of email addresses is valid and can be contacted.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param validateEmailAddressListOptions

@return ValidateEmailAddressListResult

type EmailVerificationResult 

type EmailVerificationResult struct {
	DomainName   string  `json:"domainName"`
	Port         int32   `json:"port"`
	EmailAddress string  `json:"emailAddress"`
	IsValid      bool    `json:"isValid"`
	Error        *string `json:"error,omitempty"`
}

EmailVerificationResult Email verification result. Valid means email address exists according to response from mail server running at the domain and port given.

type EmergencyAddress 

type EmergencyAddress struct {
	Id           string    `json:"id"`
	Sid          string    `json:"sid"`
	UserId       string    `json:"userId"`
	DisplayName  string    `json:"displayName"`
	CustomerName string    `json:"customerName"`
	Address1     string    `json:"address1"`
	City         string    `json:"city"`
	Region       string    `json:"region"`
	PostalCode   string    `json:"postalCode"`
	PhoneCountry string    `json:"phoneCountry"`
	AccountSid   string    `json:"accountSid"`
	CreatedAt    time.Time `json:"createdAt"`
	UpdatedAt    time.Time `json:"updatedAt"`
}

EmergencyAddress struct for EmergencyAddress

type EmergencyAddressDto 

type EmergencyAddressDto struct {
	Id           string `json:"id"`
	Address1     string `json:"address1"`
	PhoneCountry string `json:"phoneCountry"`
}

EmergencyAddressDto struct for EmergencyAddressDto

type EmptyResponseDto 

type EmptyResponseDto struct {
	Message string `json:"message,omitempty"`
}

EmptyResponseDto struct for EmptyResponseDto

type EnsureDevicePreviewRunOpts 

type EnsureDevicePreviewRunOpts struct {
	CreateDevicePreviewOptions optional.Interface
}

EnsureDevicePreviewRunOpts Optional parameters for the method 'EnsureDevicePreviewRun'

type EntityAutomationItemProjection 

type EntityAutomationItemProjection struct {
	Name           string `json:"name,omitempty"`
	Id             string `json:"id"`
	InboxId        string `json:"inboxId,omitempty"`
	PhoneId        string `json:"phoneId,omitempty"`
	Action         string `json:"action,omitempty"`
	AutomationType string `json:"automationType"`
}

EntityAutomationItemProjection struct for EntityAutomationItemProjection

type EntityEventItemProjection 

type EntityEventItemProjection struct {
	Id        string `json:"id"`
	Severity  string `json:"severity"`
	EventType string `json:"eventType"`
	InboxId   string `json:"inboxId,omitempty"`
	PhoneId   string `json:"phoneId,omitempty"`
}

EntityEventItemProjection struct for EntityEventItemProjection

type EntityFavouriteItemProjection 

type EntityFavouriteItemProjection struct {
	Name        string    `json:"name"`
	Id          string    `json:"id"`
	Description string    `json:"description,omitempty"`
	CreatedAt   time.Time `json:"createdAt"`
	EntityType  string    `json:"entityType"`
}

EntityFavouriteItemProjection struct for EntityFavouriteItemProjection

type ExpirationDefaults 

type ExpirationDefaults struct {
	DefaultExpirationMillis *int64     `json:"defaultExpirationMillis,omitempty"`
	MaxExpirationMillis     *int64     `json:"maxExpirationMillis,omitempty"`
	DefaultExpiresAt        *time.Time `json:"defaultExpiresAt,omitempty"`
	// Use nextInboxAllowsPermanent instead
	CanPermanentInbox        bool `json:"canPermanentInbox"`
	NextInboxAllowsPermanent bool `json:"nextInboxAllowsPermanent"`
}

ExpirationDefaults Expiration defaults for your account

type ExpiredControllerApiService 

type ExpiredControllerApiService service

ExpiredControllerApiService ExpiredControllerApi service

func (*ExpiredControllerApiService) GetExpirationDefaults 

func (a *ExpiredControllerApiService) GetExpirationDefaults(ctx _context.Context) (ExpirationDefaults, *_nethttp.Response, error)

GetExpirationDefaults Get default expiration settings Return default times used for inbox expiration

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ExpirationDefaults

func (*ExpiredControllerApiService) GetExpiredInboxByInboxId 

func (a *ExpiredControllerApiService) GetExpiredInboxByInboxId(ctx _context.Context, inboxId string) (ExpiredInboxDto, *_nethttp.Response, error)

GetExpiredInboxByInboxId Get expired inbox record for a previously existing inbox Use the inboxId to return an ExpiredInboxRecord if an inbox has expired. Inboxes expire and are disabled if an expiration date is set or plan requires. Returns 404 if no expired inbox is found for the inboxId

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId ID of inbox you want to retrieve (not the inbox ID)

@return ExpiredInboxDto

func (*ExpiredControllerApiService) GetExpiredInboxRecord 

func (a *ExpiredControllerApiService) GetExpiredInboxRecord(ctx _context.Context, expiredId string) (ExpiredInboxDto, *_nethttp.Response, error)

GetExpiredInboxRecord Get an expired inbox record Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity. You can still read emails in the inbox but it can no longer send or receive emails. Fetch the expired inboxes to view the old inboxes properties

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param expiredId ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId

@return ExpiredInboxDto

func (*ExpiredControllerApiService) GetExpiredInboxes 

func (a *ExpiredControllerApiService) GetExpiredInboxes(ctx _context.Context, localVarOptionals *GetExpiredInboxesOpts) (PageExpiredInboxRecordProjection, *_nethttp.Response, error)

GetExpiredInboxes List records of expired inboxes Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetExpiredInboxesOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in inbox sent email list pagination
  • @param "Size" (optional.Int32) - Optional page size in inbox sent email list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp
  • @param "InboxId" (optional.Interface of string) - Optionally filter by inbox ID

@return PageExpiredInboxRecordProjection

type ExpiredInboxDto 

type ExpiredInboxDto struct {
	Id           string `json:"id"`
	InboxId      string `json:"inboxId"`
	EmailAddress string `json:"emailAddress"`
}

ExpiredInboxDto Expired inbox

type ExpiredInboxRecordProjection 

type ExpiredInboxRecordProjection struct {
	Id           string    `json:"id"`
	UserId       string    `json:"userId"`
	EmailAddress string    `json:"emailAddress"`
	CreatedAt    time.Time `json:"createdAt"`
}

ExpiredInboxRecordProjection Record of inbox expiration

type ExportControllerApiService 

type ExportControllerApiService service

ExportControllerApiService ExportControllerApi service

func (*ExportControllerApiService) ExportEntities 

func (a *ExportControllerApiService) ExportEntities(ctx _context.Context, exportType string, apiKey string, outputFormat string, localVarOptionals *ExportEntitiesOpts) (string, *_nethttp.Response, error)

ExportEntities Export inboxes link callable via browser

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param exportType
  • @param apiKey
  • @param outputFormat
  • @param optional nil or *ExportEntitiesOpts - Optional Parameters:
  • @param "Filter" (optional.String) -
  • @param "ListSeparatorToken" (optional.String) -
  • @param "ExcludePreviouslyExported" (optional.Bool) -
  • @param "CreatedEarliestTime" (optional.Time) -
  • @param "CreatedOldestTime" (optional.Time) -

@return string 

func (a *ExportControllerApiService) GetExportLink(ctx _context.Context, exportType string, exportOptions ExportOptions, localVarOptionals *GetExportLinkOpts) (ExportLink, *_nethttp.Response, error)

GetExportLink Get export link

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param exportType
  • @param exportOptions
  • @param optional nil or *GetExportLinkOpts - Optional Parameters:
  • @param "ApiKey" (optional.String) -

@return ExportLink

type ExportDeliverabilityTestResultsOpts 

type ExportDeliverabilityTestResultsOpts struct {
	Matched optional.Bool
}

ExportDeliverabilityTestResultsOpts Optional parameters for the method 'ExportDeliverabilityTestResults'

type ExportEntitiesOpts 

type ExportEntitiesOpts struct {
	Filter                    optional.String
	ListSeparatorToken        optional.String
	ExcludePreviouslyExported optional.Bool
	CreatedEarliestTime       optional.Time
	CreatedOldestTime         optional.Time
}

ExportEntitiesOpts Optional parameters for the method 'ExportEntities' 

type ExportLink struct {
	DownloadLink string `json:"downloadLink"`
}

ExportLink Export download link

type ExportOptions 

type ExportOptions struct {
	OutputFormat              string     `json:"outputFormat"`
	ExcludePreviouslyExported *bool      `json:"excludePreviouslyExported,omitempty"`
	CreatedEarliestTime       *time.Time `json:"createdEarliestTime,omitempty"`
	CreatedOldestTime         *time.Time `json:"createdOldestTime,omitempty"`
	Filter                    *string    `json:"filter,omitempty"`
	ListSeparatorToken        *string    `json:"listSeparatorToken,omitempty"`
}

ExportOptions Options for exporting user data

type ExportTransformerOptions 

type ExportTransformerOptions struct {
	AiTransformId          *string    `json:"aiTransformId,omitempty"`
	AiMappingId            *string    `json:"aiMappingId,omitempty"`
	FlattenArrays          bool       `json:"flattenArrays"`
	Since                  *time.Time `json:"since,omitempty"`
	Before                 *time.Time `json:"before,omitempty"`
	Format                 string     `json:"format"`
	InboxId                *string    `json:"inboxId,omitempty"`
	PhoneId                *string    `json:"phoneId,omitempty"`
	EmailId                *string    `json:"emailId,omitempty"`
	SmsId                  *string    `json:"smsId,omitempty"`
	AttachmentId           *string    `json:"attachmentId,omitempty"`
	IncludeMetaData        bool       `json:"includeMetaData"`
	Delimiter              *string    `json:"delimiter,omitempty"`
	ArraySeparator         *string    `json:"arraySeparator,omitempty"`
	IncludeMetaDataColumns *[]string  `json:"includeMetaDataColumns,omitempty"`
}

ExportTransformerOptions struct for ExportTransformerOptions

type ExportTransformerResponse 

type ExportTransformerResponse struct {
	JobId  string `json:"jobId"`
	Status string `json:"status"`
}

ExportTransformerResponse struct for ExportTransformerResponse

type ExportTransformerResultJobDto 

type ExportTransformerResultJobDto struct {
	Id          string    `json:"id"`
	Status      string    `json:"status"`
	Format      string    `json:"format"`
	FileName    string    `json:"fileName,omitempty"`
	DownloadUrl string    `json:"downloadUrl,omitempty"`
	CreatedAt   time.Time `json:"createdAt"`
	UpdatedAt   time.Time `json:"updatedAt"`
}

ExportTransformerResultJobDto struct for ExportTransformerResultJobDto

type ExtractAttachmentTextOptions 

type ExtractAttachmentTextOptions struct {
	// Method for extracting text from attachments.
	Method *string `json:"method,omitempty"`
	// Allow fallback to native extraction when the selected method is unavailable.
	AllowFallback bool `json:"allowFallback,omitempty"`
	// Maximum bytes to read from attachment for native text extraction.
	MaxBytes *int64 `json:"maxBytes,omitempty"`
}

ExtractAttachmentTextOptions Options for extracting text from an attachment. Choose a method and whether fallback is allowed.

type ExtractAttachmentTextOpts 

type ExtractAttachmentTextOpts struct {
	ExtractAttachmentTextOptions optional.Interface
}

ExtractAttachmentTextOpts Optional parameters for the method 'ExtractAttachmentText'

type ExtractAttachmentTextResult 

type ExtractAttachmentTextResult struct {
	// True if extracted text is present
	Present bool `json:"present"`
	// Extracted text when present
	Text *string `json:"text,omitempty"`
	// Method for extracting text from attachments.
	MethodUsed *string `json:"methodUsed,omitempty"`
	// Detected attachment content type
	ContentType *string `json:"contentType,omitempty"`
	// Warnings or fallback notes
	Warnings []string `json:"warnings"`
}

ExtractAttachmentTextResult Extracted text result for an attachment

type ExtractCodesOptions 

type ExtractCodesOptions struct {
	// Extraction strategy for verification codes. Unsupported strategies may fall back when allowFallback is true.
	Method *string `json:"method,omitempty"`
	// Allow fallback to deterministic pattern extraction when the selected method is unavailable.
	AllowFallback bool `json:"allowFallback,omitempty"`
	// Minimum code length to consider. Typical OTP values are between 4 and 8 characters.
	MinLength int32 `json:"minLength,omitempty"`
	// Maximum code length to consider.
	MaxLength int32 `json:"maxLength,omitempty"`
	// Maximum number of code candidates to return. Best candidate is also returned separately.
	MaxCandidates int32 `json:"maxCandidates,omitempty"`
	// Optional custom regex patterns for code extraction. Each pattern should have either one capture group for the code or match the full code directly.
	CustomPatterns *[]string `json:"customPatterns,omitempty"`
}

ExtractCodesOptions Options for extracting verification codes from email or SMS content. Use method to control extraction strategy and allowFallback to control strictness.

type ExtractCodesResult 

type ExtractCodesResult struct {
	// True if at least one code candidate was found
	Found bool `json:"found"`
	// Best candidate code when found
	Code *string `json:"code,omitempty"`
	// Extraction strategy for verification codes. Unsupported strategies may fall back when allowFallback is true.
	MethodUsed *string `json:"methodUsed,omitempty"`
	// Ranked code candidates
	Candidates []CodeCandidate `json:"candidates"`
	// Warnings or fallback notes explaining extraction behavior for debugging and QA.
	Warnings []string `json:"warnings"`
}

ExtractCodesResult Result of extracting verification codes from message content

type FakeEmailDto 

type FakeEmailDto struct {
	Id              string           `json:"id"`
	EmailAddress    string           `json:"emailAddress"`
	Sender          *Sender          `json:"sender,omitempty"`
	Recipients      *EmailRecipients `json:"recipients,omitempty"`
	AttachmentNames []string         `json:"attachmentNames"`
	Subject         string           `json:"subject,omitempty"`
	Preview         string           `json:"preview,omitempty"`
	// use read content endpoints instead
	Body        string    `json:"body"`
	Seen        bool      `json:"seen"`
	CreatedAt   time.Time `json:"createdAt"`
	ContentType string    `json:"contentType"`
	BodyUrl     string    `json:"bodyUrl"`
}

FakeEmailDto struct for FakeEmailDto

type FakeEmailPreview 

type FakeEmailPreview struct {
	Id             string           `json:"id"`
	EmailAddress   string           `json:"emailAddress"`
	Sender         *Sender          `json:"sender,omitempty"`
	Recipients     *EmailRecipients `json:"recipients,omitempty"`
	HasAttachments bool             `json:"hasAttachments"`
	Subject        string           `json:"subject,omitempty"`
	Preview        string           `json:"preview,omitempty"`
	CreatedAt      time.Time        `json:"createdAt"`
	Seen           bool             `json:"seen"`
}

FakeEmailPreview struct for FakeEmailPreview

type FakeEmailResult 

type FakeEmailResult struct {
	Email FakeEmailDto `json:"email,omitempty"`
}

FakeEmailResult struct for FakeEmailResult

type FilterBouncedRecipientsOptions 

type FilterBouncedRecipientsOptions struct {
	EmailRecipients []string `json:"emailRecipients"`
}

FilterBouncedRecipientsOptions Options for filtering bounced email recipients

type FilterBouncedRecipientsResult 

type FilterBouncedRecipientsResult struct {
	FilteredRecipients []string `json:"filteredRecipients"`
}

FilterBouncedRecipientsResult Remaining recipients that were filtered to remove bounced recipients

type FlushExpiredInboxesResult 

type FlushExpiredInboxesResult struct {
	// Inbox IDs affected by expiration
	InboxIds []string `json:"inboxIds"`
	// DateTime to filter inboxes so that those expiring before this time are expired
	ExpireBefore time.Time `json:"expireBefore"`
}

FlushExpiredInboxesResult Result from calling expire on any inboxes that have applicable expiration dates given current time.

type FlushExpiredOpts 

type FlushExpiredOpts struct {
	Before optional.Time
}

FlushExpiredOpts Optional parameters for the method 'FlushExpired'

type FormControllerApiService 

type FormControllerApiService service

FormControllerApiService FormControllerApi service

func (*FormControllerApiService) SubmitForm 

func (a *FormControllerApiService) SubmitForm(ctx _context.Context, localVarOptionals *SubmitFormOpts) (string, *_nethttp.Response, error)

SubmitForm Submit a form to be parsed and sent as an email to an address determined by the form fields This endpoint allows you to submit HTML forms and receive the field values and files via email. #### Parameters The endpoint looks for special meta parameters in the form fields OR in the URL request parameters. The meta parameters can be used to specify the behaviour of the email. You must provide at-least a &#x60;_to&#x60; email address to tell the endpoint where the form should be emailed. These can be submitted as hidden HTML input fields with the corresponding &#x60;name&#x60; attributes or as URL query parameters such as &#x60;?_to&#x3D;test@example.com&#x60; The endpoint takes all other form fields that are named and includes them in the message body of the email. Files are sent as attachments. #### Submitting This endpoint accepts form submission via POST method. It accepts &#x60;application/x-www-form-urlencoded&#x60;, and &#x60;multipart/form-data&#x60; content-types. #### HTML Example &#x60;&#x60;&#x60;html &lt;form action&#x3D;\&quot;https://golang.api.mailslurp.com/forms\&quot; method&#x3D;\&quot;post\&quot; &gt; &lt;input name&#x3D;\&quot;_to\&quot; type&#x3D;\&quot;hidden\&quot; value&#x3D;\&quot;test@example.com\&quot;/&gt; &lt;textarea name&#x3D;\&quot;feedback\&quot;&gt;&lt;/textarea&gt; &lt;button type&#x3D;\&quot;submit\&quot;&gt;Submit&lt;/button&gt; &lt;/form&gt; &#x60;&#x60;&#x60; #### URL Example &#x60;&#x60;&#x60;html &lt;form action&#x3D;\&quot;https://golang.api.mailslurp.com/forms?_to&#x3D;test@example.com\&quot; method&#x3D;\&quot;post\&quot; &gt; &lt;textarea name&#x3D;\&quot;feedback\&quot;&gt;&lt;/textarea&gt; &lt;button type&#x3D;\&quot;submit\&quot;&gt;Submit&lt;/button&gt; &lt;/form&gt; &#x60;&#x60;&#x60; The email address is specified by a &#x60;_to&#x60; field OR is extracted from an email alias specified by a &#x60;_toAlias&#x60; field (see the alias controller for more information). Endpoint accepts . You can specify a content type in HTML forms using the &#x60;enctype&#x60; attribute, for instance: &#x60;&lt;form enctype&#x3D;\&quot;multipart/form-data\&quot;&gt;&#x60;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SubmitFormOpts - Optional Parameters:
  • @param "To" (optional.String) - The email address that submitted form should be sent to.
  • @param "Subject" (optional.String) - Optional subject of the email that will be sent.
  • @param "EmailAddress" (optional.String) - Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later.
  • @param "SuccessMessage" (optional.String) - Optional success message to display if no _redirectTo present.
  • @param "SpamCheck" (optional.String) - Optional but recommended field that catches spammers out. Include as a hidden form field but LEAVE EMPTY. Spam-bots will usually fill every field. If the _spamCheck field is filled the form submission will be ignored.
  • @param "OtherParameters" (optional.String) - All other parameters or fields will be accepted and attached to the sent email. This includes files and any HTML form field with a name. These fields will become the body of the email that is sent.

@return string

type ForwardEmailOptions 

type ForwardEmailOptions struct {
	// To recipients for forwarded email
	To []string `json:"to"`
	// Subject for forwarded email
	Subject *string `json:"subject,omitempty"`
	// Optional cc recipients
	Cc *[]string `json:"cc,omitempty"`
	// Optional bcc recipients
	Bcc *[]string `json:"bcc,omitempty"`
	// Optional from override
	From *string `json:"from,omitempty"`
	// Optionally use inbox name as display name for sender email address
	UseInboxName *bool `json:"useInboxName,omitempty"`
	// Filter recipients to remove any bounced recipients from to, bcc, and cc before sending
	FilterBouncedRecipients *bool `json:"filterBouncedRecipients,omitempty"`
}

ForwardEmailOptions Options for forwarding an email

type GenerateBimiRecordOptions 

type GenerateBimiRecordOptions struct {
	Domain  string `json:"domain"`
	Version string `json:"version"`
	LogoUrl string `json:"logoUrl"`
	VmcUrl  string `json:"vmcUrl,omitempty"`
}

GenerateBimiRecordOptions struct for GenerateBimiRecordOptions

type GenerateBimiRecordResults 

type GenerateBimiRecordResults struct {
	Name string `json:"name"`
	// Domain Name Server Record Types
	Type  string `json:"type"`
	Ttl   int32  `json:"ttl"`
	Value string `json:"value"`
}

GenerateBimiRecordResults struct for GenerateBimiRecordResults

type GenerateDmarcRecordOptions 

type GenerateDmarcRecordOptions struct {
	Domain                string   `json:"domain"`
	Version               string   `json:"version"`
	Policy                string   `json:"policy"`
	SubdomainPolicy       string   `json:"subdomainPolicy,omitempty"`
	ReportEmailAddress    []string `json:"reportEmailAddress,omitempty"`
	ForensicEmailAddress  []string `json:"forensicEmailAddress,omitempty"`
	Percentage            int32    `json:"percentage,omitempty"`
	ReportFormat          string   `json:"reportFormat,omitempty"`
	SecondsBetweenReports int32    `json:"secondsBetweenReports,omitempty"`
	Adkim                 string   `json:"adkim,omitempty"`
	Aspf                  string   `json:"aspf,omitempty"`
	Fo                    string   `json:"fo,omitempty"`
}

GenerateDmarcRecordOptions struct for GenerateDmarcRecordOptions

type GenerateDmarcRecordResults 

type GenerateDmarcRecordResults struct {
	Name string `json:"name"`
	// Domain Name Server Record Types
	Type  string `json:"type"`
	Ttl   int32  `json:"ttl"`
	Value string `json:"value"`
}

GenerateDmarcRecordResults struct for GenerateDmarcRecordResults

type GenerateMtaStsRecordOptions 

type GenerateMtaStsRecordOptions struct {
	Host          string   `json:"host"`
	Version       string   `json:"version"`
	Mode          string   `json:"mode"`
	Ttl           int32    `json:"ttl"`
	MaxAgeSeconds int32    `json:"maxAgeSeconds"`
	MxRecords     []string `json:"mxRecords"`
}

GenerateMtaStsRecordOptions struct for GenerateMtaStsRecordOptions

type GenerateMtaStsRecordResults 

type GenerateMtaStsRecordResults struct {
	Name string `json:"name"`
	// Domain Name Server Record Types
	Type           string `json:"type"`
	Ttl            int32  `json:"ttl"`
	Value          string `json:"value"`
	WellKnownValue string `json:"wellKnownValue"`
	WellKnownUrl   string `json:"wellKnownUrl"`
}

GenerateMtaStsRecordResults struct for GenerateMtaStsRecordResults

type GenerateSpfRecordOptions 

type GenerateSpfRecordOptions struct {
	// Domain the SPF record applies to
	Domain string `json:"domain"`
	// Optional include domains
	IncludeDomains *[]string `json:"includeDomains,omitempty"`
	// Optional IPv4 CIDRs or hosts
	Ip4 *[]string `json:"ip4,omitempty"`
	// Optional IPv6 CIDRs or hosts
	Ip6 *[]string `json:"ip6,omitempty"`
	// Whether to include the MX mechanism
	Mx bool `json:"mx"`
	// Whether to include the A mechanism
	A         bool   `json:"a"`
	AllPolicy string `json:"allPolicy"`
}

GenerateSpfRecordOptions struct for GenerateSpfRecordOptions

type GenerateSpfRecordResults 

type GenerateSpfRecordResults struct {
	Name string `json:"name"`
	// Domain Name Server Record Types
	Type                 string   `json:"type"`
	Ttl                  int32    `json:"ttl"`
	Value                string   `json:"value"`
	EstimatedLookupCount int32    `json:"estimatedLookupCount"`
	Warnings             []string `json:"warnings"`
}

GenerateSpfRecordResults struct for GenerateSpfRecordResults

type GenerateStructuredContentAttachmentOptions 

type GenerateStructuredContentAttachmentOptions struct {
	// Attachment ID to read and pass to AI
	AttachmentId string `json:"attachmentId"`
	// Optional instructions for the AI to follow. Try to be precise and clear. You can include examples and hints.
	Instructions *string                 `json:"instructions,omitempty"`
	OutputSchema *StructuredOutputSchema `json:"outputSchema,omitempty"`
	// ID of transformer to apply
	TransformId *string `json:"transformId,omitempty"`
	// Optional email ID for more context
	EmailId *string `json:"emailId,omitempty"`
}

GenerateStructuredContentAttachmentOptions Options for generating structured content output from an attachment

type GenerateStructuredContentEmailOptions 

type GenerateStructuredContentEmailOptions struct {
	// Email ID to read and pass to AI
	EmailId string `json:"emailId"`
	// Content selector to select part of email to operate on
	ContentSelector *string `json:"contentSelector,omitempty"`
	// Optional instructions for the AI to follow. Try to be precise and clear. You can include examples and hints.
	Instructions *string                 `json:"instructions,omitempty"`
	OutputSchema *StructuredOutputSchema `json:"outputSchema,omitempty"`
	// ID of transformer to apply
	TransformId *string `json:"transformId,omitempty"`
}

GenerateStructuredContentEmailOptions Options for generating structured content output from an email

type GenerateStructuredContentSmsOptions 

type GenerateStructuredContentSmsOptions struct {
	// SMS ID to read and pass to AI
	SmsId string `json:"smsId"`
	// Optional instructions for the AI to follow. Try to be precise and clear. You can include examples and hints.
	Instructions *string                 `json:"instructions,omitempty"`
	OutputSchema *StructuredOutputSchema `json:"outputSchema,omitempty"`
	// ID of transformer to apply
	TransformId *string `json:"transformId,omitempty"`
}

GenerateStructuredContentSmsOptions Options for generating structured content output from an SMS

type GenerateTlsReportingRecordOptions 

type GenerateTlsReportingRecordOptions struct {
	ReportingAddresses []string `json:"reportingAddresses"`
	ReportingUrl       string   `json:"reportingUrl,omitempty"`
	Host               string   `json:"host"`
	Version            string   `json:"version"`
	Ttl                int32    `json:"ttl"`
}

GenerateTlsReportingRecordOptions struct for GenerateTlsReportingRecordOptions

type GenerateTlsReportingRecordResults 

type GenerateTlsReportingRecordResults struct {
	Name string `json:"name"`
	// Domain Name Server Record Types
	Type  string `json:"type"`
	Ttl   int32  `json:"ttl"`
	Value string `json:"value"`
}

GenerateTlsReportingRecordResults struct for GenerateTlsReportingRecordResults

type GenericOpenAPIError 

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

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type GetAliasEmailsOpts 

type GetAliasEmailsOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
}

GetAliasEmailsOpts Optional parameters for the method 'GetAliasEmails'

type GetAliasThreadsOpts 

type GetAliasThreadsOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
}

GetAliasThreadsOpts Optional parameters for the method 'GetAliasThreads'

type GetAliasesOpts 

type GetAliasesOpts struct {
	Search optional.String
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
}

GetAliasesOpts Optional parameters for the method 'GetAliases'

type GetAllAccountWebhooksOpts 

type GetAllAccountWebhooksOpts struct {
	Page         optional.Int32
	Size         optional.Int32
	Sort         optional.String
	Since        optional.Time
	Before       optional.Time
	EventType    optional.String
	Health       optional.String
	SearchFilter optional.String
}

GetAllAccountWebhooksOpts Optional parameters for the method 'GetAllAccountWebhooks'

type GetAllConnectorEventsOpts 

type GetAllConnectorEventsOpts struct {
	Id        optional.Interface
	Page      optional.Int32
	Size      optional.Int32
	Sort      optional.String
	Since     optional.Time
	Before    optional.Time
	EventType optional.String
}

GetAllConnectorEventsOpts Optional parameters for the method 'GetAllConnectorEvents'

type GetAllContactsOpts 

type GetAllContactsOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
	Search optional.String
}

GetAllContactsOpts Optional parameters for the method 'GetAllContacts'

type GetAllGroupsOpts 

type GetAllGroupsOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
}

GetAllGroupsOpts Optional parameters for the method 'GetAllGroups'

type GetAllGuestPortalUsersOpts 

type GetAllGuestPortalUsersOpts struct {
	PortalId optional.Interface
	Search   optional.String
	Page     optional.Int32
	Size     optional.Int32
	Sort     optional.String
	Since    optional.Time
	Before   optional.Time
}

GetAllGuestPortalUsersOpts Optional parameters for the method 'GetAllGuestPortalUsers'

type GetAllInboxForwarderEventsOpts 

type GetAllInboxForwarderEventsOpts struct {
	Page    optional.Int32
	Size    optional.Int32
	InboxId optional.Interface
	EmailId optional.Interface
	SentId  optional.Interface
	Sort    optional.String
}

GetAllInboxForwarderEventsOpts Optional parameters for the method 'GetAllInboxForwarderEvents'

type GetAllInboxReplierEventsOpts 

type GetAllInboxReplierEventsOpts struct {
	InboxReplierId optional.Interface
	InboxId        optional.Interface
	EmailId        optional.Interface
	SentId         optional.Interface
	Page           optional.Int32
	Size           optional.Int32
	Sort           optional.String
}

GetAllInboxReplierEventsOpts Optional parameters for the method 'GetAllInboxReplierEvents'

type GetAllInboxesOffsetPaginatedOpts 

type GetAllInboxesOffsetPaginatedOpts struct {
	Page          optional.Int32
	Size          optional.Int32
	Sort          optional.String
	Favourite     optional.Bool
	Search        optional.String
	Tag           optional.String
	TeamAccess    optional.Bool
	Since         optional.Time
	Before        optional.Time
	InboxType     optional.String
	InboxFunction optional.String
	DomainId      optional.Interface
}

GetAllInboxesOffsetPaginatedOpts Optional parameters for the method 'GetAllInboxesOffsetPaginated'

type GetAllInboxesOpts 

type GetAllInboxesOpts struct {
	Page          optional.Int32
	Size          optional.Int32
	Sort          optional.String
	Favourite     optional.Bool
	Search        optional.String
	Tag           optional.String
	TeamAccess    optional.Bool
	Since         optional.Time
	Before        optional.Time
	InboxType     optional.String
	InboxFunction optional.String
	DomainId      optional.Interface
}

GetAllInboxesOpts Optional parameters for the method 'GetAllInboxes'

type GetAllMissedEmailsOpts 

type GetAllMissedEmailsOpts struct {
	Page         optional.Int32
	Size         optional.Int32
	Sort         optional.String
	SearchFilter optional.String
	Since        optional.Time
	Before       optional.Time
	InboxId      optional.Interface
}

GetAllMissedEmailsOpts Optional parameters for the method 'GetAllMissedEmails'

type GetAllMissedSmsMessagesOpts 

type GetAllMissedSmsMessagesOpts struct {
	PhoneNumber optional.Interface
	Page        optional.Int32
	Size        optional.Int32
	Sort        optional.String
	Since       optional.Time
	Before      optional.Time
	Search      optional.String
}

GetAllMissedSmsMessagesOpts Optional parameters for the method 'GetAllMissedSmsMessages'

type GetAllPhoneMessageThreadsOpts 

type GetAllPhoneMessageThreadsOpts struct {
	Page optional.Int32
	Size optional.Int32
}

GetAllPhoneMessageThreadsOpts Optional parameters for the method 'GetAllPhoneMessageThreads'

type GetAllPhoneNumberReleasesOpts 

type GetAllPhoneNumberReleasesOpts struct {
	Page optional.Int32
	Size optional.Int32
	Sort optional.String
}

GetAllPhoneNumberReleasesOpts Optional parameters for the method 'GetAllPhoneNumberReleases'

type GetAllPlusAddressesOpts 

type GetAllPlusAddressesOpts struct {
	Page    optional.Int32
	Size    optional.Int32
	Sort    optional.String
	InboxId optional.Interface
}

GetAllPlusAddressesOpts Optional parameters for the method 'GetAllPlusAddresses'

type GetAllScheduledJobsOpts 

type GetAllScheduledJobsOpts struct {
	Page    optional.Int32
	Size    optional.Int32
	Sort    optional.String
	Since   optional.Time
	Before  optional.Time
	InboxId optional.Interface
}

GetAllScheduledJobsOpts Optional parameters for the method 'GetAllScheduledJobs'

type GetAllSentTrackingPixelsOpts 

type GetAllSentTrackingPixelsOpts struct {
	Page         optional.Int32
	Size         optional.Int32
	Sort         optional.String
	SearchFilter optional.String
	Since        optional.Time
	Before       optional.Time
}

GetAllSentTrackingPixelsOpts Optional parameters for the method 'GetAllSentTrackingPixels'

type GetAllSmsMessagesOpts 

type GetAllSmsMessagesOpts struct {
	PhoneNumber optional.Interface
	Page        optional.Int32
	Size        optional.Int32
	Sort        optional.String
	Since       optional.Time
	Before      optional.Time
	Search      optional.String
	Favourite   optional.Bool
	Include     optional.Interface
}

GetAllSmsMessagesOpts Optional parameters for the method 'GetAllSmsMessages'

type GetAllTemplatesOpts 

type GetAllTemplatesOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
}

GetAllTemplatesOpts Optional parameters for the method 'GetAllTemplates'

type GetAllTrackingPixelsOpts 

type GetAllTrackingPixelsOpts struct {
	Page         optional.Int32
	Size         optional.Int32
	Sort         optional.String
	SearchFilter optional.String
	Since        optional.Time
	Before       optional.Time
}

GetAllTrackingPixelsOpts Optional parameters for the method 'GetAllTrackingPixels'

type GetAllUnknownMissedEmailsOpts 

type GetAllUnknownMissedEmailsOpts struct {
	Page         optional.Int32
	Size         optional.Int32
	Sort         optional.String
	SearchFilter optional.String
	Since        optional.Time
	Before       optional.Time
	InboxId      optional.Interface
}

GetAllUnknownMissedEmailsOpts Optional parameters for the method 'GetAllUnknownMissedEmails'

type GetAllWebhookEndpointsOpts 

type GetAllWebhookEndpointsOpts struct {
	Page         optional.Int32
	Size         optional.Int32
	Sort         optional.String
	SearchFilter optional.String
	Since        optional.Time
	InboxId      optional.Interface
	PhoneId      optional.Interface
	Before       optional.Time
	Health       optional.String
	EventType    optional.String
}

GetAllWebhookEndpointsOpts Optional parameters for the method 'GetAllWebhookEndpoints'

type GetAllWebhookResultsOpts 

type GetAllWebhookResultsOpts struct {
	Page            optional.Int32
	Size            optional.Int32
	Sort            optional.String
	SearchFilter    optional.String
	Since           optional.Time
	Before          optional.Time
	UnseenOnly      optional.Bool
	ResultType      optional.String
	EventName       optional.String
	MinStatusCode   optional.Int32
	MaxStatusCode   optional.Int32
	InboxId         optional.Interface
	SmsId           optional.Interface
	AttachmentId    optional.Interface
	EmailId         optional.Interface
	PhoneId         optional.Interface
	AiTransformerId optional.Interface
}

GetAllWebhookResultsOpts Optional parameters for the method 'GetAllWebhookResults'

type GetAllWebhooksOpts 

type GetAllWebhooksOpts struct {
	Page               optional.Int32
	Size               optional.Int32
	Sort               optional.String
	SearchFilter       optional.String
	Since              optional.Time
	InboxId            optional.Interface
	AiTransformerId    optional.Interface
	PhoneId            optional.Interface
	Before             optional.Time
	Health             optional.String
	EventType          optional.String
	Url                optional.String
	EventTypeSource    optional.String
	IncludeAccountWide optional.Bool
}

GetAllWebhooksOpts Optional parameters for the method 'GetAllWebhooks'

type GetAttachmentsOpts 

type GetAttachmentsOpts struct {
	Page           optional.Int32
	Size           optional.Int32
	Sort           optional.String
	FileNameFilter optional.String
	Since          optional.Time
	Before         optional.Time
	InboxId        optional.Interface
	EmailId        optional.Interface
	SentEmailId    optional.Interface
	Include        optional.Interface
}

GetAttachmentsOpts Optional parameters for the method 'GetAttachments'

type GetAuditLogByEventIdOpts 

type GetAuditLogByEventIdOpts struct {
	Since  optional.Time
	Before optional.Time
}

GetAuditLogByEventIdOpts Optional parameters for the method 'GetAuditLogByEventId'

type GetAuditLogsOpts 

type GetAuditLogsOpts struct {
	Since        optional.Time
	Before       optional.Time
	Action       optional.String
	UserId       optional.Interface
	ActorUserId  optional.Interface
	TargetUserId optional.Interface
	ResourceType optional.String
	ResourceId   optional.String
	Outcome      optional.String
	RequestId    optional.String
	IpAddress    optional.String
	PageSize     optional.Int32
	Cursor       optional.String
}

GetAuditLogsOpts Optional parameters for the method 'GetAuditLogs'

type GetAvailableDomainRegionsOpts 

type GetAvailableDomainRegionsOpts struct {
	InboxType optional.String
}

GetAvailableDomainRegionsOpts Optional parameters for the method 'GetAvailableDomainRegions'

type GetAvailableDomainsOpts 

type GetAvailableDomainsOpts struct {
	InboxType optional.String
}

GetAvailableDomainsOpts Optional parameters for the method 'GetAvailableDomains'

type GetBouncedEmailsOpts 

type GetBouncedEmailsOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
}

GetBouncedEmailsOpts Optional parameters for the method 'GetBouncedEmails'

type GetBouncedRecipientsOpts 

type GetBouncedRecipientsOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
}

GetBouncedRecipientsOpts Optional parameters for the method 'GetBouncedRecipients'

type GetCampaignProbeInsightsOpts 

type GetCampaignProbeInsightsOpts struct {
	Since  optional.Time
	Before optional.Time
}

GetCampaignProbeInsightsOpts Optional parameters for the method 'GetCampaignProbeInsights'

type GetCampaignProbeRunsOpts 

type GetCampaignProbeRunsOpts struct {
	Since  optional.Time
	Before optional.Time
	Status optional.String
	Limit  optional.Int32
}

GetCampaignProbeRunsOpts Optional parameters for the method 'GetCampaignProbeRuns'

type GetCampaignProbeSeriesOpts 

type GetCampaignProbeSeriesOpts struct {
	Since  optional.Time
	Before optional.Time
	Bucket optional.String
}

GetCampaignProbeSeriesOpts Optional parameters for the method 'GetCampaignProbeSeries'

type GetComplaintsOpts 

type GetComplaintsOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
}

GetComplaintsOpts Optional parameters for the method 'GetComplaints'

type GetConnectorEventsOpts 

type GetConnectorEventsOpts struct {
	Page      optional.Int32
	Size      optional.Int32
	Sort      optional.String
	Since     optional.Time
	Before    optional.Time
	EventType optional.String
}

GetConnectorEventsOpts Optional parameters for the method 'GetConnectorEvents'

type GetConnectorsOpts 

type GetConnectorsOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
}

GetConnectorsOpts Optional parameters for the method 'GetConnectors'

type GetDeliverabilityAnalyticsSeriesOpts 

type GetDeliverabilityAnalyticsSeriesOpts struct {
	Since    optional.Time
	Before   optional.Time
	Scope    optional.String
	Bucket   optional.String
	RunLimit optional.Int32
}

GetDeliverabilityAnalyticsSeriesOpts Optional parameters for the method 'GetDeliverabilityAnalyticsSeries'

type GetDeliverabilityFailureHotspotsOpts 

type GetDeliverabilityFailureHotspotsOpts struct {
	Since  optional.Time
	Before optional.Time
	Scope  optional.String
	Limit  optional.Int32
}

GetDeliverabilityFailureHotspotsOpts Optional parameters for the method 'GetDeliverabilityFailureHotspots'

type GetDeliverabilitySimulationJobEventsOpts 

type GetDeliverabilitySimulationJobEventsOpts struct {
	Page optional.Int32
	Size optional.Int32
	Sort optional.String
}

GetDeliverabilitySimulationJobEventsOpts Optional parameters for the method 'GetDeliverabilitySimulationJobEvents'

type GetDeliverabilityTestResultsOpts 

type GetDeliverabilityTestResultsOpts struct {
	Matched optional.Bool
	Page    optional.Int32
	Size    optional.Int32
	Sort    optional.String
}

GetDeliverabilityTestResultsOpts Optional parameters for the method 'GetDeliverabilityTestResults'

type GetDeliverabilityTestsOpts 

type GetDeliverabilityTestsOpts struct {
	Page optional.Int32
	Size optional.Int32
	Sort optional.String
}

GetDeliverabilityTestsOpts Optional parameters for the method 'GetDeliverabilityTests'

type GetDeliveryStatusesByInboxIdOpts 

type GetDeliveryStatusesByInboxIdOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
}

GetDeliveryStatusesByInboxIdOpts Optional parameters for the method 'GetDeliveryStatusesByInboxId'

type GetDevicePreviewFeedbackItemsOpts 

type GetDevicePreviewFeedbackItemsOpts struct {
	Page     optional.Int32
	Size     optional.Int32
	Source   optional.String
	RunId    optional.Interface
	Status   optional.String
	Provider optional.String
	Category optional.String
	Search   optional.String
}

GetDevicePreviewFeedbackItemsOpts Optional parameters for the method 'GetDevicePreviewFeedbackItems'

type GetDevicePreviewRunsForAccountOpts 

type GetDevicePreviewRunsForAccountOpts struct {
	Limit optional.Int32
}

GetDevicePreviewRunsForAccountOpts Optional parameters for the method 'GetDevicePreviewRunsForAccount'

type GetDevicePreviewRunsOffsetPaginatedOpts 

type GetDevicePreviewRunsOffsetPaginatedOpts struct {
	Page optional.Int32
	Size optional.Int32
	Sort optional.String
}

GetDevicePreviewRunsOffsetPaginatedOpts Optional parameters for the method 'GetDevicePreviewRunsOffsetPaginated'

type GetDevicePreviewRunsOpts 

type GetDevicePreviewRunsOpts struct {
	Limit optional.Int32
}

GetDevicePreviewRunsOpts Optional parameters for the method 'GetDevicePreviewRuns'

type GetDomainMonitorAuthStackOpts 

type GetDomainMonitorAuthStackOpts struct {
	DkimSelector optional.String
}

GetDomainMonitorAuthStackOpts Optional parameters for the method 'GetDomainMonitorAuthStack'

type GetDomainMonitorInsightsOpts 

type GetDomainMonitorInsightsOpts struct {
	Since  optional.Time
	Before optional.Time
}

GetDomainMonitorInsightsOpts Optional parameters for the method 'GetDomainMonitorInsights'

type GetDomainMonitorRunsOpts 

type GetDomainMonitorRunsOpts struct {
	Since  optional.Time
	Before optional.Time
	Status optional.String
	Limit  optional.Int32
}

GetDomainMonitorRunsOpts Optional parameters for the method 'GetDomainMonitorRuns'

type GetDomainMonitorSeriesOpts 

type GetDomainMonitorSeriesOpts struct {
	Since  optional.Time
	Before optional.Time
	Bucket optional.String
}

GetDomainMonitorSeriesOpts Optional parameters for the method 'GetDomainMonitorSeries'

type GetDomainMonitorSummaryOpts 

type GetDomainMonitorSummaryOpts struct {
	DkimSelector optional.String
}

GetDomainMonitorSummaryOpts Optional parameters for the method 'GetDomainMonitorSummary'

type GetDomainOpts 

type GetDomainOpts struct {
	CheckForErrors optional.Bool
}

GetDomainOpts Optional parameters for the method 'GetDomain'

type GetEmailAuditsOpts 

type GetEmailAuditsOpts struct {
	EmailId optional.Interface
	Since   optional.Time
	Before  optional.Time
	Limit   optional.Int32
}

GetEmailAuditsOpts Optional parameters for the method 'GetEmailAudits'

type GetEmailCodesOpts 

type GetEmailCodesOpts struct {
	ExtractCodesOptions optional.Interface
}

GetEmailCodesOpts Optional parameters for the method 'GetEmailCodes'

type GetEmailContentPartContentOpts 

type GetEmailContentPartContentOpts struct {
	Strict optional.Bool
	Index  optional.Int32
}

GetEmailContentPartContentOpts Optional parameters for the method 'GetEmailContentPartContent'

type GetEmailContentPartOpts 

type GetEmailContentPartOpts struct {
	Strict optional.Bool
	Index  optional.Int32
}

GetEmailContentPartOpts Optional parameters for the method 'GetEmailContentPart'

type GetEmailCountOpts 

type GetEmailCountOpts struct {
	InboxId optional.Interface
}

GetEmailCountOpts Optional parameters for the method 'GetEmailCount'

type GetEmailHTMLJsonOpts 

type GetEmailHTMLJsonOpts struct {
	ReplaceCidImages optional.Bool
}

GetEmailHTMLJsonOpts Optional parameters for the method 'GetEmailHTMLJson'

type GetEmailHTMLOpts 

type GetEmailHTMLOpts struct {
	ReplaceCidImages optional.Bool
}

GetEmailHTMLOpts Optional parameters for the method 'GetEmailHTML'

type GetEmailLinksOpts 

type GetEmailLinksOpts struct {
	Selector optional.String
}

GetEmailLinksOpts Optional parameters for the method 'GetEmailLinks'

type GetEmailScreenshotOptions 

type GetEmailScreenshotOptions struct {
	// Window height in pixels
	Height *int32 `json:"height,omitempty"`
	// Window width in pixels
	Width *int32 `json:"width,omitempty"`
}

GetEmailScreenshotOptions Options taking a screenshot capture of a rendered email

type GetEmailSummaryOpts 

type GetEmailSummaryOpts struct {
	Decode optional.Bool
}

GetEmailSummaryOpts Optional parameters for the method 'GetEmailSummary'

type GetEmailTextLinesOpts 

type GetEmailTextLinesOpts struct {
	DecodeHtmlEntities optional.Bool
	LineSeparator      optional.String
}

GetEmailTextLinesOpts Optional parameters for the method 'GetEmailTextLines'

type GetEmailThreadItemsOpts 

type GetEmailThreadItemsOpts struct {
	Sort optional.String
}

GetEmailThreadItemsOpts Optional parameters for the method 'GetEmailThreadItems'

type GetEmailThreadsOpts 

type GetEmailThreadsOpts struct {
	HtmlSelector optional.Interface
	Page         optional.Int32
	Size         optional.Int32
	Sort         optional.String
	SearchFilter optional.String
	Since        optional.Time
	Before       optional.Time
}

GetEmailThreadsOpts Optional parameters for the method 'GetEmailThreads'

type GetEmailsOffsetPaginatedOpts 

type GetEmailsOffsetPaginatedOpts struct {
	InboxId        optional.Interface
	Page           optional.Int32
	Size           optional.Int32
	Sort           optional.String
	UnreadOnly     optional.Bool
	SearchFilter   optional.String
	Since          optional.Time
	Before         optional.Time
	Favourited     optional.Bool
	SyncConnectors optional.Bool
	PlusAddressId  optional.Interface
	Include        optional.Interface
}

GetEmailsOffsetPaginatedOpts Optional parameters for the method 'GetEmailsOffsetPaginated'

type GetEmailsOpts 

type GetEmailsOpts struct {
	Size         optional.Int32
	Limit        optional.Int32
	Sort         optional.String
	RetryTimeout optional.Int64
	DelayTimeout optional.Int64
	MinCount     optional.Int64
	UnreadOnly   optional.Bool
	Before       optional.Time
	Since        optional.Time
}

GetEmailsOpts Optional parameters for the method 'GetEmails'

type GetEmailsPaginatedOpts 

type GetEmailsPaginatedOpts struct {
	InboxId        optional.Interface
	Page           optional.Int32
	Size           optional.Int32
	Sort           optional.String
	UnreadOnly     optional.Bool
	SearchFilter   optional.String
	Since          optional.Time
	Before         optional.Time
	SyncConnectors optional.Bool
	PlusAddressId  optional.Interface
	Favourited     optional.Bool
}

GetEmailsPaginatedOpts Optional parameters for the method 'GetEmailsPaginated'

type GetEntityAutomationsOpts 

type GetEntityAutomationsOpts struct {
	Page    optional.Int32
	Size    optional.Int32
	Sort    optional.String
	Since   optional.Time
	Before  optional.Time
	InboxId optional.Interface
	PhoneId optional.Interface
	Filter  optional.String
}

GetEntityAutomationsOpts Optional parameters for the method 'GetEntityAutomations'

type GetEntityEventsOpts 

type GetEntityEventsOpts struct {
	Page         optional.Int32
	Size         optional.Int32
	Sort         optional.String
	Since        optional.Time
	Before       optional.Time
	InboxId      optional.Interface
	EmailId      optional.Interface
	PhoneId      optional.Interface
	SmsId        optional.Interface
	AttachmentId optional.Interface
	Filter       optional.String
}

GetEntityEventsOpts Optional parameters for the method 'GetEntityEvents'

type GetEntityFavoritesOpts 

type GetEntityFavoritesOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
	Filter optional.String
}

GetEntityFavoritesOpts Optional parameters for the method 'GetEntityFavorites'

type GetExpiredInboxesOpts 

type GetExpiredInboxesOpts struct {
	Page    optional.Int32
	Size    optional.Int32
	Sort    optional.String
	Since   optional.Time
	Before  optional.Time
	InboxId optional.Interface
}

GetExpiredInboxesOpts Optional parameters for the method 'GetExpiredInboxes'

type GetExportLinkOpts 

type GetExportLinkOpts struct {
	ApiKey optional.String
}

GetExportLinkOpts Optional parameters for the method 'GetExportLink'

type GetFakeEmailsForAddressOpts 

type GetFakeEmailsForAddressOpts struct {
	Page optional.Int32
}

GetFakeEmailsForAddressOpts Optional parameters for the method 'GetFakeEmailsForAddress'

type GetGravatarUrlForEmailAddressOpts 

type GetGravatarUrlForEmailAddressOpts struct {
	Size optional.String
}

GetGravatarUrlForEmailAddressOpts Optional parameters for the method 'GetGravatarUrlForEmailAddress'

type GetGroupWithContactsPaginatedOpts 

type GetGroupWithContactsPaginatedOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
}

GetGroupWithContactsPaginatedOpts Optional parameters for the method 'GetGroupWithContactsPaginated'

type GetGuestPortalUsersOpts 

type GetGuestPortalUsersOpts struct {
	Search optional.String
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
}

GetGuestPortalUsersOpts Optional parameters for the method 'GetGuestPortalUsers'

type GetImapAccessOpts 

type GetImapAccessOpts struct {
	InboxId optional.Interface
}

GetImapAccessOpts Optional parameters for the method 'GetImapAccess'

type GetImapSmtpAccessEnvOpts 

type GetImapSmtpAccessEnvOpts struct {
	InboxId optional.Interface
}

GetImapSmtpAccessEnvOpts Optional parameters for the method 'GetImapSmtpAccessEnv'

type GetImapSmtpAccessOpts 

type GetImapSmtpAccessOpts struct {
	InboxId optional.Interface
}

GetImapSmtpAccessOpts Optional parameters for the method 'GetImapSmtpAccess'

type GetInboxEmailsPaginatedOpts 

type GetInboxEmailsPaginatedOpts struct {
	Page           optional.Int32
	Size           optional.Int32
	Sort           optional.String
	Since          optional.Time
	Before         optional.Time
	SyncConnectors optional.Bool
}

GetInboxEmailsPaginatedOpts Optional parameters for the method 'GetInboxEmailsPaginated'

type GetInboxForwarderEventsOpts 

type GetInboxForwarderEventsOpts struct {
	Page optional.Int32
	Size optional.Int32
	Sort optional.String
}

GetInboxForwarderEventsOpts Optional parameters for the method 'GetInboxForwarderEvents'

type GetInboxForwardersOpts 

type GetInboxForwardersOpts struct {
	InboxId      optional.Interface
	Page         optional.Int32
	Size         optional.Int32
	Sort         optional.String
	SearchFilter optional.String
	Since        optional.Time
	Before       optional.Time
}

GetInboxForwardersOpts Optional parameters for the method 'GetInboxForwarders'

type GetInboxPlusAddressByIdOpts 

type GetInboxPlusAddressByIdOpts struct {
	InboxId optional.Interface
}

GetInboxPlusAddressByIdOpts Optional parameters for the method 'GetInboxPlusAddressById'

type GetInboxPlusAddressEmailsForPlusAddressIdOpts 

type GetInboxPlusAddressEmailsForPlusAddressIdOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
}

GetInboxPlusAddressEmailsForPlusAddressIdOpts Optional parameters for the method 'GetInboxPlusAddressEmailsForPlusAddressId'

type GetInboxPlusAddressEmailsOpts 

type GetInboxPlusAddressEmailsOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
}

GetInboxPlusAddressEmailsOpts Optional parameters for the method 'GetInboxPlusAddressEmails'

type GetInboxPlusAddressesOpts 

type GetInboxPlusAddressesOpts struct {
	Page optional.Int32
	Size optional.Int32
	Sort optional.String
}

GetInboxPlusAddressesOpts Optional parameters for the method 'GetInboxPlusAddresses'

type GetInboxReplierEventsOpts 

type GetInboxReplierEventsOpts struct {
	Page optional.Int32
	Size optional.Int32
	Sort optional.String
}

GetInboxReplierEventsOpts Optional parameters for the method 'GetInboxReplierEvents'

type GetInboxRepliersOpts 

type GetInboxRepliersOpts struct {
	InboxId optional.Interface
	Page    optional.Int32
	Size    optional.Int32
	Sort    optional.String
	Since   optional.Time
	Before  optional.Time
}

GetInboxRepliersOpts Optional parameters for the method 'GetInboxRepliers'

type GetInboxSentEmailsOpts 

type GetInboxSentEmailsOpts struct {
	Page         optional.Int32
	Size         optional.Int32
	Sort         optional.String
	SearchFilter optional.String
	Since        optional.Time
	Before       optional.Time
}

GetInboxSentEmailsOpts Optional parameters for the method 'GetInboxSentEmails'

type GetInboxTagsOpts 

type GetInboxTagsOpts struct {
	Page         optional.Int32
	Size         optional.Int32
	Sort         optional.String
	SearchFilter optional.String
}

GetInboxTagsOpts Optional parameters for the method 'GetInboxTags'

type GetInboxTagsPaginatedOpts 

type GetInboxTagsPaginatedOpts struct {
	Page         optional.Int32
	Size         optional.Int32
	Sort         optional.String
	SearchFilter optional.String
}

GetInboxTagsPaginatedOpts Optional parameters for the method 'GetInboxTagsPaginated'

type GetInboxWebhooksPaginatedOpts 

type GetInboxWebhooksPaginatedOpts struct {
	Page               optional.Int32
	Size               optional.Int32
	Sort               optional.String
	SearchFilter       optional.String
	Since              optional.Time
	Before             optional.Time
	Health             optional.String
	EventType          optional.String
	IncludeAccountWide optional.Bool
}

GetInboxWebhooksPaginatedOpts Optional parameters for the method 'GetInboxWebhooksPaginated'

type GetInboxesByTagOpts 

type GetInboxesByTagOpts struct {
	Page         optional.Int32
	Size         optional.Int32
	Sort         optional.String
	SearchFilter optional.String
}

GetInboxesByTagOpts Optional parameters for the method 'GetInboxesByTag'

type GetInboxesOpts 

type GetInboxesOpts struct {
	Size                   optional.Int32
	Sort                   optional.String
	Since                  optional.Time
	ExcludeCatchAllInboxes optional.Bool
	Before                 optional.Time
	Include                optional.Interface
}

GetInboxesOpts Optional parameters for the method 'GetInboxes'

type GetLatestEmailOpts 

type GetLatestEmailOpts struct {
	InboxIds optional.Interface
}

GetLatestEmailOpts Optional parameters for the method 'GetLatestEmail'

type GetListUnsubscribeRecipientsOpts 

type GetListUnsubscribeRecipientsOpts struct {
	Page     optional.Int32
	Size     optional.Int32
	Sort     optional.String
	DomainId optional.Interface
}

GetListUnsubscribeRecipientsOpts Optional parameters for the method 'GetListUnsubscribeRecipients'

type GetMailSlurpDomainsOpts 

type GetMailSlurpDomainsOpts struct {
	InboxType optional.String
}

GetMailSlurpDomainsOpts Optional parameters for the method 'GetMailSlurpDomains'

type GetOptInIdentitiesOpts 

type GetOptInIdentitiesOpts struct {
	Page optional.Int32
	Size optional.Int32
	Sort optional.String
}

GetOptInIdentitiesOpts Optional parameters for the method 'GetOptInIdentities'

type GetOrCreatePhonePoolOptions 

type GetOrCreatePhonePoolOptions struct {
	Name        string `json:"name"`
	Description string `json:"description,omitempty"`
}

GetOrCreatePhonePoolOptions struct for GetOrCreatePhonePoolOptions

type GetOrganizationEmailsPaginatedOpts 

type GetOrganizationEmailsPaginatedOpts struct {
	InboxId        optional.Interface
	Page           optional.Int32
	Size           optional.Int32
	Sort           optional.String
	UnreadOnly     optional.Bool
	SearchFilter   optional.String
	Since          optional.Time
	Before         optional.Time
	SyncConnectors optional.Bool
	Favourited     optional.Bool
	PlusAddressId  optional.Interface
}

GetOrganizationEmailsPaginatedOpts Optional parameters for the method 'GetOrganizationEmailsPaginated'

type GetOrganizationInboxesOpts 

type GetOrganizationInboxesOpts struct {
	Page         optional.Int32
	Size         optional.Int32
	Sort         optional.String
	SearchFilter optional.String
	Since        optional.Time
	Before       optional.Time
}

GetOrganizationInboxesOpts Optional parameters for the method 'GetOrganizationInboxes'

type GetOutboxesOpts 

type GetOutboxesOpts struct {
	Page optional.Int32
	Size optional.Int32
	Sort optional.String
}

GetOutboxesOpts Optional parameters for the method 'GetOutboxes'

type GetPhoneMessageThreadItemsOpts 

type GetPhoneMessageThreadItemsOpts struct {
	Page optional.Int32
	Size optional.Int32
}

GetPhoneMessageThreadItemsOpts Optional parameters for the method 'GetPhoneMessageThreadItems'

type GetPhoneMessageThreadsOpts 

type GetPhoneMessageThreadsOpts struct {
	Page optional.Int32
	Size optional.Int32
}

GetPhoneMessageThreadsOpts Optional parameters for the method 'GetPhoneMessageThreads'

type GetPhoneNumberWebhooksPaginatedOpts 

type GetPhoneNumberWebhooksPaginatedOpts struct {
	Page               optional.Int32
	Size               optional.Int32
	Sort               optional.String
	Since              optional.Time
	Before             optional.Time
	EventType          optional.String
	SearchFilter       optional.String
	Health             optional.String
	IncludeAccountWide optional.Bool
}

GetPhoneNumberWebhooksPaginatedOpts Optional parameters for the method 'GetPhoneNumberWebhooksPaginated'

type GetPhoneNumbersOpts 

type GetPhoneNumbersOpts struct {
	PhoneCountry      optional.String
	LineType          optional.String
	CarrierName       optional.String
	MobileCountryCode optional.String
	MobileNetworkCode optional.String
	ProviderLabel     optional.String
	Page              optional.Int32
	Size              optional.Int32
	Sort              optional.String
	Since             optional.Time
	Before            optional.Time
	Search            optional.String
	Tag               optional.Interface
	Include           optional.Interface
	Favourite         optional.Bool
}

GetPhoneNumbersOpts Optional parameters for the method 'GetPhoneNumbers'

type GetPhoneProvisioningCapabilitiesOpts 

type GetPhoneProvisioningCapabilitiesOpts struct {
	ProviderLabel optional.String
}

GetPhoneProvisioningCapabilitiesOpts Optional parameters for the method 'GetPhoneProvisioningCapabilities'

type GetPhoneTagsOpts 

type GetPhoneTagsOpts struct {
	Search optional.String
}

GetPhoneTagsOpts Optional parameters for the method 'GetPhoneTags'

type GetReputationItemsOpts 

type GetReputationItemsOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
}

GetReputationItemsOpts Optional parameters for the method 'GetReputationItems'

type GetRulesetsOpts 

type GetRulesetsOpts struct {
	InboxId      optional.Interface
	PhoneId      optional.Interface
	Page         optional.Int32
	Size         optional.Int32
	Sort         optional.String
	SearchFilter optional.String
	Since        optional.Time
	Before       optional.Time
}

GetRulesetsOpts Optional parameters for the method 'GetRulesets'

type GetScheduledJobsByInboxIdOpts 

type GetScheduledJobsByInboxIdOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
}

GetScheduledJobsByInboxIdOpts Optional parameters for the method 'GetScheduledJobsByInboxId'

type GetSentDeliveryStatusesBySentIdOpts 

type GetSentDeliveryStatusesBySentIdOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
}

GetSentDeliveryStatusesBySentIdOpts Optional parameters for the method 'GetSentDeliveryStatusesBySentId'

type GetSentDeliveryStatusesOpts 

type GetSentDeliveryStatusesOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
}

GetSentDeliveryStatusesOpts Optional parameters for the method 'GetSentDeliveryStatuses'

type GetSentEmailTrackingPixelsOpts 

type GetSentEmailTrackingPixelsOpts struct {
	Page         optional.Int32
	Size         optional.Int32
	Sort         optional.String
	SearchFilter optional.String
	Since        optional.Time
	Before       optional.Time
}

GetSentEmailTrackingPixelsOpts Optional parameters for the method 'GetSentEmailTrackingPixels'

type GetSentEmailsOpts 

type GetSentEmailsOpts struct {
	InboxId      optional.Interface
	Page         optional.Int32
	Size         optional.Int32
	Sort         optional.String
	SearchFilter optional.String
	Since        optional.Time
	Before       optional.Time
}

GetSentEmailsOpts Optional parameters for the method 'GetSentEmails'

type GetSentEmailsWithQueueResultsOpts 

type GetSentEmailsWithQueueResultsOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
}

GetSentEmailsWithQueueResultsOpts Optional parameters for the method 'GetSentEmailsWithQueueResults'

type GetSentOrganizationEmailsOpts 

type GetSentOrganizationEmailsOpts struct {
	InboxId      optional.Interface
	Page         optional.Int32
	Size         optional.Int32
	Sort         optional.String
	SearchFilter optional.String
	Since        optional.Time
	Before       optional.Time
}

GetSentOrganizationEmailsOpts Optional parameters for the method 'GetSentOrganizationEmails'

type GetSentSmsByPhoneNumberOpts 

type GetSentSmsByPhoneNumberOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
	Search optional.String
}

GetSentSmsByPhoneNumberOpts Optional parameters for the method 'GetSentSmsByPhoneNumber'

type GetSentSmsMessagesPaginatedOpts 

type GetSentSmsMessagesPaginatedOpts struct {
	PhoneNumber optional.Interface
	Page        optional.Int32
	Size        optional.Int32
	Sort        optional.String
	Since       optional.Time
	Before      optional.Time
	Search      optional.String
}

GetSentSmsMessagesPaginatedOpts Optional parameters for the method 'GetSentSmsMessagesPaginated'

type GetSmsByPhoneNumberOpts 

type GetSmsByPhoneNumberOpts struct {
	Page       optional.Int32
	Size       optional.Int32
	Sort       optional.String
	UnreadOnly optional.Bool
	Since      optional.Time
	Before     optional.Time
	Search     optional.String
	Favourite  optional.Bool
}

GetSmsByPhoneNumberOpts Optional parameters for the method 'GetSmsByPhoneNumber'

type GetSmsCodesOpts 

type GetSmsCodesOpts struct {
	ExtractCodesOptions optional.Interface
}

GetSmsCodesOpts Optional parameters for the method 'GetSmsCodes'

type GetSmtpAccessOpts 

type GetSmtpAccessOpts struct {
	InboxId optional.Interface
}

GetSmtpAccessOpts Optional parameters for the method 'GetSmtpAccess'

type GetTenantReputationFindingsOpts 

type GetTenantReputationFindingsOpts struct {
	AccountRegion optional.String
}

GetTenantReputationFindingsOpts Optional parameters for the method 'GetTenantReputationFindings'

type GetTenantReputationStatusSummaryOpts 

type GetTenantReputationStatusSummaryOpts struct {
	AccountRegion optional.String
}

GetTenantReputationStatusSummaryOpts Optional parameters for the method 'GetTenantReputationStatusSummary'

type GetTestWebhookPayloadOpts 

type GetTestWebhookPayloadOpts struct {
	EventName optional.String
}

GetTestWebhookPayloadOpts Optional parameters for the method 'GetTestWebhookPayload'

type GetThreadsPaginatedOpts 

type GetThreadsPaginatedOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
}

GetThreadsPaginatedOpts Optional parameters for the method 'GetThreadsPaginated'

type GetTotpDeviceByOpts 

type GetTotpDeviceByOpts struct {
	Name     optional.String
	Issuer   optional.String
	Username optional.String
}

GetTotpDeviceByOpts Optional parameters for the method 'GetTotpDeviceBy'

type GetTotpDeviceCodeOpts 

type GetTotpDeviceCodeOpts struct {
	At                    optional.Time
	MinSecondsUntilExpire optional.Int32
}

GetTotpDeviceCodeOpts Optional parameters for the method 'GetTotpDeviceCode'

type GetTransformerMappingsOpts 

type GetTransformerMappingsOpts struct {
	AiTransformId optional.Interface
	EntityId      optional.Interface
	EntityType    optional.String
	Page          optional.Int32
	Size          optional.Int32
	Sort          optional.String
}

GetTransformerMappingsOpts Optional parameters for the method 'GetTransformerMappings'

type GetTransformerResultsOpts 

type GetTransformerResultsOpts struct {
	EmailId              optional.Interface
	SmsId                optional.Interface
	AttachmentId         optional.String
	AiTransformId        optional.Interface
	AiTransformMappingId optional.Interface
	EntityId             optional.Interface
	EntityType           optional.String
	Page                 optional.Int32
	Size                 optional.Int32
	Sort                 optional.String
}

GetTransformerResultsOpts Optional parameters for the method 'GetTransformerResults'

type GetTransformerResultsTableOpts 

type GetTransformerResultsTableOpts struct {
	EmailId              optional.Interface
	SmsId                optional.Interface
	AttachmentId         optional.String
	AiTransformId        optional.Interface
	AiTransformMappingId optional.Interface
	EntityId             optional.Interface
	EntityType           optional.String
	Page                 optional.Int32
	Size                 optional.Int32
	Sort                 optional.String
}

GetTransformerResultsTableOpts Optional parameters for the method 'GetTransformerResultsTable'

type GetTransformersOpts 

type GetTransformersOpts struct {
	Page    optional.Int32
	Size    optional.Int32
	Sort    optional.String
	Include optional.Interface
}

GetTransformersOpts Optional parameters for the method 'GetTransformers'

type GetUnreadEmailCountOpts 

type GetUnreadEmailCountOpts struct {
	InboxId optional.Interface
}

GetUnreadEmailCountOpts Optional parameters for the method 'GetUnreadEmailCount'

type GetValidationRequestsOpts 

type GetValidationRequestsOpts struct {
	Page         optional.Int32
	Size         optional.Int32
	Sort         optional.String
	SearchFilter optional.String
	Since        optional.Time
	Before       optional.Time
	IsValid      optional.Bool
}

GetValidationRequestsOpts Optional parameters for the method 'GetValidationRequests'

type GetWebhookResultsOpts 

type GetWebhookResultsOpts struct {
	Page            optional.Int32
	Size            optional.Int32
	Sort            optional.String
	SearchFilter    optional.String
	Since           optional.Time
	Before          optional.Time
	UnseenOnly      optional.Bool
	ResultType      optional.String
	EventName       optional.String
	MinStatusCode   optional.Int32
	MaxStatusCode   optional.Int32
	InboxId         optional.Interface
	SmsId           optional.Interface
	AttachmentId    optional.Interface
	EmailId         optional.Interface
	PhoneId         optional.Interface
	AiTransformerId optional.Interface
}

GetWebhookResultsOpts Optional parameters for the method 'GetWebhookResults'

type GetWebhooksOpts 

type GetWebhooksOpts struct {
	Page optional.Int32
	Size optional.Int32
	Sort optional.String
}

GetWebhooksOpts Optional parameters for the method 'GetWebhooks'

type GravatarUrl 

type GravatarUrl struct {
	Url  string `json:"url"`
	Hash string `json:"hash"`
}

GravatarUrl User image

type GroupContactsDto 

type GroupContactsDto struct {
	Group    GroupDto     `json:"group"`
	Contacts []ContactDto `json:"contacts"`
}

GroupContactsDto Describes contacts attached to a contact group

type GroupControllerApiService 

type GroupControllerApiService service

GroupControllerApiService GroupControllerApi service

func (*GroupControllerApiService) AddContactsToGroup 

func (a *GroupControllerApiService) AddContactsToGroup(ctx _context.Context, groupId string, updateGroupContacts UpdateGroupContacts) (GroupContactsDto, *_nethttp.Response, error)

AddContactsToGroup Add contacts to a group

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param groupId
  • @param updateGroupContacts

@return GroupContactsDto

func (*GroupControllerApiService) CreateGroup 

func (a *GroupControllerApiService) CreateGroup(ctx _context.Context, createGroupOptions CreateGroupOptions) (GroupDto, *_nethttp.Response, error)

CreateGroup Create a group

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createGroupOptions

@return GroupDto

func (*GroupControllerApiService) DeleteGroup 

func (a *GroupControllerApiService) DeleteGroup(ctx _context.Context, groupId string) (*_nethttp.Response, error)

DeleteGroup Delete group

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param groupId

func (*GroupControllerApiService) GetAllGroups 

func (a *GroupControllerApiService) GetAllGroups(ctx _context.Context, localVarOptionals *GetAllGroupsOpts) (PageGroupProjection, *_nethttp.Response, error)

GetAllGroups Get all Contact Groups in paginated format

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAllGroupsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size in list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return PageGroupProjection

func (*GroupControllerApiService) GetGroup 

func (a *GroupControllerApiService) GetGroup(ctx _context.Context, groupId string) (GroupDto, *_nethttp.Response, error)

GetGroup Get group

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param groupId

@return GroupDto

func (*GroupControllerApiService) GetGroupWithContacts 

func (a *GroupControllerApiService) GetGroupWithContacts(ctx _context.Context, groupId string) (GroupContactsDto, *_nethttp.Response, error)

GetGroupWithContacts Get group and contacts belonging to it

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param groupId

@return GroupContactsDto

func (*GroupControllerApiService) GetGroupWithContactsPaginated 

func (a *GroupControllerApiService) GetGroupWithContactsPaginated(ctx _context.Context, groupId string, localVarOptionals *GetGroupWithContactsPaginatedOpts) (PageContactProjection, *_nethttp.Response, error)

GetGroupWithContactsPaginated Method for GetGroupWithContactsPaginated Get group and paginated contacts belonging to it

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param groupId
  • @param optional nil or *GetGroupWithContactsPaginatedOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in group contact pagination
  • @param "Size" (optional.Int32) - Optional page size in group contact pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return PageContactProjection

func (*GroupControllerApiService) GetGroups 

func (a *GroupControllerApiService) GetGroups(ctx _context.Context) ([]GroupProjection, *_nethttp.Response, error)

GetGroups Get all groups

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []GroupProjection

func (*GroupControllerApiService) RemoveContactsFromGroup 

func (a *GroupControllerApiService) RemoveContactsFromGroup(ctx _context.Context, groupId string, updateGroupContacts UpdateGroupContacts) (GroupContactsDto, *_nethttp.Response, error)

RemoveContactsFromGroup Remove contacts from a group

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param groupId
  • @param updateGroupContacts

@return GroupContactsDto

type GroupDto 

type GroupDto struct {
	Id          string    `json:"id"`
	Name        string    `json:"name"`
	Description *string   `json:"description,omitempty"`
	CreatedAt   time.Time `json:"createdAt"`
}

GroupDto Contact group data

type GroupProjection 

type GroupProjection struct {
	Name        string    `json:"name"`
	Id          string    `json:"id"`
	Description *string   `json:"description,omitempty"`
	CreatedAt   time.Time `json:"createdAt"`
}

GroupProjection Data for contact group

type GuestPortalControllerApiService 

type GuestPortalControllerApiService service

GuestPortalControllerApiService GuestPortalControllerApi service

func (*GuestPortalControllerApiService) CreateGuestPortal 

func (a *GuestPortalControllerApiService) CreateGuestPortal(ctx _context.Context, createPortalOptions CreatePortalOptions) (GuestPortalDto, *_nethttp.Response, error)

CreateGuestPortal Create a portal page for your customers or clients to log into email accounts and view emails. Create a guest login page for customers or clients to access assigned email addresses

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createPortalOptions

@return GuestPortalDto

func (*GuestPortalControllerApiService) CreateGuestPortalUser 

func (a *GuestPortalControllerApiService) CreateGuestPortalUser(ctx _context.Context, portalId string, createPortalUserOptions CreatePortalUserOptions) (GuestPortalUserCreateDto, *_nethttp.Response, error)

CreateGuestPortalUser Create a portal guest user Add customer to portal

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param portalId
  • @param createPortalUserOptions

@return GuestPortalUserCreateDto

func (*GuestPortalControllerApiService) GetAllGuestPortalUsers 

func (a *GuestPortalControllerApiService) GetAllGuestPortalUsers(ctx _context.Context, localVarOptionals *GetAllGuestPortalUsersOpts) (PageGuestPortalUsers, *_nethttp.Response, error)

GetAllGuestPortalUsers Get all guest users for portal Get all customers for a portal

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAllGuestPortalUsersOpts - Optional Parameters:
  • @param "PortalId" (optional.Interface of string) - Optional portal ID
  • @param "Search" (optional.String) - Optional search term
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size in list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return PageGuestPortalUsers

func (*GuestPortalControllerApiService) GetGuestPortal 

func (a *GuestPortalControllerApiService) GetGuestPortal(ctx _context.Context, portalId string) (GuestPortalDto, *_nethttp.Response, error)

GetGuestPortal Get a client email portal Fetch a customer guest portal

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param portalId

@return GuestPortalDto

func (*GuestPortalControllerApiService) GetGuestPortalUser 

func (a *GuestPortalControllerApiService) GetGuestPortalUser(ctx _context.Context, portalId string, guestId string) (GuestPortalUserDto, *_nethttp.Response, error)

GetGuestPortalUser Get guest user for portal Get customer for portal

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param portalId
  • @param guestId

@return GuestPortalUserDto

func (*GuestPortalControllerApiService) GetGuestPortalUserById 

func (a *GuestPortalControllerApiService) GetGuestPortalUserById(ctx _context.Context, guestId string) (GuestPortalUserDto, *_nethttp.Response, error)

GetGuestPortalUserById Get guest user Get customer by ID

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param guestId

@return GuestPortalUserDto

func (*GuestPortalControllerApiService) GetGuestPortalUsers 

func (a *GuestPortalControllerApiService) GetGuestPortalUsers(ctx _context.Context, portalId string, localVarOptionals *GetGuestPortalUsersOpts) (PageGuestPortalUsers, *_nethttp.Response, error)

GetGuestPortalUsers Get all guest users for portal Get customers for a portal

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param portalId
  • @param optional nil or *GetGuestPortalUsersOpts - Optional Parameters:
  • @param "Search" (optional.String) - Optional search term
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size in list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return PageGuestPortalUsers

func (*GuestPortalControllerApiService) GetGuestPortals 

func (a *GuestPortalControllerApiService) GetGuestPortals(ctx _context.Context) ([]GuestPortalDto, *_nethttp.Response, error)

GetGuestPortals Get guest portals Get portals

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []GuestPortalDto

type GuestPortalDto 

type GuestPortalDto struct {
	Id          string    `json:"id"`
	DomainId    string    `json:"domainId,omitempty"`
	UserId      string    `json:"userId"`
	Name        string    `json:"name,omitempty"`
	Description string    `json:"description,omitempty"`
	LinkHelp    string    `json:"linkHelp,omitempty"`
	CreatedAt   time.Time `json:"createdAt"`
	UpdatedAt   time.Time `json:"updatedAt"`
	LoginUrl    string    `json:"loginUrl"`
}

GuestPortalDto struct for GuestPortalDto

type GuestPortalUserCreateDto 

type GuestPortalUserCreateDto struct {
	Guest    GuestPortalUserDto `json:"guest"`
	Password string             `json:"password"`
}

GuestPortalUserCreateDto struct for GuestPortalUserCreateDto

type GuestPortalUserDto 

type GuestPortalUserDto struct {
	Id           string    `json:"id"`
	UserId       string    `json:"userId"`
	PortalId     string    `json:"portalId"`
	Name         string    `json:"name,omitempty"`
	Username     string    `json:"username"`
	EmailAddress string    `json:"emailAddress,omitempty"`
	InboxId      string    `json:"inboxId,omitempty"`
	LoginUrl     string    `json:"loginUrl"`
	CreatedAt    time.Time `json:"createdAt"`
	UpdatedAt    time.Time `json:"updatedAt"`
}

GuestPortalUserDto struct for GuestPortalUserDto

type GuestPortalUserProjection 

type GuestPortalUserProjection struct {
	Name         string    `json:"name,omitempty"`
	Id           string    `json:"id"`
	Username     string    `json:"username"`
	UserId       string    `json:"userId"`
	EmailAddress string    `json:"emailAddress,omitempty"`
	InboxId      string    `json:"inboxId,omitempty"`
	UpdatedAt    time.Time `json:"updatedAt"`
	CreatedAt    time.Time `json:"createdAt"`
	PortalId     string    `json:"portalId"`
}

GuestPortalUserProjection Representation of a guest portal user

type HtmlValidationResult 

type HtmlValidationResult struct {
	// Is HTML validation result valid
	IsValid bool `json:"isValid"`
	// Optional infos resulting from HTML validation
	Infos []ValidationMessage `json:"infos"`
	// Optional errors resulting from HTML validation
	Errors []ValidationMessage `json:"errors"`
	// Optional warnings resulting from HTML validation
	Warnings []ValidationMessage `json:"warnings"`
}

HtmlValidationResult HTML Validation Results

type ImageIssue 

type ImageIssue struct {
	Url            string `json:"url"`
	ResponseStatus int32  `json:"responseStatus,omitempty"`
	Severity       string `json:"severity"`
	Message        string `json:"message"`
}

ImageIssue struct for ImageIssue

type ImapAccessDetails 

type ImapAccessDetails struct {
	// Secure TLS IMAP server host domain
	SecureImapServerHost string `json:"secureImapServerHost"`
	// Secure TLS IMAP server host port
	SecureImapServerPort int32 `json:"secureImapServerPort"`
	// Secure TLS IMAP username for login
	SecureImapUsername string `json:"secureImapUsername"`
	// Secure TLS IMAP password for login
	SecureImapPassword string `json:"secureImapPassword"`
	// IMAP server host domain
	ImapServerHost string `json:"imapServerHost"`
	// IMAP server host port
	ImapServerPort int32 `json:"imapServerPort"`
	// IMAP username for login
	ImapUsername string `json:"imapUsername"`
	// IMAP password for login
	ImapPassword string `json:"imapPassword"`
	// IMAP mailbox to SELECT
	ImapMailbox string `json:"imapMailbox"`
}

ImapAccessDetails Access details for inbox using IMAP

type ImapControllerApiService 

type ImapControllerApiService service

ImapControllerApiService ImapControllerApi service

func (*ImapControllerApiService) ImapServerFetch 

func (a *ImapControllerApiService) ImapServerFetch(ctx _context.Context, seqNum int64, localVarOptionals *ImapServerFetchOpts) (ImapServerFetchResult, *_nethttp.Response, error)

ImapServerFetch Fetch message in an inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param seqNum
  • @param optional nil or *ImapServerFetchOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Inbox ID to search

@return ImapServerFetchResult

func (*ImapControllerApiService) ImapServerGet 

func (a *ImapControllerApiService) ImapServerGet(ctx _context.Context, emailId string, localVarOptionals *ImapServerGetOpts) (ImapServerGetResult, *_nethttp.Response, error)

ImapServerGet Get a message by email ID

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId Email ID to get
  • @param optional nil or *ImapServerGetOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Inbox ID to search

@return ImapServerGetResult

func (*ImapControllerApiService) ImapServerList 

func (a *ImapControllerApiService) ImapServerList(ctx _context.Context, imapServerListOptions ImapServerListOptions, localVarOptionals *ImapServerListOpts) (ImapServerListResult, *_nethttp.Response, error)

ImapServerList List messages in an inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param imapServerListOptions
  • @param optional nil or *ImapServerListOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Inbox ID to list

@return ImapServerListResult

func (*ImapControllerApiService) ImapServerMailbox 

func (a *ImapControllerApiService) ImapServerMailbox(ctx _context.Context, name string) (ImapServerMailboxResult, *_nethttp.Response, error)

ImapServerMailbox Create a new mailbox if possible

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name Inbox email address to create

@return ImapServerMailboxResult

func (*ImapControllerApiService) ImapServerSearch 

func (a *ImapControllerApiService) ImapServerSearch(ctx _context.Context, imapServerSearchOptions ImapServerSearchOptions, localVarOptionals *ImapServerSearchOpts) (ImapServerSearchResult, *_nethttp.Response, error)

ImapServerSearch Search messages in an inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param imapServerSearchOptions
  • @param optional nil or *ImapServerSearchOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Inbox ID to search

@return ImapServerSearchResult

func (*ImapControllerApiService) ImapServerStatus 

func (a *ImapControllerApiService) ImapServerStatus(ctx _context.Context, imapServerStatusOptions ImapServerStatusOptions, localVarOptionals *ImapServerStatusOpts) (ImapServerStatusResult, *_nethttp.Response, error)

ImapServerStatus Get status for mailbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param imapServerStatusOptions
  • @param optional nil or *ImapServerStatusOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Inbox ID to list

@return ImapServerStatusResult

func (*ImapControllerApiService) ImapServerUpdateFlags 

func (a *ImapControllerApiService) ImapServerUpdateFlags(ctx _context.Context, imapUpdateFlagsOptions ImapUpdateFlagsOptions, localVarOptionals *ImapServerUpdateFlagsOpts) (*_nethttp.Response, error)

ImapServerUpdateFlags Method for ImapServerUpdateFlags Update message flags

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param imapUpdateFlagsOptions
  • @param optional nil or *ImapServerUpdateFlagsOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) -

type ImapEmailProjection 

type ImapEmailProjection struct {
	Id        string    `json:"id"`
	CreatedAt time.Time `json:"createdAt"`
	Read      *bool     `json:"read,omitempty"`
	Uid       int64     `json:"uid"`
	SeqNum    int64     `json:"seqNum"`
}

ImapEmailProjection struct for ImapEmailProjection

type ImapFlagOperationOptions 

type ImapFlagOperationOptions struct {
	FlagOperation string   `json:"flagOperation"`
	Flags         []string `json:"flags"`
}

ImapFlagOperationOptions IMAP operation flags

type ImapMailboxStatus 

type ImapMailboxStatus struct {
	// The mailbox name.
	Name string `json:"name"`
	// True if the mailbox is open in read-only mode.
	ReadOnly bool `json:"readOnly"`
	// Results map
	Items *map[string]interface{} `json:"items"`
	// The mailbox flags.
	Flags *[]string `json:"flags"`
	// The mailbox permanent flags.
	PermanentFlags *[]string `json:"permanentFlags"`
	// The sequence number of the first unseen message in the mailbox.
	UnseenSeqNum int64 `json:"unseenSeqNum"`
	// The number of messages in this mailbox.
	Messages int32 `json:"messages"`
	// The number of messages not seen since the last time the mailbox was opened.
	Recent int32 `json:"recent"`
	// The number of unread messages.
	Unseen int32 `json:"unseen"`
	// The next UID.
	UidNext int64 `json:"uidNext"`
	// Together with a UID, it is a unique identifier for a message. Must be greater than or equal to 1.
	UidValidity int32 `json:"uidValidity"`
	// Per-mailbox limit of message size. Set only if server supports the APPENDLIMIT extension
	AppendLimit *int32 `json:"appendLimit,omitempty"`
}

ImapMailboxStatus struct for ImapMailboxStatus

type ImapServerFetchItem 

type ImapServerFetchItem struct {
	// Content of the email
	Content string `json:"content"`
	// ID of the email
	Id string `json:"id"`
	// UID of the email
	Uid int64 `json:"uid"`
	// Sequence number of the email
	SeqNum int64 `json:"seqNum"`
	// Read status of the email
	Read bool `json:"read"`
}

ImapServerFetchItem IMAP fetch content in raw format

type ImapServerFetchOpts 

type ImapServerFetchOpts struct {
	InboxId optional.Interface
}

ImapServerFetchOpts Optional parameters for the method 'ImapServerFetch'

type ImapServerFetchResult 

type ImapServerFetchResult struct {
	Result *ImapServerFetchItem `json:"result,omitempty"`
}

ImapServerFetchResult IMAP fetch email result

type ImapServerGetOpts 

type ImapServerGetOpts struct {
	InboxId optional.Interface
}

ImapServerGetOpts Optional parameters for the method 'ImapServerGet'

type ImapServerGetResult 

type ImapServerGetResult struct {
	Result ImapEmailProjection `json:"result,omitempty"`
}

ImapServerGetResult struct for ImapServerGetResult

type ImapServerListOptions 

type ImapServerListOptions struct {
	UidSet *string `json:"uidSet,omitempty"`
	SeqSet *string `json:"seqSet,omitempty"`
}

ImapServerListOptions struct for ImapServerListOptions

type ImapServerListOpts 

type ImapServerListOpts struct {
	InboxId optional.Interface
}

ImapServerListOpts Optional parameters for the method 'ImapServerList'

type ImapServerListResult 

type ImapServerListResult struct {
	Results []ImapEmailProjection `json:"results"`
}

ImapServerListResult struct for ImapServerListResult

type ImapServerMailboxResult 

type ImapServerMailboxResult struct {
	Message *string `json:"message,omitempty"`
	Success bool    `json:"success"`
}

ImapServerMailboxResult struct for ImapServerMailboxResult

type ImapServerSearchOptions 

type ImapServerSearchOptions struct {
	SeqNum       *string              `json:"seqNum,omitempty"`
	Uid          *string              `json:"uid,omitempty"`
	Since        *time.Time           `json:"since,omitempty"`
	Before       *time.Time           `json:"before,omitempty"`
	SentSince    *time.Time           `json:"sentSince,omitempty"`
	SentBefore   *time.Time           `json:"sentBefore,omitempty"`
	Header       *map[string][]string `json:"header,omitempty"`
	Body         *[]string            `json:"body,omitempty"`
	Text         *[]string            `json:"text,omitempty"`
	WithFlags    *[]string            `json:"withFlags,omitempty"`
	WithoutFlags *[]string            `json:"withoutFlags,omitempty"`
}

ImapServerSearchOptions IMAP server search options

type ImapServerSearchOpts 

type ImapServerSearchOpts struct {
	InboxId optional.Interface
}

ImapServerSearchOpts Optional parameters for the method 'ImapServerSearch'

type ImapServerSearchResult 

type ImapServerSearchResult struct {
	Results []ImapEmailProjection `json:"results"`
}

ImapServerSearchResult struct for ImapServerSearchResult

type ImapServerStatusOptions 

type ImapServerStatusOptions struct {
	Name        *string   `json:"name,omitempty"`
	StatusItems *[]string `json:"statusItems,omitempty"`
}

ImapServerStatusOptions struct for ImapServerStatusOptions

type ImapServerStatusOpts 

type ImapServerStatusOpts struct {
	InboxId optional.Interface
}

ImapServerStatusOpts Optional parameters for the method 'ImapServerStatus'

type ImapServerStatusResult 

type ImapServerStatusResult struct {
	Result *ImapMailboxStatus `json:"result,omitempty"`
}

ImapServerStatusResult struct for ImapServerStatusResult

type ImapServerUpdateFlagsOpts 

type ImapServerUpdateFlagsOpts struct {
	InboxId optional.Interface
}

ImapServerUpdateFlagsOpts Optional parameters for the method 'ImapServerUpdateFlags'

type ImapSmtpAccessDetails 

type ImapSmtpAccessDetails struct {
	// Email address for SMTP/IMAP login
	EmailAddress string `json:"emailAddress"`
	// Secure TLS SMTP server host domain
	SecureSmtpServerHost string `json:"secureSmtpServerHost"`
	// Secure TLS SMTP server host port
	SecureSmtpServerPort int32 `json:"secureSmtpServerPort"`
	// Secure TLS SMTP username for login
	SecureSmtpUsername string `json:"secureSmtpUsername"`
	// Secure TLS SMTP password for login
	SecureSmtpPassword string `json:"secureSmtpPassword"`
	// SMTP server host domain
	SmtpServerHost string `json:"smtpServerHost"`
	// SMTP server host port
	SmtpServerPort int32 `json:"smtpServerPort"`
	// SMTP username for login
	SmtpUsername string `json:"smtpUsername"`
	// SMTP password for login
	SmtpPassword string `json:"smtpPassword"`
	// Secure TLS IMAP server host domain
	SecureImapServerHost string `json:"secureImapServerHost"`
	// Secure TLS IMAP server host port
	SecureImapServerPort int32 `json:"secureImapServerPort"`
	// Secure TLS IMAP username for login
	SecureImapUsername string `json:"secureImapUsername"`
	// Secure TLS IMAP password for login
	SecureImapPassword string `json:"secureImapPassword"`
	// IMAP server host domain
	ImapServerHost string `json:"imapServerHost"`
	// IMAP server host port
	ImapServerPort int32 `json:"imapServerPort"`
	// IMAP username for login
	ImapUsername string `json:"imapUsername"`
	// IMAP password for login
	ImapPassword string `json:"imapPassword"`
	// IMAP mailbox to SELECT
	ImapMailbox string `json:"imapMailbox"`
	// Mail from domain or SMTP HELO value
	MailFromDomain *string `json:"mailFromDomain,omitempty"`
}

ImapSmtpAccessDetails Access details for inbox using SMTP or IMAP

type ImapSmtpAccessServers 

type ImapSmtpAccessServers struct {
	ImapServer       ServerEndpoints `json:"imapServer"`
	SecureImapServer ServerEndpoints `json:"secureImapServer"`
	SmtpServer       ServerEndpoints `json:"smtpServer"`
	SecureSmtpServer ServerEndpoints `json:"secureSmtpServer"`
}

ImapSmtpAccessServers IMAP and SMTP server endpoints for MailSlurp

type ImapUpdateFlagsOptions 

type ImapUpdateFlagsOptions struct {
	Operation string    `json:"operation"`
	Flags     *[]string `json:"flags,omitempty"`
	UidSet    *string   `json:"uidSet,omitempty"`
	SeqSet    *string   `json:"seqSet,omitempty"`
}

ImapUpdateFlagsOptions struct for ImapUpdateFlagsOptions

type ImportEmailIntoInboxBytesOpts 

type ImportEmailIntoInboxBytesOpts struct {
	ExternalId        optional.String
	RunPipeline       optional.Bool
	OverrideMessageId optional.Bool
}

ImportEmailIntoInboxBytesOpts Optional parameters for the method 'ImportEmailIntoInboxBytes'

type ImportEmailIntoInboxMultipartOpts 

type ImportEmailIntoInboxMultipartOpts struct {
	ExternalId        optional.String
	RunPipeline       optional.Bool
	OverrideMessageId optional.Bool
}

ImportEmailIntoInboxMultipartOpts Optional parameters for the method 'ImportEmailIntoInboxMultipart'

type ImportEmailOptions 

type ImportEmailOptions struct {
	// Base64 encoded RFC822/MIME email contents. This should be the full raw email including headers and body, such as the bytes from an `.eml` file.
	RawEmailBase64 string `json:"rawEmailBase64"`
	// Optional external identifier for the imported email source. Useful for correlating imports back to another system.
	ExternalId *string `json:"externalId,omitempty"`
	// When true the normal inbound receive pipeline runs after persistence, including automations, webhooks, transformers, forwarders, repliers, and related fanout. When false the email is stored only.
	RunPipeline *bool `json:"runPipeline,omitempty"`
	// When true MailSlurp rewrites the MIME `Message-ID` header before storing and parsing the email so imported messages do not collide with existing message identities.
	OverrideMessageId *bool `json:"overrideMessageId,omitempty"`
}

ImportEmailOptions Options for importing a raw RFC822/MIME email into a specific inbox. V1 supports MIME-family formats such as `.eml`, `message/rfc822`, and raw MIME bytes. Outlook `.msg`, `mbox`, and `maildir` are not supported in V1.

type InboxAutomationMatchOption 

type InboxAutomationMatchOption struct {
	// Supported fields for inbox forwarder and replier automation matching.
	Field string `json:"field"`
	// Comparison mode for inbox automation matching.
	Should string `json:"should"`
	// Pattern or value to compare against the selected field.
	Value string `json:"value"`
}

InboxAutomationMatchOption Single inbox automation match rule.

type InboxAutomationMatchOptions 

type InboxAutomationMatchOptions struct {
	// Boolean operator used to combine inbox automation match rules.
	Operator string `json:"operator"`
	// Leaf match rules in this group.
	Matches *[]InboxAutomationMatchOption `json:"matches,omitempty"`
	// Nested child groups.
	Groups *[]InboxAutomationMatchOptions `json:"groups,omitempty"`
}

InboxAutomationMatchOptions Nested AND/OR match tree for inbox forwarders and repliers.

type InboxByEmailAddressResult 

type InboxByEmailAddressResult struct {
	InboxId *string `json:"inboxId,omitempty"`
	Exists  bool    `json:"exists"`
}

InboxByEmailAddressResult Result of search for inbox by email address

type InboxByNameResult 

type InboxByNameResult struct {
	InboxId *string `json:"inboxId,omitempty"`
	Exists  bool    `json:"exists"`
}

InboxByNameResult Result of search for inbox by name

type InboxControllerApiService 

type InboxControllerApiService service

InboxControllerApiService InboxControllerApi service

func (*InboxControllerApiService) CancelScheduledJob 

func (a *InboxControllerApiService) CancelScheduledJob(ctx _context.Context, jobId string) (ScheduledJobDto, *_nethttp.Response, error)

CancelScheduledJob Cancel a scheduled email job Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param jobId

@return ScheduledJobDto

func (*InboxControllerApiService) CreateInbox 

func (a *InboxControllerApiService) CreateInbox(ctx _context.Context, localVarOptionals *CreateInboxOpts) (InboxDto, *_nethttp.Response, error)

CreateInbox Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes. Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *CreateInboxOpts - Optional Parameters:
  • @param "EmailAddress" (optional.String) - A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
  • @param "Tags" (optional.Interface of []string) - Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
  • @param "Name" (optional.String) - Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails.
  • @param "Description" (optional.String) - Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
  • @param "UseDomainPool" (optional.Bool) - Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types.
  • @param "Favourite" (optional.Bool) - Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering
  • @param "ExpiresAt" (optional.Time) - Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
  • @param "ExpiresIn" (optional.Int64) - Number of milliseconds that inbox should exist for
  • @param "AllowTeamAccess" (optional.Bool) - DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization.
  • @param "InboxType" (optional.String) - HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mxslurp.click`.
  • @param "VirtualInbox" (optional.Bool) - Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending.
  • @param "UseShortAddress" (optional.Bool) - Use a shorter email address under 31 characters
  • @param "DomainId" (optional.Interface of string) - ID of custom domain to use for email address.
  • @param "DomainName" (optional.String) - FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox.
  • @param "Prefix" (optional.String) - Prefix to add before the email address for easier labelling or identification.

@return InboxDto

func (*InboxControllerApiService) CreateInboxRuleset 

func (a *InboxControllerApiService) CreateInboxRuleset(ctx _context.Context, inboxId string, createRulesetOptions CreateRulesetOptions) (RulesetDto, *_nethttp.Response, error)

CreateInboxRuleset Create an inbox ruleset Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId inboxId
  • @param createRulesetOptions

@return RulesetDto

func (*InboxControllerApiService) CreateInboxWithDefaults 

func (a *InboxControllerApiService) CreateInboxWithDefaults(ctx _context.Context) (InboxDto, *_nethttp.Response, error)

CreateInboxWithDefaults Create an inbox with default options. Uses MailSlurp domain pool address and is private.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return InboxDto

func (*InboxControllerApiService) CreateInboxWithOptions 

func (a *InboxControllerApiService) CreateInboxWithOptions(ctx _context.Context, createInboxDto CreateInboxDto) (InboxDto, *_nethttp.Response, error)

CreateInboxWithOptions Create an inbox with options. Extended options for inbox creation. Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createInboxDto

@return InboxDto

func (*InboxControllerApiService) DeleteAllInboxEmails 

func (a *InboxControllerApiService) DeleteAllInboxEmails(ctx _context.Context, inboxId string) (*_nethttp.Response, error)

DeleteAllInboxEmails Delete all emails in a given inboxes. Deletes all emails in an inbox. Be careful as emails cannot be recovered

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId

func (*InboxControllerApiService) DeleteAllInboxes 

func (a *InboxControllerApiService) DeleteAllInboxes(ctx _context.Context) (*_nethttp.Response, error)

DeleteAllInboxes Delete all inboxes Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*InboxControllerApiService) DeleteAllInboxesByDescription 

func (a *InboxControllerApiService) DeleteAllInboxesByDescription(ctx _context.Context, description string) (*_nethttp.Response, error)

DeleteAllInboxesByDescription Delete inboxes by description Permanently delete all inboxes by description

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param description

func (*InboxControllerApiService) DeleteAllInboxesByName 

func (a *InboxControllerApiService) DeleteAllInboxesByName(ctx _context.Context, name string) (*_nethttp.Response, error)

DeleteAllInboxesByName Delete inboxes by name Permanently delete all inboxes by name

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name

func (*InboxControllerApiService) DeleteAllInboxesByTag 

func (a *InboxControllerApiService) DeleteAllInboxesByTag(ctx _context.Context, tag string) (*_nethttp.Response, error)

DeleteAllInboxesByTag Delete inboxes by tag Permanently delete all inboxes by tag

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tag

func (*InboxControllerApiService) DeleteInbox 

func (a *InboxControllerApiService) DeleteInbox(ctx _context.Context, inboxId string) (*_nethttp.Response, error)

DeleteInbox Delete inbox Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId

func (*InboxControllerApiService) DoesInboxExist 

func (a *InboxControllerApiService) DoesInboxExist(ctx _context.Context, emailAddress string, localVarOptionals *DoesInboxExistOpts) (InboxExistsDto, *_nethttp.Response, error)

DoesInboxExist Does inbox exist Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailAddress Email address
  • @param optional nil or *DoesInboxExistOpts - Optional Parameters:
  • @param "AllowCatchAll" (optional.Bool) - Allow catch all
  • @param "IpAddress" (optional.String) - IP address
  • @param "Sender" (optional.String) - Sender

@return InboxExistsDto

func (*InboxControllerApiService) DoesInboxHaveAutomations 

func (a *InboxControllerApiService) DoesInboxHaveAutomations(ctx _context.Context) (*_nethttp.Response, error)

DoesInboxHaveAutomations Does inbox have automations Check if an inbox has automations.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*InboxControllerApiService) FlushExpired 

func (a *InboxControllerApiService) FlushExpired(ctx _context.Context, localVarOptionals *FlushExpiredOpts) (FlushExpiredInboxesResult, *_nethttp.Response, error)

FlushExpired Remove expired inboxes Remove any expired inboxes for your account (instead of waiting for scheduled removal on server)

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *FlushExpiredOpts - Optional Parameters:
  • @param "Before" (optional.Time) - Optional expired at before flag to flush expired inboxes that have expired before the given time

@return FlushExpiredInboxesResult

func (*InboxControllerApiService) GetAllInboxes 

func (a *InboxControllerApiService) GetAllInboxes(ctx _context.Context, localVarOptionals *GetAllInboxesOpts) (PageInboxProjection, *_nethttp.Response, error)

GetAllInboxes List All Inboxes Paginated List inboxes in paginated form. The results are available on the &#x60;content&#x60; property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative &#x60;getInboxes&#x60; method returns a full list of inboxes but is limited to 100 results.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAllInboxesOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size in list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Favourite" (optional.Bool) - Optionally filter results for favourites only
  • @param "Search" (optional.String) - Optionally filter by search words partial matching name and email address
  • @param "Tag" (optional.String) - Optionally filter by tags. Will return inboxes that include given tags
  • @param "TeamAccess" (optional.Bool) - DEPRECATED. Optionally filter by team access.
  • @param "Since" (optional.Time) - Optional filter by created after given date time
  • @param "Before" (optional.Time) - Optional filter by created before given date time
  • @param "InboxType" (optional.String) - Optional filter by inbox type
  • @param "InboxFunction" (optional.String) - Optional filter by inbox function
  • @param "DomainId" (optional.Interface of string) - Optional domain ID filter

@return PageInboxProjection

func (*InboxControllerApiService) GetAllInboxesOffsetPaginated 

func (a *InboxControllerApiService) GetAllInboxesOffsetPaginated(ctx _context.Context, localVarOptionals *GetAllInboxesOffsetPaginatedOpts) (PageInboxProjection, *_nethttp.Response, error)

GetAllInboxesOffsetPaginated List All Inboxes Offset Paginated List inboxes in paginated form. The results are available on the &#x60;content&#x60; property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative &#x60;getInboxes&#x60; method returns a full list of inboxes but is limited to 100 results.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAllInboxesOffsetPaginatedOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size in list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Favourite" (optional.Bool) - Optionally filter results for favourites only
  • @param "Search" (optional.String) - Optionally filter by search words partial matching name and email address
  • @param "Tag" (optional.String) - Optionally filter by tags. Will return inboxes that include given tags
  • @param "TeamAccess" (optional.Bool) - DEPRECATED. Optionally filter by team access.
  • @param "Since" (optional.Time) - Optional filter by created after given date time
  • @param "Before" (optional.Time) - Optional filter by created before given date time
  • @param "InboxType" (optional.String) - Optional filter by inbox type
  • @param "InboxFunction" (optional.String) - Optional filter by inbox function
  • @param "DomainId" (optional.Interface of string) - Optional domain ID filter

@return PageInboxProjection

func (*InboxControllerApiService) GetAllPlusAddresses 

func (a *InboxControllerApiService) GetAllPlusAddresses(ctx _context.Context, localVarOptionals *GetAllPlusAddressesOpts) (PagePlusAddressProjection, *_nethttp.Response, error)

GetAllPlusAddresses Get all sub address plus address aliases for an inbox Returns paginated list of all plus alias addresses found for in account based on received emails that used the inbox address with a +xyz alias.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAllPlusAddressesOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in inbox tracking pixel list pagination
  • @param "Size" (optional.Int32) - Optional page size in inbox tracking pixel list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "InboxId" (optional.Interface of string) - Optional inboxId filter

@return PagePlusAddressProjection

func (*InboxControllerApiService) GetAllScheduledJobs 

func (a *InboxControllerApiService) GetAllScheduledJobs(ctx _context.Context, localVarOptionals *GetAllScheduledJobsOpts) (PageScheduledJobs, *_nethttp.Response, error)

GetAllScheduledJobs Get all scheduled email sending jobs for account Schedule sending of emails using scheduled jobs. These can be inbox or account level.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAllScheduledJobsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in scheduled job list pagination
  • @param "Size" (optional.Int32) - Optional page size in scheduled job list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp
  • @param "InboxId" (optional.Interface of string) -

@return PageScheduledJobs

func (*InboxControllerApiService) GetDeliveryStatusesByInboxId 

func (a *InboxControllerApiService) GetDeliveryStatusesByInboxId(ctx _context.Context, inboxId string, localVarOptionals *GetDeliveryStatusesByInboxIdOpts) (PageDeliveryStatus, *_nethttp.Response, error)

GetDeliveryStatusesByInboxId Method for GetDeliveryStatusesByInboxId Get all email delivery statuses for an inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId
  • @param optional nil or *GetDeliveryStatusesByInboxIdOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in delivery status list pagination
  • @param "Size" (optional.Int32) - Optional page size in delivery status list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return PageDeliveryStatus

func (*InboxControllerApiService) GetEmails 

func (a *InboxControllerApiService) GetEmails(ctx _context.Context, inboxId string, localVarOptionals *GetEmailsOpts) ([]EmailPreview, *_nethttp.Response, error)

GetEmails Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead. List emails that an inbox has received. Only emails that are sent to the inbox&#39;s email address will appear in the inbox. It may take several seconds for any email you send to an inbox&#39;s email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the &#x60;minCount&#x60; parameter. The server will retry the inbox database until the &#x60;minCount&#x60; is satisfied or the &#x60;retryTimeout&#x60; is reached

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId Id of inbox that emails belongs to
  • @param optional nil or *GetEmailsOpts - Optional Parameters:
  • @param "Size" (optional.Int32) - Alias for limit. Assessed first before assessing any passed limit.
  • @param "Limit" (optional.Int32) - Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller
  • @param "Sort" (optional.String) - Sort the results by received date and direction ASC or DESC
  • @param "RetryTimeout" (optional.Int64) - Maximum milliseconds to spend retrying inbox database until minCount emails are returned
  • @param "DelayTimeout" (optional.Int64) -
  • @param "MinCount" (optional.Int64) - Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
  • @param "UnreadOnly" (optional.Bool) -
  • @param "Before" (optional.Time) - Exclude emails received after this ISO 8601 date time
  • @param "Since" (optional.Time) - Exclude emails received before this ISO 8601 date time

@return []EmailPreview

func (*InboxControllerApiService) GetImapAccess 

func (a *InboxControllerApiService) GetImapAccess(ctx _context.Context, localVarOptionals *GetImapAccessOpts) (ImapAccessDetails, *_nethttp.Response, error)

GetImapAccess Method for GetImapAccess Get IMAP access usernames and passwords

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetImapAccessOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Inbox ID

@return ImapAccessDetails

func (*InboxControllerApiService) GetImapSmtpAccess 

func (a *InboxControllerApiService) GetImapSmtpAccess(ctx _context.Context, localVarOptionals *GetImapSmtpAccessOpts) (ImapSmtpAccessDetails, *_nethttp.Response, error)

GetImapSmtpAccess Method for GetImapSmtpAccess Get IMAP and SMTP access usernames and passwords

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetImapSmtpAccessOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Inbox ID

@return ImapSmtpAccessDetails

func (*InboxControllerApiService) GetImapSmtpAccessEnv 

func (a *InboxControllerApiService) GetImapSmtpAccessEnv(ctx _context.Context, localVarOptionals *GetImapSmtpAccessEnvOpts) (string, *_nethttp.Response, error)

GetImapSmtpAccessEnv Method for GetImapSmtpAccessEnv Get IMAP and SMTP access details in .env format

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetImapSmtpAccessEnvOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Inbox ID

@return string

func (*InboxControllerApiService) GetImapSmtpAccessServers 

func (a *InboxControllerApiService) GetImapSmtpAccessServers(ctx _context.Context) (ImapSmtpAccessServers, *_nethttp.Response, error)

GetImapSmtpAccessServers Method for GetImapSmtpAccessServers Get IMAP and SMTP server hosts

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ImapSmtpAccessServers

func (*InboxControllerApiService) GetInbox 

func (a *InboxControllerApiService) GetInbox(ctx _context.Context, inboxId string) (InboxDto, *_nethttp.Response, error)

GetInbox Get Inbox. Returns properties of an inbox. Returns an inbox&#39;s properties, including its email address and ID.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId

@return InboxDto

func (*InboxControllerApiService) GetInboxByEmailAddress 

func (a *InboxControllerApiService) GetInboxByEmailAddress(ctx _context.Context, emailAddress string) (InboxByEmailAddressResult, *_nethttp.Response, error)

GetInboxByEmailAddress Search for an inbox with the provided email address Get a inbox result by email address

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailAddress

@return InboxByEmailAddressResult

func (*InboxControllerApiService) GetInboxByName 

func (a *InboxControllerApiService) GetInboxByName(ctx _context.Context, name string) (InboxByNameResult, *_nethttp.Response, error)

GetInboxByName Search for an inbox with the given name Get a inbox result by name

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name

@return InboxByNameResult

func (*InboxControllerApiService) GetInboxCount 

func (a *InboxControllerApiService) GetInboxCount(ctx _context.Context) (CountDto, *_nethttp.Response, error)

GetInboxCount Get total inbox count

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return CountDto

func (*InboxControllerApiService) GetInboxEmailCount 

func (a *InboxControllerApiService) GetInboxEmailCount(ctx _context.Context, inboxId string) (CountDto, *_nethttp.Response, error)

GetInboxEmailCount Get email count in inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId Id of inbox that emails belongs to

@return CountDto

func (*InboxControllerApiService) GetInboxEmailsPaginated 

func (a *InboxControllerApiService) GetInboxEmailsPaginated(ctx _context.Context, inboxId string, localVarOptionals *GetInboxEmailsPaginatedOpts) (PageEmailPreview, *_nethttp.Response, error)

GetInboxEmailsPaginated Get inbox emails paginated Get a paginated list of emails in an inbox. Does not hold connections open.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId Id of inbox that emails belongs to
  • @param optional nil or *GetInboxEmailsPaginatedOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in inbox emails list pagination
  • @param "Size" (optional.Int32) - Optional page size in inbox emails list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Optional filter by received after given date time
  • @param "Before" (optional.Time) - Optional filter by received before given date time
  • @param "SyncConnectors" (optional.Bool) - Sync connectors before fetching emails

@return PageEmailPreview

func (*InboxControllerApiService) GetInboxIds 

func (a *InboxControllerApiService) GetInboxIds(ctx _context.Context) (InboxIdsResult, *_nethttp.Response, error)

GetInboxIds Get all inbox IDs Get list of inbox IDs

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return InboxIdsResult

func (*InboxControllerApiService) GetInboxPlusAddress 

func (a *InboxControllerApiService) GetInboxPlusAddress(ctx _context.Context, plusAddressId string, inboxId string) (PlusAddressDto, *_nethttp.Response, error)

GetInboxPlusAddress Get sub address plus address for an inbox Returns a plus address object based on emails that used the inbox address with a +xyz alias.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param plusAddressId ID of the plus address you want to fetch
  • @param inboxId ID of the inbox you want to fetch

@return PlusAddressDto

func (*InboxControllerApiService) GetInboxPlusAddressById 

func (a *InboxControllerApiService) GetInboxPlusAddressById(ctx _context.Context, plusAddressId string, localVarOptionals *GetInboxPlusAddressByIdOpts) (PlusAddressDto, *_nethttp.Response, error)

GetInboxPlusAddressById Get sub address plus address by ID Returns a plus address object based on emails that used the inbox address with a +xyz alias.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param plusAddressId ID of the plus address you want to fetch
  • @param optional nil or *GetInboxPlusAddressByIdOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - ID of the inbox you want to filter for

@return PlusAddressDto

func (*InboxControllerApiService) GetInboxPlusAddressEmails 

func (a *InboxControllerApiService) GetInboxPlusAddressEmails(ctx _context.Context, plusAddress string, inboxId string, localVarOptionals *GetInboxPlusAddressEmailsOpts) (PageEmailPreview, *_nethttp.Response, error)

GetInboxPlusAddressEmails Get emails for a given inbox plus address Returns paginated list of all emails for a given plus alias addresses found for an inbox based on received emails that used the inbox address with a +xyz alias.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param plusAddress The plus address to fetch emails for. If your inbox address is `123@test.com` and the email was sent to `123+abc@test.com` then the plus address is `abc`
  • @param inboxId ID of the inbox you want to send the email from
  • @param optional nil or *GetInboxPlusAddressEmailsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in inbox tracking pixel list pagination
  • @param "Size" (optional.Int32) - Optional page size in inbox tracking pixel list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Optional filter by created after given date time
  • @param "Before" (optional.Time) - Optional filter by created before given date time

@return PageEmailPreview

func (*InboxControllerApiService) GetInboxPlusAddressEmailsForPlusAddressId 

func (a *InboxControllerApiService) GetInboxPlusAddressEmailsForPlusAddressId(ctx _context.Context, plusAddressId string, inboxId string, localVarOptionals *GetInboxPlusAddressEmailsForPlusAddressIdOpts) (PageEmailPreview, *_nethttp.Response, error)

GetInboxPlusAddressEmailsForPlusAddressId Get emails for a given inbox plus address Returns paginated list of all emails for a given plus alias addresses found for an inbox based on received emails that used the inbox address with a +xyz alias.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param plusAddressId The plus address ID to fetch emails for.
  • @param inboxId ID of the inbox you want to send the email from
  • @param optional nil or *GetInboxPlusAddressEmailsForPlusAddressIdOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in inbox tracking pixel list pagination
  • @param "Size" (optional.Int32) - Optional page size in inbox tracking pixel list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Optional filter by created after given date time
  • @param "Before" (optional.Time) - Optional filter by created before given date time

@return PageEmailPreview

func (*InboxControllerApiService) GetInboxPlusAddresses 

func (a *InboxControllerApiService) GetInboxPlusAddresses(ctx _context.Context, inboxId string, localVarOptionals *GetInboxPlusAddressesOpts) (PagePlusAddressProjection, *_nethttp.Response, error)

GetInboxPlusAddresses Get sub address plus address aliases for an inbox Returns paginated list of all plus alias addresses found for an inbox based on received emails that used the inbox address with a +xyz alias.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId ID of the inbox you want to send the email from
  • @param optional nil or *GetInboxPlusAddressesOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in inbox tracking pixel list pagination
  • @param "Size" (optional.Int32) - Optional page size in inbox tracking pixel list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC

@return PagePlusAddressProjection

func (*InboxControllerApiService) GetInboxSentCount 

func (a *InboxControllerApiService) GetInboxSentCount(ctx _context.Context, inboxId string) (CountDto, *_nethttp.Response, error)

GetInboxSentCount Get sent email count in inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId Id of inbox that emails were sent from

@return CountDto

func (*InboxControllerApiService) GetInboxSentEmails 

func (a *InboxControllerApiService) GetInboxSentEmails(ctx _context.Context, inboxId string, localVarOptionals *GetInboxSentEmailsOpts) (PageSentEmailProjection, *_nethttp.Response, error)

GetInboxSentEmails Get Inbox Sent Emails Returns an inbox&#39;s sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId
  • @param optional nil or *GetInboxSentEmailsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in inbox sent email list pagination
  • @param "Size" (optional.Int32) - Optional page size in inbox sent email list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "SearchFilter" (optional.String) - Optional sent email search
  • @param "Since" (optional.Time) - Optional filter by sent after given date time
  • @param "Before" (optional.Time) - Optional filter by sent before given date time

@return PageSentEmailProjection

func (*InboxControllerApiService) GetInboxTags 

func (a *InboxControllerApiService) GetInboxTags(ctx _context.Context, localVarOptionals *GetInboxTagsOpts) ([]string, *_nethttp.Response, error)

GetInboxTags Get inbox tags Get all inbox tags

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetInboxTagsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size in list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "SearchFilter" (optional.String) - Optional search filter

@return []string

func (*InboxControllerApiService) GetInboxTagsPaginated 

func (a *InboxControllerApiService) GetInboxTagsPaginated(ctx _context.Context, localVarOptionals *GetInboxTagsPaginatedOpts) (PageInboxTags, *_nethttp.Response, error)

GetInboxTagsPaginated Get inbox tags paginated Get all inbox tags paginated

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetInboxTagsPaginatedOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size in list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "SearchFilter" (optional.String) - Optional search filter

@return PageInboxTags

func (*InboxControllerApiService) GetInboxes 

func (a *InboxControllerApiService) GetInboxes(ctx _context.Context, localVarOptionals *GetInboxesOpts) ([]InboxDto, *_nethttp.Response, error)

GetInboxes List Inboxes and email addresses List the inboxes you have created. Note use of the more advanced &#x60;getAllInboxes&#x60; is recommended and allows paginated access using a limit and sort parameter.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetInboxesOpts - Optional Parameters:
  • @param "Size" (optional.Int32) - Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries.
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Optional filter by created after given date time
  • @param "ExcludeCatchAllInboxes" (optional.Bool) - Optional exclude catch all inboxes
  • @param "Before" (optional.Time) - Optional filter by created before given date time
  • @param "Include" (optional.Interface of []string) - Optional inboxIds to include in result

@return []InboxDto

func (*InboxControllerApiService) GetInboxesByTag 

func (a *InboxControllerApiService) GetInboxesByTag(ctx _context.Context, tag string, localVarOptionals *GetInboxesByTagOpts) (PageInboxProjection, *_nethttp.Response, error)

GetInboxesByTag Get inboxes for a tag Get all inboxes for a given inbox tag

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tag Tag to filter by
  • @param optional nil or *GetInboxesByTagOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size in list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "SearchFilter" (optional.String) - Optional search filter

@return PageInboxProjection

func (*InboxControllerApiService) GetLatestEmailInInbox 

func (a *InboxControllerApiService) GetLatestEmailInInbox(ctx _context.Context, inboxId string, timeoutMillis int64) (Email, *_nethttp.Response, error)

GetLatestEmailInInbox Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. Get the newest email in an inbox or wait for one to arrive

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId ID of the inbox you want to get the latest email from
  • @param timeoutMillis Timeout milliseconds to wait for latest email

@return Email

func (*InboxControllerApiService) GetOrCreateInboxPlusAddress 

func (a *InboxControllerApiService) GetOrCreateInboxPlusAddress(ctx _context.Context, inboxId string, fullAddress string) (PlusAddressDto, *_nethttp.Response, error)

GetOrCreateInboxPlusAddress Get or create a plus address by full address Looks up an inbox plus address using a full email address like &#x60;inbox+alias@domain.com&#x60;. Returns an existing plus address if found, otherwise creates one. Rejects the request if the full address is already assigned to a real inbox.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId ID of the inbox you want to target
  • @param fullAddress Full recipient address including +suffix. Example: `inbox+alias@domain.com`

@return PlusAddressDto

func (*InboxControllerApiService) GetOrCreatePlusAddressByFullAddress 

func (a *InboxControllerApiService) GetOrCreatePlusAddressByFullAddress(ctx _context.Context, fullAddress string) (PlusAddressDto, *_nethttp.Response, error)

GetOrCreatePlusAddressByFullAddress Get or create a plus address by full address without inbox ID Looks up an inbox plus address using a full email address like &#x60;inbox+alias@domain.com&#x60;. Resolves the base inbox from the full address for the authenticated user, then returns an existing plus address if found, otherwise creates one. Rejects the request if the full address is already assigned to a real inbox.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param fullAddress Full recipient address including +suffix. Example: `inbox+alias@domain.com`

@return PlusAddressDto

func (*InboxControllerApiService) GetOrganizationInboxes 

func (a *InboxControllerApiService) GetOrganizationInboxes(ctx _context.Context, localVarOptionals *GetOrganizationInboxesOpts) (PageOrganizationInboxProjection, *_nethttp.Response, error)

GetOrganizationInboxes List Organization Inboxes Paginated List organization inboxes in paginated form. These are inboxes created with &#x60;allowTeamAccess&#x60; flag enabled. Organization inboxes are &#x60;readOnly&#x60; for non-admin users. The results are available on the &#x60;content&#x60; property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetOrganizationInboxesOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size in list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "SearchFilter" (optional.String) - Optional search filter
  • @param "Since" (optional.Time) - Optional filter by created after given date time
  • @param "Before" (optional.Time) - Optional filter by created before given date time

@return PageOrganizationInboxProjection

func (*InboxControllerApiService) GetOutboxes 

func (a *InboxControllerApiService) GetOutboxes(ctx _context.Context, localVarOptionals *GetOutboxesOpts) (PageInboxProjection, *_nethttp.Response, error)

GetOutboxes List all inboxes with sent emails List inboxes that have sent emails

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetOutboxesOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size in list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC

@return PageInboxProjection

func (*InboxControllerApiService) GetScheduledJob 

func (a *InboxControllerApiService) GetScheduledJob(ctx _context.Context, jobId string) (ScheduledJobDto, *_nethttp.Response, error)

GetScheduledJob Get a scheduled email job Get a scheduled email job details.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param jobId

@return ScheduledJobDto

func (*InboxControllerApiService) GetScheduledJobsByInboxId 

func (a *InboxControllerApiService) GetScheduledJobsByInboxId(ctx _context.Context, inboxId string, localVarOptionals *GetScheduledJobsByInboxIdOpts) (PageScheduledJobs, *_nethttp.Response, error)

GetScheduledJobsByInboxId Get all scheduled email sending jobs for the inbox Schedule sending of emails using scheduled jobs.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId
  • @param optional nil or *GetScheduledJobsByInboxIdOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in scheduled job list pagination
  • @param "Size" (optional.Int32) - Optional page size in scheduled job list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return PageScheduledJobs

func (*InboxControllerApiService) GetSmtpAccess 

func (a *InboxControllerApiService) GetSmtpAccess(ctx _context.Context, localVarOptionals *GetSmtpAccessOpts) (SmtpAccessDetails, *_nethttp.Response, error)

GetSmtpAccess Method for GetSmtpAccess Get SMTP access usernames and passwords

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetSmtpAccessOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Inbox ID

@return SmtpAccessDetails

func (*InboxControllerApiService) ImportEmailIntoInbox 

func (a *InboxControllerApiService) ImportEmailIntoInbox(ctx _context.Context, inboxId string, importEmailOptions ImportEmailOptions) (Email, *_nethttp.Response, error)

ImportEmailIntoInbox Import email into inbox from base64 MIME Imports a raw RFC822/MIME email into the specified inbox regardless of the original &#x60;To&#x60; header. V1 accepts MIME-family formats such as &#x60;.eml&#x60;, &#x60;message/rfc822&#x60;, and raw MIME bytes only. Outlook &#x60;.msg&#x60;, &#x60;mbox&#x60;, and &#x60;maildir&#x60; are not supported in V1. By default MailSlurp rewrites the MIME &#x60;Message-ID&#x60; header to avoid imported message identity clashes. Set &#x60;runPipeline&#x3D;true&#x60; to run the normal inbound receive pipeline after persistence.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId
  • @param importEmailOptions

@return Email

func (*InboxControllerApiService) ImportEmailIntoInboxBytes 

func (a *InboxControllerApiService) ImportEmailIntoInboxBytes(ctx _context.Context, inboxId string, body string, localVarOptionals *ImportEmailIntoInboxBytesOpts) (Email, *_nethttp.Response, error)

ImportEmailIntoInboxBytes Import email into inbox from raw MIME bytes Imports a raw RFC822/MIME email stream into the specified inbox regardless of the original &#x60;To&#x60; header. Supports &#x60;message/rfc822&#x60; and &#x60;application/octet-stream&#x60;. V1 does not support Outlook &#x60;.msg&#x60;, &#x60;mbox&#x60;, or &#x60;maildir&#x60;. By default MailSlurp rewrites the MIME &#x60;Message-ID&#x60; header to avoid imported message identity clashes.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId
  • @param body
  • @param optional nil or *ImportEmailIntoInboxBytesOpts - Optional Parameters:
  • @param "ExternalId" (optional.String) -
  • @param "RunPipeline" (optional.Bool) -
  • @param "OverrideMessageId" (optional.Bool) -

@return Email

func (*InboxControllerApiService) ImportEmailIntoInboxMultipart 

func (a *InboxControllerApiService) ImportEmailIntoInboxMultipart(ctx _context.Context, inboxId string, file *os.File, localVarOptionals *ImportEmailIntoInboxMultipartOpts) (Email, *_nethttp.Response, error)

ImportEmailIntoInboxMultipart Import email into inbox from multipart EML upload Imports an uploaded RFC822/MIME file into the specified inbox regardless of the original &#x60;To&#x60; header. Intended for &#x60;.eml&#x60; uploads and other MIME-family raw email files. V1 does not support Outlook &#x60;.msg&#x60;, &#x60;mbox&#x60;, or &#x60;maildir&#x60;. By default MailSlurp rewrites the MIME &#x60;Message-ID&#x60; header to avoid imported message identity clashes.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId
  • @param file
  • @param optional nil or *ImportEmailIntoInboxMultipartOpts - Optional Parameters:
  • @param "ExternalId" (optional.String) -
  • @param "RunPipeline" (optional.Bool) -
  • @param "OverrideMessageId" (optional.Bool) -

@return Email

func (*InboxControllerApiService) IsEmailAddressAvailable 

func (a *InboxControllerApiService) IsEmailAddressAvailable(ctx _context.Context, emailAddress string) (EmailAvailableResult, *_nethttp.Response, error)

IsEmailAddressAvailable Is email address available Returns whether an email address is available

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailAddress

@return EmailAvailableResult

func (*InboxControllerApiService) ListInboxRulesets 

func (a *InboxControllerApiService) ListInboxRulesets(ctx _context.Context, inboxId string, localVarOptionals *ListInboxRulesetsOpts) (PageRulesetDto, *_nethttp.Response, error)

ListInboxRulesets List inbox rulesets List all rulesets attached to an inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId
  • @param optional nil or *ListInboxRulesetsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in inbox ruleset list pagination
  • @param "Size" (optional.Int32) - Optional page size in inbox ruleset list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "SearchFilter" (optional.String) - Optional search filter
  • @param "Since" (optional.Time) - Optional filter by created after given date time
  • @param "Before" (optional.Time) - Optional filter by created before given date time

@return PageRulesetDto

func (*InboxControllerApiService) ListInboxTrackingPixels 

func (a *InboxControllerApiService) ListInboxTrackingPixels(ctx _context.Context, inboxId string, localVarOptionals *ListInboxTrackingPixelsOpts) (PageTrackingPixelProjection, *_nethttp.Response, error)

ListInboxTrackingPixels List inbox tracking pixels List all tracking pixels sent from an inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId
  • @param optional nil or *ListInboxTrackingPixelsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in inbox tracking pixel list pagination
  • @param "Size" (optional.Int32) - Optional page size in inbox tracking pixel list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "SearchFilter" (optional.String) - Optional search filter
  • @param "Since" (optional.Time) - Optional filter by created after given date time
  • @param "Before" (optional.Time) - Optional filter by created before given date time

@return PageTrackingPixelProjection

func (*InboxControllerApiService) SearchInboxes 

func (a *InboxControllerApiService) SearchInboxes(ctx _context.Context, searchInboxesOptions SearchInboxesOptions) (PageInboxProjection, *_nethttp.Response, error)

SearchInboxes Search all inboxes and return matching inboxes Search inboxes and return in paginated form. The results are available on the &#x60;content&#x60; property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative &#x60;getInboxes&#x60; method returns a full list of inboxes but is limited to 100 results.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param searchInboxesOptions

@return PageInboxProjection

func (*InboxControllerApiService) SendEmail 

func (a *InboxControllerApiService) SendEmail(ctx _context.Context, inboxId string, sendEmailOptions SendEmailOptions) (*_nethttp.Response, error)

SendEmail Send Email Send an email from an inbox&#39;s email address. The request body should contain the &#x60;SendEmailOptions&#x60; that include recipients, attachments, body etc. See &#x60;SendEmailOptions&#x60; for all available properties. Note the &#x60;inboxId&#x60; refers to the inbox&#39;s id not the inbox&#39;s email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method &#x60;sendEmailAndConfirm&#x60;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId ID of the inbox you want to send the email from
  • @param sendEmailOptions

func (*InboxControllerApiService) SendEmailAndConfirm 

func (a *InboxControllerApiService) SendEmailAndConfirm(ctx _context.Context, inboxId string, sendEmailOptions SendEmailOptions) (SentEmailDto, *_nethttp.Response, error)

SendEmailAndConfirm Send email and return sent confirmation Sister method for standard &#x60;sendEmail&#x60; method with the benefit of returning a &#x60;SentEmail&#x60; entity confirming the successful sending of the email with a link to the sent object created for it.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId ID of the inbox you want to send the email from
  • @param sendEmailOptions

@return SentEmailDto

func (*InboxControllerApiService) SendEmailWithQueue 

func (a *InboxControllerApiService) SendEmailWithQueue(ctx _context.Context, inboxId string, validateBeforeEnqueue bool, sendEmailOptions SendEmailOptions) (*_nethttp.Response, error)

SendEmailWithQueue Send email with queue Send an email using a queue. Will place the email onto a queue that will then be processed and sent. Use this queue method to enable any failed email sending to be recovered. This will prevent lost emails when sending if your account encounters a block or payment issue.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId ID of the inbox you want to send the email from
  • @param validateBeforeEnqueue Validate before adding to queue
  • @param sendEmailOptions

func (*InboxControllerApiService) SendSmtpEnvelope 

func (a *InboxControllerApiService) SendSmtpEnvelope(ctx _context.Context, inboxId string, sendSmtpEnvelopeOptions SendSmtpEnvelopeOptions) (SentEmailDto, *_nethttp.Response, error)

SendSmtpEnvelope Send email using an SMTP mail envelope and message body and return sent confirmation Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId ID of the inbox you want to send the email from
  • @param sendSmtpEnvelopeOptions

@return SentEmailDto

func (*InboxControllerApiService) SendTestEmail 

func (a *InboxControllerApiService) SendTestEmail(ctx _context.Context, inboxId string) (*_nethttp.Response, error)

SendTestEmail Send a test email to inbox Send an inbox a test email to test email receiving is working

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId

func (*InboxControllerApiService) SendWithSchedule 

func (a *InboxControllerApiService) SendWithSchedule(ctx _context.Context, inboxId string, sendEmailOptions SendEmailOptions, localVarOptionals *SendWithScheduleOpts) (ScheduledJobDto, *_nethttp.Response, error)

SendWithSchedule Send email with with delay or schedule Send an email using a delay. Will place the email onto a scheduler that will then be processed and sent. Use delays to schedule email sending.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId ID of the inbox you want to send the email from
  • @param sendEmailOptions
  • @param optional nil or *SendWithScheduleOpts - Optional Parameters:
  • @param "SendAtTimestamp" (optional.Time) - Sending timestamp
  • @param "SendAtNowPlusSeconds" (optional.Int64) - Send after n seconds
  • @param "ValidateBeforeEnqueue" (optional.Bool) - Validate before adding to queue

@return ScheduledJobDto

func (*InboxControllerApiService) SetInboxFavourited 

func (a *InboxControllerApiService) SetInboxFavourited(ctx _context.Context, inboxId string, setInboxFavouritedOptions SetInboxFavouritedOptions) (InboxDto, *_nethttp.Response, error)

SetInboxFavourited Set inbox favourited state Set and return new favorite state for an inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId ID of inbox to set favourite state
  • @param setInboxFavouritedOptions

@return InboxDto

func (*InboxControllerApiService) UpdateImapAccess 

func (a *InboxControllerApiService) UpdateImapAccess(ctx _context.Context, updateImapAccessOptions UpdateImapAccessOptions, localVarOptionals *UpdateImapAccessOpts) (*_nethttp.Response, error)

UpdateImapAccess Method for UpdateImapAccess Update IMAP access usernames and passwords

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param updateImapAccessOptions
  • @param optional nil or *UpdateImapAccessOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Inbox ID

func (*InboxControllerApiService) UpdateInbox 

func (a *InboxControllerApiService) UpdateInbox(ctx _context.Context, inboxId string, updateInboxOptions UpdateInboxOptions) (InboxDto, *_nethttp.Response, error)

UpdateInbox Update Inbox. Change name and description. Email address is not editable. Update editable fields on an inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId
  • @param updateInboxOptions

@return InboxDto

func (*InboxControllerApiService) UpdateSmtpAccess 

func (a *InboxControllerApiService) UpdateSmtpAccess(ctx _context.Context, updateSmtpAccessOptions UpdateSmtpAccessOptions, localVarOptionals *UpdateSmtpAccessOpts) (*_nethttp.Response, error)

UpdateSmtpAccess Method for UpdateSmtpAccess Update SMTP access usernames and passwords

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param updateSmtpAccessOptions
  • @param optional nil or *UpdateSmtpAccessOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Inbox ID

type InboxDto 

type InboxDto struct {
	// ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox and Email Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox Controller methods `waitForLatestEmail` and `getEmails` methods respectively. Inboxes can be used with aliases to forward emails automatically.
	Id string `json:"id"`
	// ID of user that inbox belongs to
	UserId *string `json:"userId"`
	// When the inbox was created. Time stamps are in ISO DateTime Format `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` e.g. `2000-10-31T01:30:00.000-05:00`.
	CreatedAt time.Time `json:"createdAt"`
	// Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search
	Name *string `json:"name,omitempty"`
	// ID of custom domain used by the inbox if any
	DomainId *string `json:"domainId,omitempty"`
	// Description of an inbox for labelling and searching purposes
	Description *string `json:"description,omitempty"`
	// The inbox's email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so `+123` additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
	EmailAddress string `json:"emailAddress"`
	// Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email.
	ExpiresAt *time.Time `json:"expiresAt,omitempty"`
	// Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering
	Favourite bool `json:"favourite"`
	// Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
	Tags *[]string `json:"tags,omitempty"`
	// Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).
	InboxType *string `json:"inboxType,omitempty"`
	// Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes.
	ReadOnly bool `json:"readOnly"`
	// Virtual inbox can receive email but will not send emails to real recipients. Will save sent email record but never send an actual email. Perfect for testing mail server actions.
	VirtualInbox bool `json:"virtualInbox"`
	// Inbox function if used as a primitive for another system.
	FunctionsAs *string `json:"functionsAs,omitempty"`
	// Local part of email addresses before the @ symbol
	LocalPart *string `json:"localPart,omitempty"`
	// Domain name of the email address
	Domain *string `json:"domain,omitempty"`
	// Region of the inbox
	AccountRegion *string `json:"accountRegion,omitempty"`
}

InboxDto Representation of a MailSlurp inbox. An inbox has an ID and a real email address. Emails can be sent to or from this email address. Inboxes are either `SMTP` or `HTTP` mailboxes. The default, `HTTP` inboxes, use AWS SES to process emails and are best suited as test email accounts and do not support IMAP or POP3. `SMTP` inboxes use a custom mail server at `mxslurp.click` and support SMTP login, IMAP and POP3. Use the `EmailController` or the `InboxController` methods to send and receive emails and attachments. Inboxes may have a description, name, and tags for display purposes. You can also favourite an inbox for easier searching.

type InboxExistsDto 

type InboxExistsDto struct {
	Exists bool `json:"exists"`
	// Inbox is full or simulating a soft bounce via inbox replier or rulesets
	SoftBounce *bool `json:"softBounce,omitempty"`
	// Inbox is blocking receiving emails or simulating a hard bounce via inbox replier or rulesets
	HardBounce *bool `json:"hardBounce,omitempty"`
}

InboxExistsDto Result of email exists query

type InboxForwarderControllerApiService 

type InboxForwarderControllerApiService service

InboxForwarderControllerApiService InboxForwarderControllerApi service

func (*InboxForwarderControllerApiService) CreateNewInboxForwarder 

func (a *InboxForwarderControllerApiService) CreateNewInboxForwarder(ctx _context.Context, createInboxForwarderOptions CreateInboxForwarderOptions, localVarOptionals *CreateNewInboxForwarderOpts) (InboxForwarderDto, *_nethttp.Response, error)

CreateNewInboxForwarder Create an inbox forwarder Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createInboxForwarderOptions
  • @param optional nil or *CreateNewInboxForwarderOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Inbox id to attach forwarder to

@return InboxForwarderDto

func (*InboxForwarderControllerApiService) DeleteInboxForwarder 

func (a *InboxForwarderControllerApiService) DeleteInboxForwarder(ctx _context.Context, id string) (*_nethttp.Response, error)

DeleteInboxForwarder Delete an inbox forwarder Delete inbox forwarder

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of inbox forwarder

func (*InboxForwarderControllerApiService) DeleteInboxForwarders 

func (a *InboxForwarderControllerApiService) DeleteInboxForwarders(ctx _context.Context, localVarOptionals *DeleteInboxForwardersOpts) (*_nethttp.Response, error)

DeleteInboxForwarders Delete inbox forwarders Delete inbox forwarders. Accepts optional inboxId filter.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *DeleteInboxForwardersOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Optional inbox id to attach forwarder to

func (*InboxForwarderControllerApiService) GetAllInboxForwarderEvents 

func (a *InboxForwarderControllerApiService) GetAllInboxForwarderEvents(ctx _context.Context, localVarOptionals *GetAllInboxForwarderEventsOpts) (PageInboxForwarderEvents, *_nethttp.Response, error)

GetAllInboxForwarderEvents Get all inbox forwarder events Get all inbox forwarder events

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAllInboxForwarderEventsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in inbox forwarder event list pagination
  • @param "Size" (optional.Int32) - Optional page size in inbox forwarder event list pagination
  • @param "InboxId" (optional.Interface of string) - Optional inbox ID to filter for
  • @param "EmailId" (optional.Interface of string) - Optional email ID to filter for
  • @param "SentId" (optional.Interface of string) - Optional sent ID to filter for
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC

@return PageInboxForwarderEvents

func (*InboxForwarderControllerApiService) GetForwarderEvent 

func (a *InboxForwarderControllerApiService) GetForwarderEvent(ctx _context.Context, eventId string) (InboxForwarderEventDto, *_nethttp.Response, error)

GetForwarderEvent Get a forwarder event Get forwarder event

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param eventId ID of inbox forwarder event

@return InboxForwarderEventDto

func (*InboxForwarderControllerApiService) GetInboxForwarder 

func (a *InboxForwarderControllerApiService) GetInboxForwarder(ctx _context.Context, id string) (InboxForwarderDto, *_nethttp.Response, error)

GetInboxForwarder Get an inbox forwarder Get inbox forwarder

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of inbox forwarder

@return InboxForwarderDto

func (*InboxForwarderControllerApiService) GetInboxForwarderEvent 

func (a *InboxForwarderControllerApiService) GetInboxForwarderEvent(ctx _context.Context, id string, eventId string) (InboxForwarderEventDto, *_nethttp.Response, error)

GetInboxForwarderEvent Get an inbox forwarder event Get inbox forwarder event

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of inbox forwarder
  • @param eventId ID of inbox forwarder event

@return InboxForwarderEventDto

func (*InboxForwarderControllerApiService) GetInboxForwarderEvents 

func (a *InboxForwarderControllerApiService) GetInboxForwarderEvents(ctx _context.Context, id string, localVarOptionals *GetInboxForwarderEventsOpts) (PageInboxForwarderEvents, *_nethttp.Response, error)

GetInboxForwarderEvents Get an inbox forwarder event list Get inbox forwarder events

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of inbox forwarder
  • @param optional nil or *GetInboxForwarderEventsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in inbox forwarder event list pagination
  • @param "Size" (optional.Int32) - Optional page size in inbox forwarder event list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC

@return PageInboxForwarderEvents

func (*InboxForwarderControllerApiService) GetInboxForwarders 

func (a *InboxForwarderControllerApiService) GetInboxForwarders(ctx _context.Context, localVarOptionals *GetInboxForwardersOpts) (PageInboxForwarderDto, *_nethttp.Response, error)

GetInboxForwarders List inbox forwarders List all forwarders attached to an inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetInboxForwardersOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Optional inbox id to get forwarders from
  • @param "Page" (optional.Int32) - Optional page index in inbox forwarder list pagination
  • @param "Size" (optional.Int32) - Optional page size in inbox forwarder list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "SearchFilter" (optional.String) - Optional search filter
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return PageInboxForwarderDto

func (*InboxForwarderControllerApiService) TestInboxForwarder 

func (a *InboxForwarderControllerApiService) TestInboxForwarder(ctx _context.Context, id string, inboxForwarderTestOptions InboxForwarderTestOptions) (InboxForwarderTestResult, *_nethttp.Response, error)

TestInboxForwarder Test an inbox forwarder Test an inbox forwarder

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of inbox forwarder
  • @param inboxForwarderTestOptions

@return InboxForwarderTestResult

func (*InboxForwarderControllerApiService) TestInboxForwardersForInbox 

func (a *InboxForwarderControllerApiService) TestInboxForwardersForInbox(ctx _context.Context, inboxId string, inboxForwarderTestOptions InboxForwarderTestOptions) (InboxForwarderTestResult, *_nethttp.Response, error)

TestInboxForwardersForInbox Test inbox forwarders for inbox Test inbox forwarders for inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId ID of inbox
  • @param inboxForwarderTestOptions

@return InboxForwarderTestResult

func (*InboxForwarderControllerApiService) TestNewInboxForwarder 

func (a *InboxForwarderControllerApiService) TestNewInboxForwarder(ctx _context.Context, testNewInboxForwarderOptions TestNewInboxForwarderOptions) (InboxForwarderTestResult, *_nethttp.Response, error)

TestNewInboxForwarder Test new inbox forwarder Test new inbox forwarder

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testNewInboxForwarderOptions

@return InboxForwarderTestResult

func (*InboxForwarderControllerApiService) UpdateInboxForwarder 

func (a *InboxForwarderControllerApiService) UpdateInboxForwarder(ctx _context.Context, id string, createInboxForwarderOptions CreateInboxForwarderOptions) (InboxForwarderDto, *_nethttp.Response, error)

UpdateInboxForwarder Update an inbox forwarder Update inbox forwarder

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of inbox forwarder
  • @param createInboxForwarderOptions

@return InboxForwarderDto

type InboxForwarderDto 

type InboxForwarderDto struct {
	Id      string  `json:"id"`
	InboxId *string `json:"inboxId,omitempty"`
	// Name of inbox forwarder
	Name *string `json:"name,omitempty"`
	// Which field to match against
	Field *string `json:"field,omitempty"`
	// Pattern to apply to field
	Match *string `json:"match,omitempty"`
	// Who to send forwarded email to
	ForwardToRecipients []string  `json:"forwardToRecipients"`
	CreatedAt           time.Time `json:"createdAt"`
	// Comparison mode for inbox automation matching.
	Should       *string                      `json:"should,omitempty"`
	MatchOptions *InboxAutomationMatchOptions `json:"matchOptions,omitempty"`
	// Method for extracting text from attachments.
	AttachmentTextExtractionMethod *string `json:"attachmentTextExtractionMethod,omitempty"`
}

InboxForwarderDto Inbox forwarder. Describes how an inbox will forward matching emails to designated recipients.

type InboxForwarderEventDto 

type InboxForwarderEventDto struct {
	Id          *string   `json:"id,omitempty"`
	InboxId     *string   `json:"inboxId,omitempty"`
	EmailId     *string   `json:"emailId,omitempty"`
	SentId      *string   `json:"sentId,omitempty"`
	UserId      *string   `json:"userId,omitempty"`
	ForwarderId *string   `json:"forwarderId,omitempty"`
	Message     *string   `json:"message,omitempty"`
	Status      *string   `json:"status,omitempty"`
	CreatedAt   time.Time `json:"createdAt"`
}

InboxForwarderEventDto Inbox forwarder event. Describes how an email was handled by an inbox forwarder.

type InboxForwarderEventProjection 

type InboxForwarderEventProjection struct {
	Message     *string   `json:"message,omitempty"`
	Id          *string   `json:"id,omitempty"`
	Status      *string   `json:"status,omitempty"`
	UserId      *string   `json:"userId,omitempty"`
	EmailId     *string   `json:"emailId,omitempty"`
	InboxId     *string   `json:"inboxId,omitempty"`
	CreatedAt   time.Time `json:"createdAt"`
	SentId      *string   `json:"sentId,omitempty"`
	ForwarderId *string   `json:"forwarderId,omitempty"`
}

InboxForwarderEventProjection Inbox forwarder event

type InboxForwarderTestOptions 

type InboxForwarderTestOptions struct {
	// Simple value to test against the forwarder's simple field/match rule. Required when emailId is not provided.
	TestValue *string `json:"testValue,omitempty"`
	// Optional email ID to evaluate the forwarder using full inbound email content (headers, recipients, and attachments).
	EmailId *string `json:"emailId,omitempty"`
}

InboxForwarderTestOptions Options for testing an inbox forwarder against a value

type InboxForwarderTestResult 

type InboxForwarderTestResult struct {
	Matches   map[string]bool `json:"matches"`
	DoesMatch bool            `json:"doesMatch"`
}

InboxForwarderTestResult Results of inbox forwarder test

type InboxIdItem 

type InboxIdItem struct {
	Id           string `json:"id"`
	EmailAddress string `json:"emailAddress"`
}

InboxIdItem Inbox ID and email address pair

type InboxIdsResult 

type InboxIdsResult struct {
	InboxIds []InboxIdItem `json:"inboxIds"`
}

InboxIdsResult List of inbox IDs and email addresses

type InboxPreview 

type InboxPreview struct {
	// ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox and Email Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox Controller methods `waitForLatestEmail` and `getEmails` methods respectively. Inboxes can be used with aliases to forward emails automatically.
	Id string `json:"id"`
	// ID of custom domain used by the inbox if any
	DomainId *string `json:"domainId,omitempty"`
	// The inbox's email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so `+123` additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
	EmailAddress *string `json:"emailAddress"`
	// When the inbox was created. Time stamps are in ISO DateTime Format `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` e.g. `2000-10-31T01:30:00.000-05:00`.
	CreatedAt time.Time `json:"createdAt"`
	// Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering
	Favourite bool `json:"favourite"`
	// Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search
	Name *string `json:"name,omitempty"`
	// Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
	Tags *[]string `json:"tags,omitempty"`
	// Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it. See the team access guide at https://www.mailslurp.com/guides/team-email-account-sharing/
	TeamAccess bool `json:"teamAccess"`
	// Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).
	InboxType *string `json:"inboxType,omitempty"`
	// Virtual inbox can receive email but will not send emails to real recipients. Will save sent email record but never send an actual email. Perfect for testing mail server actions.
	VirtualInbox bool `json:"virtualInbox"`
	// Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email.
	ExpiresAt *time.Time `json:"expiresAt,omitempty"`
	// Inbox function if used as a primitive for another system.
	FunctionsAs *string `json:"functionsAs,omitempty"`
	// ID of user that inbox belongs to
	UserId *string `json:"userId"`
	// Description of an inbox for labelling and searching purposes
	Description *string `json:"description,omitempty"`
	// Region of the inbox
	AccountRegion *string `json:"accountRegion,omitempty"`
}

InboxPreview Inbox data preview element.

type InboxReplierControllerApiService 

type InboxReplierControllerApiService service

InboxReplierControllerApiService InboxReplierControllerApi service

func (*InboxReplierControllerApiService) CreateNewInboxReplier 

func (a *InboxReplierControllerApiService) CreateNewInboxReplier(ctx _context.Context, createInboxReplierOptions CreateInboxReplierOptions) (InboxReplierDto, *_nethttp.Response, error)

CreateNewInboxReplier Create an inbox replier Create a new inbox rule for reply toing, blocking, and allowing emails when sending and receiving

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createInboxReplierOptions

@return InboxReplierDto

func (*InboxReplierControllerApiService) DeleteInboxReplier 

func (a *InboxReplierControllerApiService) DeleteInboxReplier(ctx _context.Context, id string) (*_nethttp.Response, error)

DeleteInboxReplier Delete an inbox replier Delete inbox replier

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of inbox replier

func (*InboxReplierControllerApiService) DeleteInboxRepliers 

func (a *InboxReplierControllerApiService) DeleteInboxRepliers(ctx _context.Context, localVarOptionals *DeleteInboxRepliersOpts) (*_nethttp.Response, error)

DeleteInboxRepliers Delete inbox repliers Delete inbox repliers. Accepts optional inboxId filter.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *DeleteInboxRepliersOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Optional inbox id to attach replier to

func (*InboxReplierControllerApiService) GetAllInboxReplierEvents 

func (a *InboxReplierControllerApiService) GetAllInboxReplierEvents(ctx _context.Context, localVarOptionals *GetAllInboxReplierEventsOpts) (PageInboxReplierEvents, *_nethttp.Response, error)

GetAllInboxReplierEvents Get inbox replier event list Get all inbox ruleset events

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAllInboxReplierEventsOpts - Optional Parameters:
  • @param "InboxReplierId" (optional.Interface of string) - ID of inbox replier
  • @param "InboxId" (optional.Interface of string) - ID of inbox
  • @param "EmailId" (optional.Interface of string) - ID of email
  • @param "SentId" (optional.Interface of string) - ID of sent
  • @param "Page" (optional.Int32) - Optional page index in inbox replier event list pagination
  • @param "Size" (optional.Int32) - Optional page size in inbox replier event list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC

@return PageInboxReplierEvents

func (*InboxReplierControllerApiService) GetInboxReplier 

func (a *InboxReplierControllerApiService) GetInboxReplier(ctx _context.Context, id string) (InboxReplierDto, *_nethttp.Response, error)

GetInboxReplier Get an inbox replier Get inbox ruleset

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of inbox replier

@return InboxReplierDto

func (*InboxReplierControllerApiService) GetInboxReplierEvents 

func (a *InboxReplierControllerApiService) GetInboxReplierEvents(ctx _context.Context, id string, localVarOptionals *GetInboxReplierEventsOpts) (PageInboxReplierEvents, *_nethttp.Response, error)

GetInboxReplierEvents Get an inbox replier event list Get inbox ruleset events

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of inbox replier
  • @param optional nil or *GetInboxReplierEventsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in inbox replier event list pagination
  • @param "Size" (optional.Int32) - Optional page size in inbox replier event list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC

@return PageInboxReplierEvents

func (*InboxReplierControllerApiService) GetInboxRepliers 

func (a *InboxReplierControllerApiService) GetInboxRepliers(ctx _context.Context, localVarOptionals *GetInboxRepliersOpts) (PageInboxReplierDto, *_nethttp.Response, error)

GetInboxRepliers List inbox repliers List all repliers attached to an inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetInboxRepliersOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Optional inbox id to get repliers from
  • @param "Page" (optional.Int32) - Optional page index in inbox replier list pagination
  • @param "Size" (optional.Int32) - Optional page size in inbox replier list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return PageInboxReplierDto

func (*InboxReplierControllerApiService) UpdateInboxReplier 

func (a *InboxReplierControllerApiService) UpdateInboxReplier(ctx _context.Context, id string, updateInboxReplierOptions UpdateInboxReplierOptions) (InboxReplierDto, *_nethttp.Response, error)

UpdateInboxReplier Update an inbox replier Update inbox ruleset

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of inbox replier
  • @param updateInboxReplierOptions

@return InboxReplierDto

type InboxReplierDto 

type InboxReplierDto struct {
	Id                string                             `json:"id"`
	InboxId           *string                            `json:"inboxId,omitempty"`
	Name              *string                            `json:"name,omitempty"`
	Field             *string                            `json:"field,omitempty"`
	Match             *string                            `json:"match,omitempty"`
	ReplyTo           *string                            `json:"replyTo,omitempty"`
	Subject           *string                            `json:"subject,omitempty"`
	From              *string                            `json:"from,omitempty"`
	Charset           *string                            `json:"charset,omitempty"`
	IsHTML            bool                               `json:"isHTML"`
	TemplateId        *string                            `json:"templateId,omitempty"`
	TemplateVariables *map[string]map[string]interface{} `json:"templateVariables,omitempty"`
	IgnoreReplyTo     bool                               `json:"ignoreReplyTo"`
	CreatedAt         time.Time                          `json:"createdAt"`
	// Comparison mode for inbox automation matching.
	Should       *string                      `json:"should,omitempty"`
	MatchOptions *InboxAutomationMatchOptions `json:"matchOptions,omitempty"`
}

InboxReplierDto Inbox replier. Will automatically reply to inbound emails that match given field for an inbox.

type InboxReplierEventProjection 

type InboxReplierEventProjection struct {
	Message    *string   `json:"message,omitempty"`
	Id         *string   `json:"id,omitempty"`
	Status     *string   `json:"status,omitempty"`
	Recipients *[]string `json:"recipients,omitempty"`
	UserId     *string   `json:"userId,omitempty"`
	EmailId    *string   `json:"emailId,omitempty"`
	InboxId    *string   `json:"inboxId,omitempty"`
	CreatedAt  time.Time `json:"createdAt"`
	SentId     *string   `json:"sentId,omitempty"`
	ReplierId  *string   `json:"replierId,omitempty"`
}

InboxReplierEventProjection Inbox replier event

type InboxRetentionPolicyDto 

type InboxRetentionPolicyDto struct {
	Id            string    `json:"id"`
	InboxId       string    `json:"inboxId,omitempty"`
	RetentionDays int32     `json:"retentionDays"`
	CreatedAt     time.Time `json:"createdAt"`
	UpdatedAt     time.Time `json:"updatedAt"`
}

InboxRetentionPolicyDto struct for InboxRetentionPolicyDto

type InboxRetentionPolicyOptionalDto 

type InboxRetentionPolicyOptionalDto struct {
	Policy InboxRetentionPolicyDto `json:"policy,omitempty"`
}

InboxRetentionPolicyOptionalDto struct for InboxRetentionPolicyOptionalDto

type InboxRulesetTestResult 

type InboxRulesetTestResult struct {
	// Map of inbox ruleset ID to boolean of if target matches
	RulesetMatches map[string]bool `json:"rulesetMatches"`
	Matches        bool            `json:"matches"`
}

InboxRulesetTestResult Result of test of inbox ruleset

type InlineObject 

type InlineObject struct {
	File *os.File `json:"file"`
}

InlineObject struct for InlineObject

type InlineObject1 

type InlineObject1 struct {
	// The email address that submitted form should be sent to.
	To string `json:"_to,omitempty"`
	// Optional subject of the email that will be sent.
	Subject string `json:"_subject,omitempty"`
	// Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later.
	EmailAddress string `json:"_emailAddress,omitempty"`
	// Optional success message to display if no _redirectTo present.
	SuccessMessage string `json:"_successMessage,omitempty"`
	// Optional but recommended field that catches spammers out. Include as a hidden form field but LEAVE EMPTY. Spam-bots will usually fill every field. If the _spamCheck field is filled the form submission will be ignored.
	SpamCheck string `json:"_spamCheck,omitempty"`
	// All other parameters or fields will be accepted and attached to the sent email. This includes files and any HTML form field with a name. These fields will become the body of the email that is sent.
	OtherParameters string `json:"otherParameters,omitempty"`
}

InlineObject1 struct for InlineObject1

type InlineObject2 

type InlineObject2 struct {
	File *os.File `json:"file"`
}

InlineObject2 struct for InlineObject2

type InvokeTransformerOptions 

type InvokeTransformerOptions struct {
	AiTransformId        *string                 `json:"aiTransformId,omitempty"`
	AiTransformMappingId *string                 `json:"aiTransformMappingId,omitempty"`
	RawInput             *string                 `json:"rawInput,omitempty"`
	EntityId             *string                 `json:"entityId,omitempty"`
	EntityType           *string                 `json:"entityType,omitempty"`
	RawConditions        *[]string               `json:"rawConditions,omitempty"`
	RawInstructions      *[]string               `json:"rawInstructions,omitempty"`
	RawOutputSchema      *StructuredOutputSchema `json:"rawOutputSchema,omitempty"`
	ContentSelector      *string                 `json:"contentSelector,omitempty"`
	SaveResults          *bool                   `json:"saveResults,omitempty"`
}

InvokeTransformerOptions struct for InvokeTransformerOptions

type IpAddressResult 

type IpAddressResult struct {
	Address  string `json:"address"`
	Hostname string `json:"hostname"`
}

IpAddressResult IP Address look up result for a given domain / hostname

type JsonSchemaDto 

type JsonSchemaDto struct {
	Value string `json:"value"`
}

JsonSchemaDto JSONSchema for payload

type LinkIssue 

type LinkIssue struct {
	Url            string `json:"url"`
	ResponseStatus int32  `json:"responseStatus,omitempty"`
	Severity       string `json:"severity"`
	Message        string `json:"message"`
}

LinkIssue struct for LinkIssue

type ListInboxRulesetsOpts 

type ListInboxRulesetsOpts struct {
	Page         optional.Int32
	Size         optional.Int32
	Sort         optional.String
	SearchFilter optional.String
	Since        optional.Time
	Before       optional.Time
}

ListInboxRulesetsOpts Optional parameters for the method 'ListInboxRulesets'

type ListInboxTrackingPixelsOpts 

type ListInboxTrackingPixelsOpts struct {
	Page         optional.Int32
	Size         optional.Int32
	Sort         optional.String
	SearchFilter optional.String
	Since        optional.Time
	Before       optional.Time
}

ListInboxTrackingPixelsOpts Optional parameters for the method 'ListInboxTrackingPixels'

type ListUnsubscribeRecipientProjection 

type ListUnsubscribeRecipientProjection struct {
	Id           string    `json:"id"`
	EmailAddress string    `json:"emailAddress"`
	CreatedAt    time.Time `json:"createdAt"`
	DomainId     *string   `json:"domainId,omitempty"`
}

ListUnsubscribeRecipientProjection List unsubscribe recipient

type LookupBimiDomainOptions 

type LookupBimiDomainOptions struct {
	Host string `json:"host"`
}

LookupBimiDomainOptions struct for LookupBimiDomainOptions

type LookupBimiDomainResults 

type LookupBimiDomainResults struct {
	Valid    bool              `json:"valid"`
	Query    DnsLookupOptions  `json:"query"`
	Records  []DnsLookupResult `json:"records"`
	Errors   []string          `json:"errors"`
	Warnings []string          `json:"warnings"`
}

LookupBimiDomainResults struct for LookupBimiDomainResults

type LookupDkimDomainOptions 

type LookupDkimDomainOptions struct {
	// Domain to inspect for DKIM
	Host string `json:"host"`
	// Optional selector. If omitted, common selectors are probed.
	Selector *string `json:"selector,omitempty"`
}

LookupDkimDomainOptions struct for LookupDkimDomainOptions

type LookupDkimDomainResults 

type LookupDkimDomainResults struct {
	Valid        bool     `json:"valid"`
	QueriedName  string   `json:"queriedName,omitempty"`
	Selector     string   `json:"selector,omitempty"`
	Record       string   `json:"record,omitempty"`
	Algorithm    string   `json:"algorithm,omitempty"`
	KeyLength    int32    `json:"keyLength,omitempty"`
	CheckedNames []string `json:"checkedNames"`
	Warnings     []string `json:"warnings"`
	Errors       []string `json:"errors"`
}

LookupDkimDomainResults struct for LookupDkimDomainResults

type LookupDmarcDomainOptions 

type LookupDmarcDomainOptions struct {
	Host string `json:"host"`
}

LookupDmarcDomainOptions struct for LookupDmarcDomainOptions

type LookupDmarcDomainResults 

type LookupDmarcDomainResults struct {
	Valid    bool              `json:"valid"`
	Query    DnsLookupOptions  `json:"query"`
	Records  []DnsLookupResult `json:"records"`
	Errors   []string          `json:"errors"`
	Warnings []string          `json:"warnings"`
}

LookupDmarcDomainResults struct for LookupDmarcDomainResults

type LookupMtaStsDomainOptions 

type LookupMtaStsDomainOptions struct {
	Host string `json:"host"`
}

LookupMtaStsDomainOptions struct for LookupMtaStsDomainOptions

type LookupMtaStsDomainResults 

type LookupMtaStsDomainResults struct {
	Valid            bool              `json:"valid"`
	Query            DnsLookupOptions  `json:"query"`
	Records          []DnsLookupResult `json:"records"`
	WellKnownQuery   string            `json:"wellKnownQuery"`
	WellKnownPresent bool              `json:"wellKnownPresent"`
	WellKnownValue   string            `json:"wellKnownValue"`
	Errors           []string          `json:"errors"`
	Warnings         []string          `json:"warnings"`
}

LookupMtaStsDomainResults struct for LookupMtaStsDomainResults

type LookupMxRecordsOptions 

type LookupMxRecordsOptions struct {
	Host string `json:"host"`
}

LookupMxRecordsOptions struct for LookupMxRecordsOptions

type LookupMxRecordsResults 

type LookupMxRecordsResults struct {
	Records  []DnsLookupResult `json:"records"`
	Errors   []string          `json:"errors"`
	Warnings []string          `json:"warnings"`
}

LookupMxRecordsResults struct for LookupMxRecordsResults

type LookupPtrOptions 

type LookupPtrOptions struct {
	// IPv4 or IPv6 address to inspect
	Ip           string  `json:"ip"`
	CaptchaToken *string `json:"captchaToken,omitempty"`
}

LookupPtrOptions struct for LookupPtrOptions

type LookupPtrResults 

type LookupPtrResults struct {
	Ip                 string   `json:"ip"`
	PtrHostnames       []string `json:"ptrHostnames"`
	ForwardConfirmed   bool     `json:"forwardConfirmed"`
	ForwardARecords    []string `json:"forwardARecords"`
	ForwardAaaaRecords []string `json:"forwardAaaaRecords"`
	Warnings           []string `json:"warnings"`
	Errors             []string `json:"errors"`
}

LookupPtrResults struct for LookupPtrResults

type LookupSpfDomainOptions 

type LookupSpfDomainOptions struct {
	// Root domain to inspect for SPF
	Host string `json:"host"`
}

LookupSpfDomainOptions struct for LookupSpfDomainOptions

type LookupSpfDomainResults 

type LookupSpfDomainResults struct {
	Valid           bool                 `json:"valid"`
	Host            string               `json:"host"`
	Record          string               `json:"record,omitempty"`
	FlattenedRecord string               `json:"flattenedRecord,omitempty"`
	LookupCount     int32                `json:"lookupCount"`
	Mechanisms      []SpfMechanismResult `json:"mechanisms"`
	Warnings        []string             `json:"warnings"`
	Errors          []string             `json:"errors"`
}

LookupSpfDomainResults struct for LookupSpfDomainResults

type LookupTlsReportingDomainOptions 

type LookupTlsReportingDomainOptions struct {
	Host string `json:"host"`
}

LookupTlsReportingDomainOptions struct for LookupTlsReportingDomainOptions

type LookupTlsReportingDomainResults 

type LookupTlsReportingDomainResults struct {
	Valid    bool              `json:"valid"`
	Query    DnsLookupOptions  `json:"query"`
	Records  []DnsLookupResult `json:"records"`
	Errors   []string          `json:"errors"`
	Warnings []string          `json:"warnings"`
}

LookupTlsReportingDomainResults struct for LookupTlsReportingDomainResults

type MFAControllerApiService 

type MFAControllerApiService service

MFAControllerApiService MFAControllerApi service

func (*MFAControllerApiService) CreateTotpDeviceForBase32SecretKey 

func (a *MFAControllerApiService) CreateTotpDeviceForBase32SecretKey(ctx _context.Context, createTotpDeviceBase32SecretKeyOptions CreateTotpDeviceBase32SecretKeyOptions) (TotpDeviceDto, *_nethttp.Response, error)

CreateTotpDeviceForBase32SecretKey Create a TOTP device from an base32 secret key Create a virtual TOTP device for a given secret key. This is usually present as an alternative login option when pairing OTP devices.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createTotpDeviceBase32SecretKeyOptions

@return TotpDeviceDto

func (*MFAControllerApiService) CreateTotpDeviceForCustom 

func (a *MFAControllerApiService) CreateTotpDeviceForCustom(ctx _context.Context, createTotpDeviceCustomOptions CreateTotpDeviceCustomOptions) (TotpDeviceDto, *_nethttp.Response, error)

CreateTotpDeviceForCustom Create a TOTP device from custom options Create a virtual TOTP device for custom options specifying all parameters of the TOTP device.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createTotpDeviceCustomOptions

@return TotpDeviceDto

func (*MFAControllerApiService) CreateTotpDeviceForOtpAuthUrl 

func (a *MFAControllerApiService) CreateTotpDeviceForOtpAuthUrl(ctx _context.Context, createTotpDeviceOtpAuthUrlOptions CreateTotpDeviceOtpAuthUrlOptions) (TotpDeviceDto, *_nethttp.Response, error)

CreateTotpDeviceForOtpAuthUrl Create a TOTP device from an OTP Auth URL Create a virtual TOTP device for a given OTP Auth URL such as otpauth://totp/MyApp:alice@example.com?secret&#x3D;ABC123&amp;issuer&#x3D;MyApp&amp;period&#x3D;30&amp;digits&#x3D;6&amp;algorithm&#x3D;SHA1. You can provider overrides in the options for each component of the URL.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createTotpDeviceOtpAuthUrlOptions

@return TotpDeviceDto

func (*MFAControllerApiService) GetTotpDevice 

func (a *MFAControllerApiService) GetTotpDevice(ctx _context.Context, id string) (TotpDeviceDto, *_nethttp.Response, error)

GetTotpDevice Get a TOTP device by ID Get Time-Based One-Time Password (TOTP) device by its ID.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

@return TotpDeviceDto

func (*MFAControllerApiService) GetTotpDeviceBy 

func (a *MFAControllerApiService) GetTotpDeviceBy(ctx _context.Context, localVarOptionals *GetTotpDeviceByOpts) (TotpDeviceOptionalDto, *_nethttp.Response, error)

GetTotpDeviceBy Get a TOTP device by username, issuer, or name. Returns empty if not found. Get Time-Based One-Time Password (TOTP) device by its username and issuer mapping.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetTotpDeviceByOpts - Optional Parameters:
  • @param "Name" (optional.String) - Optional name filter
  • @param "Issuer" (optional.String) - Optional issuer filter
  • @param "Username" (optional.String) - Optional username filter

@return TotpDeviceOptionalDto

func (*MFAControllerApiService) GetTotpDeviceCode 

func (a *MFAControllerApiService) GetTotpDeviceCode(ctx _context.Context, id string, localVarOptionals *GetTotpDeviceCodeOpts) (TotpDeviceCodeDto, *_nethttp.Response, error)

GetTotpDeviceCode Get a TOTP device code by device ID Get Time-Based One-Time Password for a device by its ID.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of the TOTP device to get the code for
  • @param optional nil or *GetTotpDeviceCodeOpts - Optional Parameters:
  • @param "At" (optional.Time) - Optional time to get code for. If not provided, current time is used.
  • @param "MinSecondsUntilExpire" (optional.Int32) - Optional minimum time until code expires. Will hold thread open until period reached.

@return TotpDeviceCodeDto

type MailServerControllerApiService 

type MailServerControllerApiService service

MailServerControllerApiService MailServerControllerApi service

func (*MailServerControllerApiService) DescribeMailServerDomain 

func (a *MailServerControllerApiService) DescribeMailServerDomain(ctx _context.Context, describeDomainOptions DescribeDomainOptions) (DescribeMailServerDomainResult, *_nethttp.Response, error)

DescribeMailServerDomain Get DNS Mail Server records for a domain

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param describeDomainOptions

@return DescribeMailServerDomainResult

func (*MailServerControllerApiService) GetDnsLookup 

func (a *MailServerControllerApiService) GetDnsLookup(ctx _context.Context, dnsLookupOptions DnsLookupOptions) (DnsLookupResults, *_nethttp.Response, error)

GetDnsLookup Lookup DNS records for a domain

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dnsLookupOptions

@return DnsLookupResults

func (*MailServerControllerApiService) GetDnsLookups 

func (a *MailServerControllerApiService) GetDnsLookups(ctx _context.Context, dnsLookupsOptions DnsLookupsOptions) (DnsLookupResults, *_nethttp.Response, error)

GetDnsLookups Lookup DNS records for multiple domains

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dnsLookupsOptions

@return DnsLookupResults

func (*MailServerControllerApiService) GetIpAddress 

func (a *MailServerControllerApiService) GetIpAddress(ctx _context.Context, name string) (IpAddressResult, *_nethttp.Response, error)

GetIpAddress Get IP address for a domain

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name

@return IpAddressResult

func (*MailServerControllerApiService) VerifyEmailAddress 

func (a *MailServerControllerApiService) VerifyEmailAddress(ctx _context.Context, verifyEmailAddressOptions VerifyEmailAddressOptions) (EmailVerificationResult, *_nethttp.Response, error)

VerifyEmailAddress Deprecated. Use the EmailVerificationController methods for more accurate and reliable functionality. Verify the existence of an email address at a given mail server.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param verifyEmailAddressOptions

@return EmailVerificationResult

type MarkAllAsReadOpts 

type MarkAllAsReadOpts struct {
	Read    optional.Bool
	InboxId optional.Interface
}

MarkAllAsReadOpts Optional parameters for the method 'MarkAllAsRead'

type MarkAllSmsAsReadOpts 

type MarkAllSmsAsReadOpts struct {
	Read          optional.Bool
	PhoneNumberId optional.Interface
}

MarkAllSmsAsReadOpts Optional parameters for the method 'MarkAllSmsAsRead'

type MarkAsReadOpts 

type MarkAsReadOpts struct {
	Read optional.Bool
}

MarkAsReadOpts Optional parameters for the method 'MarkAsRead'

type MarkSmsAsReadOpts 

type MarkSmsAsReadOpts struct {
	Read optional.Bool
}

MarkSmsAsReadOpts Optional parameters for the method 'MarkSmsAsRead'

type MatchOption 

type MatchOption struct {
	// Fields of an email object that can be used to filter results
	Field string `json:"field"`
	// How the value of the email field specified should be compared to the value given in the match options.
	Should string `json:"should"`
	// The value you wish to compare with the value of the field specified using the `should` value passed. For example `BODY` should `CONTAIN` a value passed.
	Value string `json:"value"`
}

MatchOption Options for matching emails in an inbox. Each match option object contains a `field`, `should` and `value` property. Together they form logical conditions such as `SUBJECT` should `CONTAIN` value.

type MatchOptions 

type MatchOptions struct {
	// Zero or more match options such as `{ field: 'SUBJECT', should: 'CONTAIN', value: 'Welcome' }`. Options are additive so if one does not match the email is excluded from results
	Matches *[]MatchOption `json:"matches,omitempty"`
	// Zero or more conditions such as `{ condition: 'HAS_ATTACHMENTS', value: 'TRUE' }`. Note the values are the strings `TRUE|FALSE` not booleans.
	Conditions *[]ConditionOption `json:"conditions,omitempty"`
}

MatchOptions Optional filter for matching emails based on fields. For instance filter results to only include emails whose `SUBJECT` value does `CONTAIN` given match value. An example payload would be `{ matches: [{ field: 'SUBJECT', should: 'CONTAIN', value: 'Welcome' }] }`. You can also pass conditions such as `HAS_ATTACHMENT`. If you wish to extract regex matches inside the email content see the `getEmailContentMatch` method in the EmailController.

type MissedEmailControllerApiService 

type MissedEmailControllerApiService service

MissedEmailControllerApiService MissedEmailControllerApi service

func (*MissedEmailControllerApiService) GetAllMissedEmails 

func (a *MissedEmailControllerApiService) GetAllMissedEmails(ctx _context.Context, localVarOptionals *GetAllMissedEmailsOpts) (PageMissedEmailProjection, *_nethttp.Response, error)

GetAllMissedEmails Get all MissedEmails in paginated format

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAllMissedEmailsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size in list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "SearchFilter" (optional.String) - Optional search filter
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp
  • @param "InboxId" (optional.Interface of string) - Optional inbox ID filter

@return PageMissedEmailProjection

func (*MissedEmailControllerApiService) GetAllUnknownMissedEmails 

func (a *MissedEmailControllerApiService) GetAllUnknownMissedEmails(ctx _context.Context, localVarOptionals *GetAllUnknownMissedEmailsOpts) (PageUnknownMissedEmailProjection, *_nethttp.Response, error)

GetAllUnknownMissedEmails Get all unknown missed emails in paginated format Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAllUnknownMissedEmailsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size in list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "SearchFilter" (optional.String) - Optional search filter
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp
  • @param "InboxId" (optional.Interface of string) - Optional inbox ID filter

@return PageUnknownMissedEmailProjection

func (*MissedEmailControllerApiService) GetMissedEmail 

func (a *MissedEmailControllerApiService) GetMissedEmail(ctx _context.Context, missedEmailId string) (MissedEmailDto, *_nethttp.Response, error)

GetMissedEmail Get MissedEmail List emails that were missed due to plan limits.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param missedEmailId

@return MissedEmailDto

func (*MissedEmailControllerApiService) RestoreMissedEmails 

func (a *MissedEmailControllerApiService) RestoreMissedEmails(ctx _context.Context) (*_nethttp.Response, error)

RestoreMissedEmails Restore missed emails If emails were missed due to a plan limit they are saved as missed emails. If support team enables the canRestore flag these emails can be reload into your account using this method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*MissedEmailControllerApiService) WaitForNthMissedEmail 

func (a *MissedEmailControllerApiService) WaitForNthMissedEmail(ctx _context.Context, index int32, localVarOptionals *WaitForNthMissedEmailOpts) (MissedEmailDto, *_nethttp.Response, error)

WaitForNthMissedEmail Wait for Nth missed email Wait for 0 based index missed email

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param index Zero based index of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass index=1
  • @param optional nil or *WaitForNthMissedEmailOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Optional inbox ID filter
  • @param "Timeout" (optional.Int64) - Optional timeout milliseconds
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return MissedEmailDto

type MissedEmailDto 

type MissedEmailDto struct {
	Id              string  `json:"id"`
	UserId          *string `json:"userId,omitempty"`
	Subject         *string `json:"subject,omitempty"`
	BodyExcerpt     *string `json:"bodyExcerpt,omitempty"`
	AttachmentCount int32   `json:"attachmentCount"`
	From            *string `json:"from,omitempty"`
	// use raw key and raw bucket
	RawUrl     *string   `json:"rawUrl,omitempty"`
	RawKey     *string   `json:"rawKey,omitempty"`
	RawBucket  *string   `json:"rawBucket,omitempty"`
	CanRestore *bool     `json:"canRestore,omitempty"`
	To         []string  `json:"to"`
	Cc         []string  `json:"cc"`
	Bcc        []string  `json:"bcc"`
	InboxIds   []string  `json:"inboxIds"`
	CreatedAt  time.Time `json:"createdAt"`
	UpdatedAt  time.Time `json:"updatedAt"`
}

MissedEmailDto Missed email

type MissedEmailProjection 

type MissedEmailProjection struct {
	Id        string    `json:"id"`
	From      *string   `json:"from,omitempty"`
	Subject   *string   `json:"subject,omitempty"`
	UserId    *string   `json:"userId,omitempty"`
	CreatedAt time.Time `json:"createdAt"`
}

MissedEmailProjection Missed email data

type MissedSmsControllerApiService 

type MissedSmsControllerApiService service

MissedSmsControllerApiService MissedSmsControllerApi service

func (*MissedSmsControllerApiService) GetAllMissedSmsMessages 

func (a *MissedSmsControllerApiService) GetAllMissedSmsMessages(ctx _context.Context, localVarOptionals *GetAllMissedSmsMessagesOpts) (PageMissedSmsProjection, *_nethttp.Response, error)

GetAllMissedSmsMessages Get all missed SMS messages in paginated format

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAllMissedSmsMessagesOpts - Optional Parameters:
  • @param "PhoneNumber" (optional.Interface of string) - Optional receiving phone number to filter missed SMS for
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size in list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Optional filter missed SMS after given date time
  • @param "Before" (optional.Time) - Optional filter missed SMS before given date time
  • @param "Search" (optional.String) - Optional search filter

@return PageMissedSmsProjection

func (*MissedSmsControllerApiService) GetMissedSmsCount 

func (a *MissedSmsControllerApiService) GetMissedSmsCount(ctx _context.Context) (CountDto, *_nethttp.Response, error)

GetMissedSmsCount Get missed SMS count

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return CountDto

func (*MissedSmsControllerApiService) GetMissedSmsMessage 

func (a *MissedSmsControllerApiService) GetMissedSmsMessage(ctx _context.Context, missedSmsId string) (MissedSmsDto, *_nethttp.Response, error)

GetMissedSmsMessage Get missed SMS content Returns a missed SMS with full content.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param missedSmsId

@return MissedSmsDto

type MissedSmsDto 

type MissedSmsDto struct {
	Id          string    `json:"id"`
	UserId      string    `json:"userId"`
	PhoneNumber string    `json:"phoneNumber"`
	FromNumber  string    `json:"fromNumber"`
	ToNumber    *string   `json:"toNumber,omitempty"`
	Body        string    `json:"body"`
	Sid         string    `json:"sid"`
	CreatedAt   time.Time `json:"createdAt"`
	UpdatedAt   time.Time `json:"updatedAt"`
}

MissedSmsDto Missed SMS

type MissedSmsProjection 

type MissedSmsProjection struct {
	Id          string    `json:"id"`
	UserId      string    `json:"userId"`
	CreatedAt   time.Time `json:"createdAt"`
	PhoneNumber string    `json:"phoneNumber"`
	Sid         string    `json:"sid"`
	FromNumber  string    `json:"fromNumber"`
}

MissedSmsProjection Missed SMS projection

type NameServerRecord 

type NameServerRecord struct {
	Raw        string `json:"raw"`
	RecordType string `json:"recordType"`
	Priority   string `json:"priority"`
	Value      string `json:"value"`
}

NameServerRecord Name Server Record

type NewFakeEmailAddressResult 

type NewFakeEmailAddressResult struct {
	EmailAddress string `json:"emailAddress"`
}

NewFakeEmailAddressResult struct for NewFakeEmailAddressResult

type OptInConsentOptions 

type OptInConsentOptions struct {
	EmailAddress     string                       `json:"emailAddress"`
	CompanyName      string                       `json:"companyName,omitempty"`
	SendOptInOptions SendOptInConsentEmailOptions `json:"sendOptInOptions,omitempty"`
}

OptInConsentOptions struct for OptInConsentOptions

type OptInConsentSendResult 

type OptInConsentSendResult struct {
	Sent bool `json:"sent"`
}

OptInConsentSendResult struct for OptInConsentSendResult

type OptInIdentityProjection 

type OptInIdentityProjection struct {
	Id           string    `json:"id"`
	Verified     bool      `json:"verified,omitempty"`
	EmailAddress string    `json:"emailAddress"`
	UpdatedAt    time.Time `json:"updatedAt"`
	CreatedAt    time.Time `json:"createdAt"`
}

OptInIdentityProjection struct for OptInIdentityProjection

type OptInSendingConsentDto 

type OptInSendingConsentDto struct {
	VerificationCodeSent bool `json:"verificationCodeSent"`
	UserHasConsented     bool `json:"userHasConsented"`
	CanSend              bool `json:"canSend"`
}

OptInSendingConsentDto struct for OptInSendingConsentDto

type OptionalConnectorDto 

type OptionalConnectorDto struct {
	Present bool         `json:"present"`
	Result  ConnectorDto `json:"result,omitempty"`
}

OptionalConnectorDto struct for OptionalConnectorDto

type OptionalConnectorImapConnectionDto 

type OptionalConnectorImapConnectionDto struct {
	Present bool                       `json:"present"`
	Result  ConnectorImapConnectionDto `json:"result,omitempty"`
}

OptionalConnectorImapConnectionDto struct for OptionalConnectorImapConnectionDto

type OptionalConnectorSmtpConnectionDto 

type OptionalConnectorSmtpConnectionDto struct {
	Present bool                       `json:"present"`
	Result  ConnectorSmtpConnectionDto `json:"result,omitempty"`
}

OptionalConnectorSmtpConnectionDto struct for OptionalConnectorSmtpConnectionDto

type OptionalConnectorSyncSettingsDto 

type OptionalConnectorSyncSettingsDto struct {
	Present bool                     `json:"present"`
	Result  ConnectorSyncSettingsDto `json:"result,omitempty"`
}

OptionalConnectorSyncSettingsDto struct for OptionalConnectorSyncSettingsDto

type OrganizationInboxProjection 

type OrganizationInboxProjection struct {
	// ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox and Email Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox Controller methods `waitForLatestEmail` and `getEmails` methods respectively. Inboxes can be used with aliases to forward emails automatically.
	Id string `json:"id"`
	// ID of custom domain used by the inbox if any
	DomainId *string `json:"domainId,omitempty"`
	// When the inbox was created. Time stamps are in ISO DateTime Format `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` e.g. `2000-10-31T01:30:00.000-05:00`.
	CreatedAt time.Time `json:"createdAt"`
	// Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search
	Name *string `json:"name,omitempty"`
	// The inbox's email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so `+123` additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
	EmailAddress *string `json:"emailAddress"`
	// Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering
	Favourite bool `json:"favourite"`
	// Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
	Tags *[]string `json:"tags,omitempty"`
	// Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it. See the team access guide at https://www.mailslurp.com/guides/team-email-account-sharing/
	TeamAccess bool `json:"teamAccess"`
	// Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).
	InboxType *string `json:"inboxType,omitempty"`
	// Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes.
	ReadOnly bool `json:"readOnly"`
	// Virtual inbox can receive email but will not send emails to real recipients. Will save sent email record but never send an actual email. Perfect for testing mail server actions.
	VirtualInbox bool `json:"virtualInbox"`
	// Inbox function if used as a primitive for another system.
	FunctionsAs *string `json:"functionsAs,omitempty"`
	// ID of user that inbox belongs to
	UserId string `json:"userId"`
	// Description of an inbox for labelling and searching purposes
	Description *string `json:"description,omitempty"`
	// Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email.
	ExpiresAt *time.Time `json:"expiresAt,omitempty"`
	// Region of the inbox
	AccountRegion *string `json:"accountRegion,omitempty"`
}

OrganizationInboxProjection Organization team inbox

type PageAiTransformMappingProjection 

type PageAiTransformMappingProjection struct {
	Content          []AiTransformMappingProjection `json:"content,omitempty"`
	Pageable         PageableObject                 `json:"pageable,omitempty"`
	TotalPages       int32                          `json:"totalPages"`
	TotalElements    int64                          `json:"totalElements"`
	Last             bool                           `json:"last,omitempty"`
	Size             int32                          `json:"size,omitempty"`
	Number           int32                          `json:"number,omitempty"`
	NumberOfElements int32                          `json:"numberOfElements,omitempty"`
	Sort             SortObject                     `json:"sort,omitempty"`
	First            bool                           `json:"first,omitempty"`
	Empty            bool                           `json:"empty,omitempty"`
}

PageAiTransformMappingProjection Paginated AI Transform mapping entities. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageAiTransformProjection 

type PageAiTransformProjection struct {
	Content          []AiTransformProjection `json:"content,omitempty"`
	Pageable         PageableObject          `json:"pageable,omitempty"`
	TotalPages       int32                   `json:"totalPages"`
	TotalElements    int64                   `json:"totalElements"`
	Last             bool                    `json:"last,omitempty"`
	Size             int32                   `json:"size,omitempty"`
	Number           int32                   `json:"number,omitempty"`
	NumberOfElements int32                   `json:"numberOfElements,omitempty"`
	Sort             SortObject              `json:"sort,omitempty"`
	First            bool                    `json:"first,omitempty"`
	Empty            bool                    `json:"empty,omitempty"`
}

PageAiTransformProjection Paginated AI Transform entity. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageAiTransformResultProjection 

type PageAiTransformResultProjection struct {
	Content          []AiTransformResultProjectionDto `json:"content,omitempty"`
	Pageable         PageableObject                   `json:"pageable,omitempty"`
	Columns          []string                         `json:"columns"`
	TotalPages       int32                            `json:"totalPages"`
	TotalElements    int64                            `json:"totalElements"`
	Last             bool                             `json:"last,omitempty"`
	Size             int32                            `json:"size,omitempty"`
	Number           int32                            `json:"number,omitempty"`
	NumberOfElements int32                            `json:"numberOfElements,omitempty"`
	Sort             SortObject                       `json:"sort,omitempty"`
	First            bool                             `json:"first,omitempty"`
	Empty            bool                             `json:"empty,omitempty"`
}

PageAiTransformResultProjection Paginated AI Transform result entities. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageAlias 

type PageAlias struct {
	Content          []AliasProjection `json:"content,omitempty"`
	Pageable         PageableObject    `json:"pageable,omitempty"`
	TotalPages       int32             `json:"totalPages"`
	TotalElements    int64             `json:"totalElements"`
	Last             bool              `json:"last,omitempty"`
	Size             int32             `json:"size,omitempty"`
	Number           int32             `json:"number,omitempty"`
	NumberOfElements int32             `json:"numberOfElements,omitempty"`
	Sort             SortObject        `json:"sort,omitempty"`
	First            bool              `json:"first,omitempty"`
	Empty            bool              `json:"empty,omitempty"`
}

PageAlias Paginated email alias results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageAliasThreadProjection 

type PageAliasThreadProjection struct {
	Content          []AliasThreadProjection `json:"content,omitempty"`
	Pageable         PageableObject          `json:"pageable,omitempty"`
	TotalPages       int32                   `json:"totalPages"`
	TotalElements    int64                   `json:"totalElements"`
	Last             bool                    `json:"last,omitempty"`
	Size             int32                   `json:"size,omitempty"`
	Number           int32                   `json:"number,omitempty"`
	NumberOfElements int32                   `json:"numberOfElements,omitempty"`
	Sort             SortObject              `json:"sort,omitempty"`
	First            bool                    `json:"first,omitempty"`
	Empty            bool                    `json:"empty,omitempty"`
}

PageAliasThreadProjection Paginated alias thread projection results.

type PageAttachmentEntity 

type PageAttachmentEntity struct {
	Content          []AttachmentProjection `json:"content,omitempty"`
	Pageable         PageableObject         `json:"pageable,omitempty"`
	TotalPages       int32                  `json:"totalPages"`
	TotalElements    int64                  `json:"totalElements"`
	Last             bool                   `json:"last,omitempty"`
	Size             int32                  `json:"size,omitempty"`
	Number           int32                  `json:"number,omitempty"`
	NumberOfElements int32                  `json:"numberOfElements,omitempty"`
	Sort             SortObject             `json:"sort,omitempty"`
	First            bool                   `json:"first,omitempty"`
	Empty            bool                   `json:"empty,omitempty"`
}

PageAttachmentEntity Paginated attachment entity results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageBouncedEmail 

type PageBouncedEmail struct {
	Content          []BounceProjection `json:"content,omitempty"`
	Pageable         PageableObject     `json:"pageable,omitempty"`
	TotalPages       int32              `json:"totalPages"`
	TotalElements    int64              `json:"totalElements"`
	Last             bool               `json:"last,omitempty"`
	Size             int32              `json:"size,omitempty"`
	Number           int32              `json:"number,omitempty"`
	NumberOfElements int32              `json:"numberOfElements,omitempty"`
	Sort             SortObject         `json:"sort,omitempty"`
	First            bool               `json:"first,omitempty"`
	Empty            bool               `json:"empty,omitempty"`
}

PageBouncedEmail Paginated bounced email. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageBouncedRecipients 

type PageBouncedRecipients struct {
	Content          []BounceRecipientProjection `json:"content,omitempty"`
	Pageable         PageableObject              `json:"pageable,omitempty"`
	TotalPages       int32                       `json:"totalPages"`
	TotalElements    int64                       `json:"totalElements"`
	Last             bool                        `json:"last,omitempty"`
	Size             int32                       `json:"size,omitempty"`
	Number           int32                       `json:"number,omitempty"`
	NumberOfElements int32                       `json:"numberOfElements,omitempty"`
	Sort             SortObject                  `json:"sort,omitempty"`
	First            bool                        `json:"first,omitempty"`
	Empty            bool                        `json:"empty,omitempty"`
}

PageBouncedRecipients Paginated bounced recipients. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageComplaint 

type PageComplaint struct {
	Content          []Complaint    `json:"content,omitempty"`
	Pageable         PageableObject `json:"pageable,omitempty"`
	TotalPages       int32          `json:"totalPages"`
	TotalElements    int64          `json:"totalElements"`
	Last             bool           `json:"last,omitempty"`
	Size             int32          `json:"size,omitempty"`
	Number           int32          `json:"number,omitempty"`
	NumberOfElements int32          `json:"numberOfElements,omitempty"`
	Sort             SortObject     `json:"sort,omitempty"`
	First            bool           `json:"first,omitempty"`
	Empty            bool           `json:"empty,omitempty"`
}

PageComplaint Paginated complaint email. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageConnector 

type PageConnector struct {
	Content          []ConnectorProjection `json:"content,omitempty"`
	Pageable         PageableObject        `json:"pageable,omitempty"`
	TotalPages       int32                 `json:"totalPages"`
	TotalElements    int64                 `json:"totalElements"`
	Last             bool                  `json:"last,omitempty"`
	Size             int32                 `json:"size,omitempty"`
	Number           int32                 `json:"number,omitempty"`
	NumberOfElements int32                 `json:"numberOfElements,omitempty"`
	Sort             SortObject            `json:"sort,omitempty"`
	First            bool                  `json:"first,omitempty"`
	Empty            bool                  `json:"empty,omitempty"`
}

PageConnector Paginated inbox connectors. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageConnectorEvents 

type PageConnectorEvents struct {
	Content          []ConnectorEventProjection `json:"content,omitempty"`
	Pageable         PageableObject             `json:"pageable,omitempty"`
	TotalPages       int32                      `json:"totalPages"`
	TotalElements    int64                      `json:"totalElements"`
	Last             bool                       `json:"last,omitempty"`
	Size             int32                      `json:"size,omitempty"`
	Number           int32                      `json:"number,omitempty"`
	NumberOfElements int32                      `json:"numberOfElements,omitempty"`
	Sort             SortObject                 `json:"sort,omitempty"`
	First            bool                       `json:"first,omitempty"`
	Empty            bool                       `json:"empty,omitempty"`
}

PageConnectorEvents Paginated inbox connector events. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageContactProjection 

type PageContactProjection struct {
	Content          []ContactProjection `json:"content,omitempty"`
	Pageable         PageableObject      `json:"pageable,omitempty"`
	TotalPages       int32               `json:"totalPages"`
	TotalElements    int64               `json:"totalElements"`
	Last             bool                `json:"last,omitempty"`
	Size             int32               `json:"size,omitempty"`
	Number           int32               `json:"number,omitempty"`
	NumberOfElements int32               `json:"numberOfElements,omitempty"`
	Sort             SortObject          `json:"sort,omitempty"`
	First            bool                `json:"first,omitempty"`
	Empty            bool                `json:"empty,omitempty"`
}

PageContactProjection Paginated contact results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageDeliveryStatus 

type PageDeliveryStatus struct {
	Content          []DeliveryStatusDto `json:"content,omitempty"`
	Pageable         PageableObject      `json:"pageable,omitempty"`
	TotalPages       int32               `json:"totalPages"`
	TotalElements    int64               `json:"totalElements"`
	Last             bool                `json:"last,omitempty"`
	Size             int32               `json:"size,omitempty"`
	Number           int32               `json:"number,omitempty"`
	NumberOfElements int32               `json:"numberOfElements,omitempty"`
	Sort             SortObject          `json:"sort,omitempty"`
	First            bool                `json:"first,omitempty"`
	Empty            bool                `json:"empty,omitempty"`
}

PageDeliveryStatus Paginated delivery status results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageDevicePreviewRunProjection 

type PageDevicePreviewRunProjection struct {
	Content          []DevicePreviewRunDto `json:"content,omitempty"`
	Pageable         PageableObject        `json:"pageable,omitempty"`
	TotalPages       int32                 `json:"totalPages"`
	TotalElements    int64                 `json:"totalElements"`
	Last             bool                  `json:"last,omitempty"`
	Size             int32                 `json:"size,omitempty"`
	Number           int32                 `json:"number,omitempty"`
	NumberOfElements int32                 `json:"numberOfElements,omitempty"`
	Sort             SortObject            `json:"sort,omitempty"`
	First            bool                  `json:"first,omitempty"`
	Empty            bool                  `json:"empty,omitempty"`
}

PageDevicePreviewRunProjection Paginated device preview run results. Page index starts at zero. Use runId for detailed status, provider progress, and screenshots.

type PageEmailPreview 

type PageEmailPreview struct {
	Content          []EmailPreview `json:"content,omitempty"`
	Pageable         PageableObject `json:"pageable,omitempty"`
	TotalPages       int32          `json:"totalPages"`
	TotalElements    int64          `json:"totalElements"`
	Last             bool           `json:"last,omitempty"`
	Size             int32          `json:"size,omitempty"`
	Number           int32          `json:"number,omitempty"`
	NumberOfElements int32          `json:"numberOfElements,omitempty"`
	Sort             SortObject     `json:"sort,omitempty"`
	First            bool           `json:"first,omitempty"`
	Empty            bool           `json:"empty,omitempty"`
}

PageEmailPreview Paginated email preview results. EmailProjections and EmailPreviews are essentially the same but have legacy naming issues. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. For emails there are several methods for fetching message bodies and attachments.

type PageEmailProjection 

type PageEmailProjection struct {
	Content          []EmailProjection `json:"content,omitempty"`
	Pageable         PageableObject    `json:"pageable,omitempty"`
	TotalPages       int32             `json:"totalPages"`
	TotalElements    int64             `json:"totalElements"`
	Last             bool              `json:"last,omitempty"`
	Size             int32             `json:"size,omitempty"`
	Number           int32             `json:"number,omitempty"`
	NumberOfElements int32             `json:"numberOfElements,omitempty"`
	Sort             SortObject        `json:"sort,omitempty"`
	First            bool              `json:"first,omitempty"`
	Empty            bool              `json:"empty,omitempty"`
}

PageEmailProjection Paginated email projection results. EmailProjections and EmailPreviews are essentially the same but have legacy naming issues. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full email entity use the projection ID with individual method calls. For emails there are several methods for fetching message bodies and attachments.

type PageEmailThreadProjection 

type PageEmailThreadProjection struct {
	Content          []EmailThreadProjection `json:"content,omitempty"`
	Pageable         PageableObject          `json:"pageable,omitempty"`
	TotalPages       int32                   `json:"totalPages"`
	TotalElements    int64                   `json:"totalElements"`
	Last             bool                    `json:"last,omitempty"`
	Size             int32                   `json:"size,omitempty"`
	Number           int32                   `json:"number,omitempty"`
	NumberOfElements int32                   `json:"numberOfElements,omitempty"`
	Sort             SortObject              `json:"sort,omitempty"`
	First            bool                    `json:"first,omitempty"`
	Empty            bool                    `json:"empty,omitempty"`
}

PageEmailThreadProjection Paginated email thread projection results.

type PageEmailValidationRequest 

type PageEmailValidationRequest struct {
	Content          []EmailValidationRequestDto `json:"content,omitempty"`
	Pageable         PageableObject              `json:"pageable,omitempty"`
	TotalPages       int32                       `json:"totalPages"`
	TotalElements    int64                       `json:"totalElements"`
	Last             bool                        `json:"last,omitempty"`
	Size             int32                       `json:"size,omitempty"`
	Number           int32                       `json:"number,omitempty"`
	NumberOfElements int32                       `json:"numberOfElements,omitempty"`
	Sort             SortObject                  `json:"sort,omitempty"`
	First            bool                        `json:"first,omitempty"`
	Empty            bool                        `json:"empty,omitempty"`
}

PageEmailValidationRequest Paginated email validation request records. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageEntityAutomationItems 

type PageEntityAutomationItems struct {
	Content          []EntityAutomationItemProjection `json:"content,omitempty"`
	Pageable         PageableObject                   `json:"pageable,omitempty"`
	TotalPages       int32                            `json:"totalPages"`
	TotalElements    int64                            `json:"totalElements"`
	Last             bool                             `json:"last,omitempty"`
	Size             int32                            `json:"size,omitempty"`
	Number           int32                            `json:"number,omitempty"`
	NumberOfElements int32                            `json:"numberOfElements,omitempty"`
	Sort             SortObject                       `json:"sort,omitempty"`
	First            bool                             `json:"first,omitempty"`
	Empty            bool                             `json:"empty,omitempty"`
}

PageEntityAutomationItems Paginated automation items like auto-repliers, forwarders, and rulesets. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageEntityEventItems 

type PageEntityEventItems struct {
	Content          []EntityEventItemProjection `json:"content,omitempty"`
	Pageable         PageableObject              `json:"pageable,omitempty"`
	TotalPages       int32                       `json:"totalPages"`
	TotalElements    int64                       `json:"totalElements"`
	Last             bool                        `json:"last,omitempty"`
	Size             int32                       `json:"size,omitempty"`
	Number           int32                       `json:"number,omitempty"`
	NumberOfElements int32                       `json:"numberOfElements,omitempty"`
	Sort             SortObject                  `json:"sort,omitempty"`
	First            bool                        `json:"first,omitempty"`
	Empty            bool                        `json:"empty,omitempty"`
}

PageEntityEventItems Paginated event items like webhook events and forwarding. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageEntityFavouriteItems 

type PageEntityFavouriteItems struct {
	Content          []EntityFavouriteItemProjection `json:"content,omitempty"`
	Pageable         PageableObject                  `json:"pageable,omitempty"`
	TotalPages       int32                           `json:"totalPages"`
	TotalElements    int64                           `json:"totalElements"`
	Last             bool                            `json:"last,omitempty"`
	Size             int32                           `json:"size,omitempty"`
	Number           int32                           `json:"number,omitempty"`
	NumberOfElements int32                           `json:"numberOfElements,omitempty"`
	Sort             SortObject                      `json:"sort,omitempty"`
	First            bool                            `json:"first,omitempty"`
	Empty            bool                            `json:"empty,omitempty"`
}

PageEntityFavouriteItems Paginated favourite items like inboxes, phones, sms, emails. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageExpiredInboxRecordProjection 

type PageExpiredInboxRecordProjection struct {
	Content          []ExpiredInboxRecordProjection `json:"content,omitempty"`
	Pageable         PageableObject                 `json:"pageable,omitempty"`
	TotalPages       int32                          `json:"totalPages"`
	TotalElements    int64                          `json:"totalElements"`
	Last             bool                           `json:"last,omitempty"`
	Size             int32                          `json:"size,omitempty"`
	Number           int32                          `json:"number,omitempty"`
	NumberOfElements int32                          `json:"numberOfElements,omitempty"`
	Sort             SortObject                     `json:"sort,omitempty"`
	First            bool                           `json:"first,omitempty"`
	Empty            bool                           `json:"empty,omitempty"`
}

PageExpiredInboxRecordProjection Paginated expired inbox results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageGroupProjection 

type PageGroupProjection struct {
	Content          []GroupProjection `json:"content,omitempty"`
	Pageable         PageableObject    `json:"pageable,omitempty"`
	TotalPages       int32             `json:"totalPages"`
	TotalElements    int64             `json:"totalElements"`
	Last             bool              `json:"last,omitempty"`
	Size             int32             `json:"size,omitempty"`
	Number           int32             `json:"number,omitempty"`
	NumberOfElements int32             `json:"numberOfElements,omitempty"`
	Sort             SortObject        `json:"sort,omitempty"`
	First            bool              `json:"first,omitempty"`
	Empty            bool              `json:"empty,omitempty"`
}

PageGroupProjection Paginated missed email results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageGuestPortalUsers 

type PageGuestPortalUsers struct {
	Content          []GuestPortalUserProjection `json:"content,omitempty"`
	Pageable         PageableObject              `json:"pageable,omitempty"`
	TotalPages       int32                       `json:"totalPages"`
	TotalElements    int64                       `json:"totalElements"`
	Last             bool                        `json:"last,omitempty"`
	Size             int32                       `json:"size,omitempty"`
	Number           int32                       `json:"number,omitempty"`
	NumberOfElements int32                       `json:"numberOfElements,omitempty"`
	Sort             SortObject                  `json:"sort,omitempty"`
	First            bool                        `json:"first,omitempty"`
	Empty            bool                        `json:"empty,omitempty"`
}

PageGuestPortalUsers Paginated guest portal users

type PageInboxForwarderDto 

type PageInboxForwarderDto struct {
	Content          []InboxForwarderDto `json:"content,omitempty"`
	Pageable         PageableObject      `json:"pageable,omitempty"`
	TotalPages       int32               `json:"totalPages"`
	TotalElements    int64               `json:"totalElements"`
	Last             bool                `json:"last,omitempty"`
	Size             int32               `json:"size,omitempty"`
	Number           int32               `json:"number,omitempty"`
	NumberOfElements int32               `json:"numberOfElements,omitempty"`
	Sort             SortObject          `json:"sort,omitempty"`
	First            bool                `json:"first,omitempty"`
	Empty            bool                `json:"empty,omitempty"`
}

PageInboxForwarderDto Paginated inbox forwarder results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageInboxForwarderEvents 

type PageInboxForwarderEvents struct {
	Content          []InboxForwarderEventProjection `json:"content,omitempty"`
	Pageable         PageableObject                  `json:"pageable,omitempty"`
	TotalPages       int32                           `json:"totalPages"`
	TotalElements    int64                           `json:"totalElements"`
	Last             bool                            `json:"last,omitempty"`
	Size             int32                           `json:"size,omitempty"`
	Number           int32                           `json:"number,omitempty"`
	NumberOfElements int32                           `json:"numberOfElements,omitempty"`
	Sort             SortObject                      `json:"sort,omitempty"`
	First            bool                            `json:"first,omitempty"`
	Empty            bool                            `json:"empty,omitempty"`
}

PageInboxForwarderEvents Paginated inbox forwarder events. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageInboxProjection 

type PageInboxProjection struct {
	Content          []InboxPreview `json:"content,omitempty"`
	Pageable         PageableObject `json:"pageable,omitempty"`
	TotalPages       int32          `json:"totalPages"`
	TotalElements    int64          `json:"totalElements"`
	Last             bool           `json:"last,omitempty"`
	Size             int32          `json:"size,omitempty"`
	Number           int32          `json:"number,omitempty"`
	NumberOfElements int32          `json:"numberOfElements,omitempty"`
	Sort             SortObject     `json:"sort,omitempty"`
	First            bool           `json:"first,omitempty"`
	Empty            bool           `json:"empty,omitempty"`
}

PageInboxProjection Paginated inbox results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageInboxReplierDto 

type PageInboxReplierDto struct {
	Content          []InboxReplierDto `json:"content,omitempty"`
	Pageable         PageableObject    `json:"pageable,omitempty"`
	TotalPages       int32             `json:"totalPages"`
	TotalElements    int64             `json:"totalElements"`
	Last             bool              `json:"last,omitempty"`
	Size             int32             `json:"size,omitempty"`
	Number           int32             `json:"number,omitempty"`
	NumberOfElements int32             `json:"numberOfElements,omitempty"`
	Sort             SortObject        `json:"sort,omitempty"`
	First            bool              `json:"first,omitempty"`
	Empty            bool              `json:"empty,omitempty"`
}

PageInboxReplierDto Paginated inbox replier results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageInboxReplierEvents 

type PageInboxReplierEvents struct {
	Content          []InboxReplierEventProjection `json:"content,omitempty"`
	Pageable         PageableObject                `json:"pageable,omitempty"`
	TotalPages       int32                         `json:"totalPages"`
	TotalElements    int64                         `json:"totalElements"`
	Last             bool                          `json:"last,omitempty"`
	Size             int32                         `json:"size,omitempty"`
	Number           int32                         `json:"number,omitempty"`
	NumberOfElements int32                         `json:"numberOfElements,omitempty"`
	Sort             SortObject                    `json:"sort,omitempty"`
	First            bool                          `json:"first,omitempty"`
	Empty            bool                          `json:"empty,omitempty"`
}

PageInboxReplierEvents Paginated inbox replier events. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageInboxTags 

type PageInboxTags struct {
	Content          []string       `json:"content,omitempty"`
	Pageable         PageableObject `json:"pageable,omitempty"`
	TotalPages       int32          `json:"totalPages"`
	TotalElements    int64          `json:"totalElements"`
	Last             bool           `json:"last,omitempty"`
	Size             int32          `json:"size,omitempty"`
	Number           int32          `json:"number,omitempty"`
	NumberOfElements int32          `json:"numberOfElements,omitempty"`
	Sort             SortObject     `json:"sort,omitempty"`
	First            bool           `json:"first,omitempty"`
	Empty            bool           `json:"empty,omitempty"`
}

PageInboxTags Paginated inbox tags. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageListUnsubscribeRecipients 

type PageListUnsubscribeRecipients struct {
	Content          []ListUnsubscribeRecipientProjection `json:"content,omitempty"`
	Pageable         PageableObject                       `json:"pageable,omitempty"`
	TotalPages       int32                                `json:"totalPages"`
	TotalElements    int64                                `json:"totalElements"`
	Last             bool                                 `json:"last,omitempty"`
	Size             int32                                `json:"size,omitempty"`
	Number           int32                                `json:"number,omitempty"`
	NumberOfElements int32                                `json:"numberOfElements,omitempty"`
	Sort             SortObject                           `json:"sort,omitempty"`
	First            bool                                 `json:"first,omitempty"`
	Empty            bool                                 `json:"empty,omitempty"`
}

PageListUnsubscribeRecipients Paginated list unsubscribe recipients. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageMissedEmailProjection 

type PageMissedEmailProjection struct {
	Content          []MissedEmailProjection `json:"content,omitempty"`
	Pageable         PageableObject          `json:"pageable,omitempty"`
	TotalPages       int32                   `json:"totalPages"`
	TotalElements    int64                   `json:"totalElements"`
	Last             bool                    `json:"last,omitempty"`
	Size             int32                   `json:"size,omitempty"`
	Number           int32                   `json:"number,omitempty"`
	NumberOfElements int32                   `json:"numberOfElements,omitempty"`
	Sort             SortObject              `json:"sort,omitempty"`
	First            bool                    `json:"first,omitempty"`
	Empty            bool                    `json:"empty,omitempty"`
}

PageMissedEmailProjection Paginated MissedEmail results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageMissedSmsProjection 

type PageMissedSmsProjection struct {
	Content          []MissedSmsProjection `json:"content,omitempty"`
	Pageable         PageableObject        `json:"pageable,omitempty"`
	TotalPages       int32                 `json:"totalPages"`
	TotalElements    int64                 `json:"totalElements"`
	Last             bool                  `json:"last,omitempty"`
	Size             int32                 `json:"size,omitempty"`
	Number           int32                 `json:"number,omitempty"`
	NumberOfElements int32                 `json:"numberOfElements,omitempty"`
	Sort             SortObject            `json:"sort,omitempty"`
	First            bool                  `json:"first,omitempty"`
	Empty            bool                  `json:"empty,omitempty"`
}

PageMissedSmsProjection Paginated missed SMS messages. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageOptInIdentityProjection 

type PageOptInIdentityProjection struct {
	Content          []OptInIdentityProjection `json:"content,omitempty"`
	Pageable         PageableObject            `json:"pageable,omitempty"`
	TotalPages       int32                     `json:"totalPages"`
	TotalElements    int64                     `json:"totalElements"`
	Last             bool                      `json:"last,omitempty"`
	Size             int32                     `json:"size,omitempty"`
	Number           int32                     `json:"number,omitempty"`
	NumberOfElements int32                     `json:"numberOfElements,omitempty"`
	Sort             SortObject                `json:"sort,omitempty"`
	First            bool                      `json:"first,omitempty"`
	Empty            bool                      `json:"empty,omitempty"`
}

PageOptInIdentityProjection Paginated opt in identity projections reflecting users who have verified double-opt in consent to receive emails from your account.

type PageOrganizationInboxProjection 

type PageOrganizationInboxProjection struct {
	Content          []OrganizationInboxProjection `json:"content,omitempty"`
	Pageable         PageableObject                `json:"pageable,omitempty"`
	TotalPages       int32                         `json:"totalPages"`
	TotalElements    int64                         `json:"totalElements"`
	Last             bool                          `json:"last,omitempty"`
	Size             int32                         `json:"size,omitempty"`
	Number           int32                         `json:"number,omitempty"`
	NumberOfElements int32                         `json:"numberOfElements,omitempty"`
	Sort             SortObject                    `json:"sort,omitempty"`
	First            bool                          `json:"first,omitempty"`
	Empty            bool                          `json:"empty,omitempty"`
}

PageOrganizationInboxProjection Paginated organization inbox results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PagePhoneMessageThreadItemProjection 

type PagePhoneMessageThreadItemProjection struct {
	Content          []PhoneMessageThreadItemProjection `json:"content,omitempty"`
	Pageable         PageableObject                     `json:"pageable,omitempty"`
	TotalPages       int32                              `json:"totalPages"`
	TotalElements    int64                              `json:"totalElements"`
	Last             bool                               `json:"last,omitempty"`
	Size             int32                              `json:"size,omitempty"`
	Number           int32                              `json:"number,omitempty"`
	NumberOfElements int32                              `json:"numberOfElements,omitempty"`
	Sort             SortObject                         `json:"sort,omitempty"`
	First            bool                               `json:"first,omitempty"`
	Empty            bool                               `json:"empty,omitempty"`
}

PagePhoneMessageThreadItemProjection Paginated phone message thread items. These are messages in a phone thread. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PagePhoneMessageThreadProjection 

type PagePhoneMessageThreadProjection struct {
	Content          []PhoneMessageThreadProjection `json:"content,omitempty"`
	Pageable         PageableObject                 `json:"pageable,omitempty"`
	TotalPages       int32                          `json:"totalPages"`
	TotalElements    int64                          `json:"totalElements"`
	Last             bool                           `json:"last,omitempty"`
	Size             int32                          `json:"size,omitempty"`
	Number           int32                          `json:"number,omitempty"`
	NumberOfElements int32                          `json:"numberOfElements,omitempty"`
	Sort             SortObject                     `json:"sort,omitempty"`
	First            bool                           `json:"first,omitempty"`
	Empty            bool                           `json:"empty,omitempty"`
}

PagePhoneMessageThreadProjection Paginated phone message threads. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PagePhoneNumberProjection 

type PagePhoneNumberProjection struct {
	Content          []PhoneNumberProjection `json:"content,omitempty"`
	Pageable         PageableObject          `json:"pageable,omitempty"`
	TotalPages       int32                   `json:"totalPages"`
	TotalElements    int64                   `json:"totalElements"`
	Last             bool                    `json:"last,omitempty"`
	Size             int32                   `json:"size,omitempty"`
	Number           int32                   `json:"number,omitempty"`
	NumberOfElements int32                   `json:"numberOfElements,omitempty"`
	Sort             SortObject              `json:"sort,omitempty"`
	First            bool                    `json:"first,omitempty"`
	Empty            bool                    `json:"empty,omitempty"`
}

PagePhoneNumberProjection Paginated phone numbers. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PagePhoneNumberReleaseProjection 

type PagePhoneNumberReleaseProjection struct {
	Content          []PhoneNumberReleaseProjection `json:"content,omitempty"`
	Pageable         PageableObject                 `json:"pageable,omitempty"`
	TotalPages       int32                          `json:"totalPages"`
	TotalElements    int64                          `json:"totalElements"`
	Last             bool                           `json:"last,omitempty"`
	Size             int32                          `json:"size,omitempty"`
	Number           int32                          `json:"number,omitempty"`
	NumberOfElements int32                          `json:"numberOfElements,omitempty"`
	Sort             SortObject                     `json:"sort,omitempty"`
	First            bool                           `json:"first,omitempty"`
	Empty            bool                           `json:"empty,omitempty"`
}

PagePhoneNumberReleaseProjection Paginated released phone numbers. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PagePlusAddressProjection 

type PagePlusAddressProjection struct {
	Content          []PlusAddressProjection `json:"content,omitempty"`
	Pageable         PageableObject          `json:"pageable,omitempty"`
	TotalPages       int32                   `json:"totalPages"`
	TotalElements    int64                   `json:"totalElements"`
	Last             bool                    `json:"last,omitempty"`
	Size             int32                   `json:"size,omitempty"`
	Number           int32                   `json:"number,omitempty"`
	NumberOfElements int32                   `json:"numberOfElements,omitempty"`
	Sort             SortObject              `json:"sort,omitempty"`
	First            bool                    `json:"first,omitempty"`
	Empty            bool                    `json:"empty,omitempty"`
}

PagePlusAddressProjection Paginated inbox plus addresses. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageReputationItems 

type PageReputationItems struct {
	Content          []ReputationItemProjection `json:"content,omitempty"`
	Pageable         PageableObject             `json:"pageable,omitempty"`
	TotalPages       int32                      `json:"totalPages"`
	TotalElements    int64                      `json:"totalElements"`
	Last             bool                       `json:"last,omitempty"`
	Size             int32                      `json:"size,omitempty"`
	Number           int32                      `json:"number,omitempty"`
	NumberOfElements int32                      `json:"numberOfElements,omitempty"`
	Sort             SortObject                 `json:"sort,omitempty"`
	First            bool                       `json:"first,omitempty"`
	Empty            bool                       `json:"empty,omitempty"`
}

PageReputationItems Paginated reputation items like complaints and bounces. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageRulesetDto 

type PageRulesetDto struct {
	Content          []RulesetDto   `json:"content,omitempty"`
	Pageable         PageableObject `json:"pageable,omitempty"`
	TotalPages       int32          `json:"totalPages"`
	TotalElements    int64          `json:"totalElements"`
	Last             bool           `json:"last,omitempty"`
	Size             int32          `json:"size,omitempty"`
	Number           int32          `json:"number,omitempty"`
	NumberOfElements int32          `json:"numberOfElements,omitempty"`
	Sort             SortObject     `json:"sort,omitempty"`
	First            bool           `json:"first,omitempty"`
	Empty            bool           `json:"empty,omitempty"`
}

PageRulesetDto Paginated ruleset results to deny or permit inbound or outbound SMS and email. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageScheduledJobs 

type PageScheduledJobs struct {
	Content          []ScheduledJob `json:"content,omitempty"`
	Pageable         PageableObject `json:"pageable,omitempty"`
	TotalPages       int32          `json:"totalPages"`
	TotalElements    int64          `json:"totalElements"`
	Last             bool           `json:"last,omitempty"`
	Size             int32          `json:"size,omitempty"`
	Number           int32          `json:"number,omitempty"`
	NumberOfElements int32          `json:"numberOfElements,omitempty"`
	Sort             SortObject     `json:"sort,omitempty"`
	First            bool           `json:"first,omitempty"`
	Empty            bool           `json:"empty,omitempty"`
}

PageScheduledJobs Paginated scheduled jobs results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageSentEmailProjection 

type PageSentEmailProjection struct {
	Content          []SentEmailProjection `json:"content,omitempty"`
	Pageable         PageableObject        `json:"pageable,omitempty"`
	TotalPages       int32                 `json:"totalPages"`
	TotalElements    int64                 `json:"totalElements"`
	Last             bool                  `json:"last,omitempty"`
	Size             int32                 `json:"size,omitempty"`
	Number           int32                 `json:"number,omitempty"`
	NumberOfElements int32                 `json:"numberOfElements,omitempty"`
	Sort             SortObject            `json:"sort,omitempty"`
	First            bool                  `json:"first,omitempty"`
	Empty            bool                  `json:"empty,omitempty"`
}

PageSentEmailProjection Paginated sent email results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full sent email entity use the projection ID with individual method calls.

type PageSentEmailWithQueueProjection 

type PageSentEmailWithQueueProjection struct {
	Content          []SendWithQueueResult `json:"content,omitempty"`
	Pageable         PageableObject        `json:"pageable,omitempty"`
	TotalPages       int32                 `json:"totalPages"`
	TotalElements    int64                 `json:"totalElements"`
	Last             bool                  `json:"last,omitempty"`
	Size             int32                 `json:"size,omitempty"`
	Number           int32                 `json:"number,omitempty"`
	NumberOfElements int32                 `json:"numberOfElements,omitempty"`
	Sort             SortObject            `json:"sort,omitempty"`
	First            bool                  `json:"first,omitempty"`
	Empty            bool                  `json:"empty,omitempty"`
}

PageSentEmailWithQueueProjection Paginated sent email results for emails sent with queue. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full sent email entity use the projection ID with individual method calls.

type PageSentSmsProjection 

type PageSentSmsProjection struct {
	Content          []SentSmsProjection `json:"content,omitempty"`
	Pageable         PageableObject      `json:"pageable,omitempty"`
	TotalPages       int32               `json:"totalPages"`
	TotalElements    int64               `json:"totalElements"`
	Last             bool                `json:"last,omitempty"`
	Size             int32               `json:"size,omitempty"`
	Number           int32               `json:"number,omitempty"`
	NumberOfElements int32               `json:"numberOfElements,omitempty"`
	Sort             SortObject          `json:"sort,omitempty"`
	First            bool                `json:"first,omitempty"`
	Empty            bool                `json:"empty,omitempty"`
}

PageSentSmsProjection Paginated sent SMS messages. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageSmsProjection 

type PageSmsProjection struct {
	Content          []SmsProjection `json:"content,omitempty"`
	Pageable         PageableObject  `json:"pageable,omitempty"`
	TotalPages       int32           `json:"totalPages"`
	TotalElements    int64           `json:"totalElements"`
	Last             bool            `json:"last,omitempty"`
	Size             int32           `json:"size,omitempty"`
	Number           int32           `json:"number,omitempty"`
	NumberOfElements int32           `json:"numberOfElements,omitempty"`
	Sort             SortObject      `json:"sort,omitempty"`
	First            bool            `json:"first,omitempty"`
	Empty            bool            `json:"empty,omitempty"`
}

PageSmsProjection Paginated SMS messages. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageTableData 

type PageTableData struct {
	Headers    []string   `json:"headers"`
	Rows       [][]string `json:"rows"`
	Pagination Pagination `json:"pagination"`
}

PageTableData struct for PageTableData

type PageTemplateProjection 

type PageTemplateProjection struct {
	Content          []TemplateProjection `json:"content,omitempty"`
	Pageable         PageableObject       `json:"pageable,omitempty"`
	TotalPages       int32                `json:"totalPages"`
	TotalElements    int64                `json:"totalElements"`
	Last             bool                 `json:"last,omitempty"`
	Size             int32                `json:"size,omitempty"`
	Number           int32                `json:"number,omitempty"`
	NumberOfElements int32                `json:"numberOfElements,omitempty"`
	Sort             SortObject           `json:"sort,omitempty"`
	First            bool                 `json:"first,omitempty"`
	Empty            bool                 `json:"empty,omitempty"`
}

PageTemplateProjection Paginated email template results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageTrackingPixelProjection 

type PageTrackingPixelProjection struct {
	Content          []TrackingPixelProjection `json:"content,omitempty"`
	Pageable         PageableObject            `json:"pageable,omitempty"`
	TotalPages       int32                     `json:"totalPages"`
	TotalElements    int64                     `json:"totalElements"`
	Last             bool                      `json:"last,omitempty"`
	Size             int32                     `json:"size,omitempty"`
	Number           int32                     `json:"number,omitempty"`
	NumberOfElements int32                     `json:"numberOfElements,omitempty"`
	Sort             SortObject                `json:"sort,omitempty"`
	First            bool                      `json:"first,omitempty"`
	Empty            bool                      `json:"empty,omitempty"`
}

PageTrackingPixelProjection Paginated TrackingPixel results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageUnknownMissedEmailProjection 

type PageUnknownMissedEmailProjection struct {
	Content          []UnknownMissedEmailProjection `json:"content,omitempty"`
	Pageable         PageableObject                 `json:"pageable,omitempty"`
	TotalPages       int32                          `json:"totalPages"`
	TotalElements    int64                          `json:"totalElements"`
	Last             bool                           `json:"last,omitempty"`
	Size             int32                          `json:"size,omitempty"`
	Number           int32                          `json:"number,omitempty"`
	NumberOfElements int32                          `json:"numberOfElements,omitempty"`
	Sort             SortObject                     `json:"sort,omitempty"`
	First            bool                           `json:"first,omitempty"`
	Empty            bool                           `json:"empty,omitempty"`
}

PageUnknownMissedEmailProjection Paginated unknown MissedEmail results. Unknown missed emails are emails that were sent to MailSlurp /Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageWebhookEndpointProjection 

type PageWebhookEndpointProjection struct {
	Content          []WebhookEndpointProjection `json:"content,omitempty"`
	Pageable         PageableObject              `json:"pageable,omitempty"`
	TotalPages       int32                       `json:"totalPages"`
	TotalElements    int64                       `json:"totalElements"`
	Last             bool                        `json:"last,omitempty"`
	Size             int32                       `json:"size,omitempty"`
	Number           int32                       `json:"number,omitempty"`
	NumberOfElements int32                       `json:"numberOfElements,omitempty"`
	Sort             SortObject                  `json:"sort,omitempty"`
	First            bool                        `json:"first,omitempty"`
	Empty            bool                        `json:"empty,omitempty"`
}

PageWebhookEndpointProjection Paginated webhook endpoint with latest health status. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageWebhookProjection 

type PageWebhookProjection struct {
	Content          []WebhookProjection `json:"content,omitempty"`
	Pageable         PageableObject      `json:"pageable,omitempty"`
	TotalPages       int32               `json:"totalPages"`
	TotalElements    int64               `json:"totalElements"`
	Last             bool                `json:"last,omitempty"`
	Size             int32               `json:"size,omitempty"`
	Number           int32               `json:"number,omitempty"`
	NumberOfElements int32               `json:"numberOfElements,omitempty"`
	Sort             SortObject          `json:"sort,omitempty"`
	First            bool                `json:"first,omitempty"`
	Empty            bool                `json:"empty,omitempty"`
}

PageWebhookProjection Paginated webhook entity. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageWebhookResult 

type PageWebhookResult struct {
	Content          []WebhookResultDto `json:"content,omitempty"`
	Pageable         PageableObject     `json:"pageable,omitempty"`
	TotalPages       int32              `json:"totalPages"`
	TotalElements    int64              `json:"totalElements"`
	Last             bool               `json:"last,omitempty"`
	Size             int32              `json:"size,omitempty"`
	Number           int32              `json:"number,omitempty"`
	NumberOfElements int32              `json:"numberOfElements,omitempty"`
	Sort             SortObject         `json:"sort,omitempty"`
	First            bool               `json:"first,omitempty"`
	Empty            bool               `json:"empty,omitempty"`
}

PageWebhookResult Paginated webhook results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

type PageableObject 

type PageableObject struct {
	Offset     int64      `json:"offset,omitempty"`
	PageSize   int32      `json:"pageSize,omitempty"`
	Sort       SortObject `json:"sort,omitempty"`
	Paged      bool       `json:"paged,omitempty"`
	PageNumber int32      `json:"pageNumber,omitempty"`
	Unpaged    bool       `json:"unpaged,omitempty"`
}

PageableObject struct for PageableObject

type Pagination 

type Pagination struct {
	PageNumber int32 `json:"pageNumber"`
	PageSize   int32 `json:"pageSize"`
}

Pagination struct for Pagination

type PhoneControllerApiService 

type PhoneControllerApiService service

PhoneControllerApiService PhoneControllerApi service

func (*PhoneControllerApiService) AcquirePhonePoolLease 

func (a *PhoneControllerApiService) AcquirePhonePoolLease(ctx _context.Context, poolId string, acquirePhonePoolLeaseOptions AcquirePhonePoolLeaseOptions) (PhonePoolLeaseDto, *_nethttp.Response, error)

AcquirePhonePoolLease Acquire phone pool lease Acquire an available phone number from the pool and mark it leased

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param poolId
  • @param acquirePhonePoolLeaseOptions

@return PhonePoolLeaseDto

func (*PhoneControllerApiService) AddAllPhoneNumbersToPhonePool 

func (a *PhoneControllerApiService) AddAllPhoneNumbersToPhonePool(ctx _context.Context, poolId string) (PhonePoolDetailDto, *_nethttp.Response, error)

AddAllPhoneNumbersToPhonePool Add all phone numbers to phone pool Add all active owned phone numbers to a pool

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param poolId

@return PhonePoolDetailDto

func (*PhoneControllerApiService) AddPhoneNumberTags 

func (a *PhoneControllerApiService) AddPhoneNumberTags(ctx _context.Context, phoneNumberId string, phoneNumberTagsOptions PhoneNumberTagsOptions) (PhoneNumberDto, *_nethttp.Response, error)

AddPhoneNumberTags Add phone number tags Add one or more tags to a phone number

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param phoneNumberId
  • @param phoneNumberTagsOptions

@return PhoneNumberDto

func (*PhoneControllerApiService) AddPhoneNumbersToPhonePool 

func (a *PhoneControllerApiService) AddPhoneNumbersToPhonePool(ctx _context.Context, poolId string, addPhonePoolNumbersOptions AddPhonePoolNumbersOptions) (PhonePoolDetailDto, *_nethttp.Response, error)

AddPhoneNumbersToPhonePool Add phone numbers to phone pool Add one or more owned phone numbers to a pool

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param poolId
  • @param addPhonePoolNumbersOptions

@return PhonePoolDetailDto

func (*PhoneControllerApiService) CreateEmergencyAddress 

func (a *PhoneControllerApiService) CreateEmergencyAddress(ctx _context.Context, createEmergencyAddressOptions CreateEmergencyAddressOptions) (EmergencyAddress, *_nethttp.Response, error)

CreateEmergencyAddress Create an emergency address Add an emergency address to a phone number

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createEmergencyAddressOptions

@return EmergencyAddress

func (*PhoneControllerApiService) CreatePhoneNumber 

func (a *PhoneControllerApiService) CreatePhoneNumber(ctx _context.Context, createPhoneNumberOptions CreatePhoneNumberOptions) (PhoneNumberDto, *_nethttp.Response, error)

CreatePhoneNumber Add phone number to your account. Only works if you have already added a plan and an initial phone number in your account and acknowledged the pricing and terms of service by enabling API phone creation. Create new phone number

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createPhoneNumberOptions

@return PhoneNumberDto

func (*PhoneControllerApiService) CreatePhonePool 

func (a *PhoneControllerApiService) CreatePhonePool(ctx _context.Context, createPhonePoolOptions CreatePhonePoolOptions) (PhonePoolDetailDto, *_nethttp.Response, error)

CreatePhonePool Create phone pool Create a reusable pool of phone numbers for coordinated leasing

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createPhonePoolOptions

@return PhonePoolDetailDto

func (*PhoneControllerApiService) CreatePhoneProvisioningJob 

func (a *PhoneControllerApiService) CreatePhoneProvisioningJob(ctx _context.Context, createPhoneProvisioningJobOptions CreatePhoneProvisioningJobOptions) (PhoneProvisioningJobDto, *_nethttp.Response, error)

CreatePhoneProvisioningJob Create a phone provisioning job Create an advanced phone provisioning job from shortlisted numbers

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createPhoneProvisioningJobOptions

@return PhoneProvisioningJobDto

func (*PhoneControllerApiService) DeleteAllPhoneNumber 

func (a *PhoneControllerApiService) DeleteAllPhoneNumber(ctx _context.Context) (*_nethttp.Response, error)

DeleteAllPhoneNumber Delete all phone numbers Remove all phone number from account

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*PhoneControllerApiService) DeleteEmergencyAddress 

func (a *PhoneControllerApiService) DeleteEmergencyAddress(ctx _context.Context, addressId string) (EmptyResponseDto, *_nethttp.Response, error)

DeleteEmergencyAddress Delete an emergency address Delete an emergency address

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param addressId

@return EmptyResponseDto

func (*PhoneControllerApiService) DeletePhoneMessageThreadItems 

func (a *PhoneControllerApiService) DeletePhoneMessageThreadItems(ctx _context.Context, phoneNumberId string, otherNumber string) (EmptyResponseDto, *_nethttp.Response, error)

DeletePhoneMessageThreadItems Delete messages in a phone thread Delete all messages in an SMS thread

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param phoneNumberId
  • @param otherNumber

@return EmptyResponseDto

func (*PhoneControllerApiService) DeletePhoneNumber 

func (a *PhoneControllerApiService) DeletePhoneNumber(ctx _context.Context, phoneNumberId string) (*_nethttp.Response, error)

DeletePhoneNumber Delete a phone number Remove phone number from account

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param phoneNumberId

func (*PhoneControllerApiService) DeletePhonePool 

func (a *PhoneControllerApiService) DeletePhonePool(ctx _context.Context, poolId string) (*_nethttp.Response, error)

DeletePhonePool Delete phone pool Delete a phone pool and release any active leases from that pool

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param poolId

func (*PhoneControllerApiService) GetAllPhoneMessageThreads 

func (a *PhoneControllerApiService) GetAllPhoneMessageThreads(ctx _context.Context, localVarOptionals *GetAllPhoneMessageThreadsOpts) (PagePhoneMessageThreadProjection, *_nethttp.Response, error)

GetAllPhoneMessageThreads Get the latest messages for all phones List all message threads for all phones

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAllPhoneMessageThreadsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) -
  • @param "Size" (optional.Int32) -

@return PagePhoneMessageThreadProjection

func (*PhoneControllerApiService) GetAllPhoneNumberReleases 

func (a *PhoneControllerApiService) GetAllPhoneNumberReleases(ctx _context.Context, localVarOptionals *GetAllPhoneNumberReleasesOpts) (PagePhoneNumberReleaseProjection, *_nethttp.Response, error)

GetAllPhoneNumberReleases Get all phone number releases List released or deleted phone numbers

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAllPhoneNumberReleasesOpts - Optional Parameters:
  • @param "Page" (optional.Int32) -
  • @param "Size" (optional.Int32) -
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC

@return PagePhoneNumberReleaseProjection

func (*PhoneControllerApiService) GetConsentStatus 

func (a *PhoneControllerApiService) GetConsentStatus(ctx _context.Context) (ConsentStatusDto, *_nethttp.Response, error)

GetConsentStatus Get consent status Get the status of phone usage consent

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ConsentStatusDto

func (*PhoneControllerApiService) GetEmergencyAddress 

func (a *PhoneControllerApiService) GetEmergencyAddress(ctx _context.Context, addressId string) (EmergencyAddress, *_nethttp.Response, error)

GetEmergencyAddress Get an emergency address Fetch an emergency address by ID

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param addressId

@return EmergencyAddress

func (*PhoneControllerApiService) GetEmergencyAddresses 

func (a *PhoneControllerApiService) GetEmergencyAddresses(ctx _context.Context) ([]EmergencyAddressDto, *_nethttp.Response, error)

GetEmergencyAddresses Get emergency addresses List emergency addresses

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []EmergencyAddressDto

func (*PhoneControllerApiService) GetOrCreatePhonePool 

func (a *PhoneControllerApiService) GetOrCreatePhonePool(ctx _context.Context, getOrCreatePhonePoolOptions GetOrCreatePhonePoolOptions) (PhonePoolDetailDto, *_nethttp.Response, error)

GetOrCreatePhonePool Get or create phone pool Get a phone pool by name or create it if it does not exist

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param getOrCreatePhonePoolOptions

@return PhonePoolDetailDto

func (*PhoneControllerApiService) GetPhoneMessageThreadItems 

func (a *PhoneControllerApiService) GetPhoneMessageThreadItems(ctx _context.Context, phoneNumberId string, otherNumber string, localVarOptionals *GetPhoneMessageThreadItemsOpts) (PagePhoneMessageThreadItemProjection, *_nethttp.Response, error)

GetPhoneMessageThreadItems Get messages in a phone thread List message thread messages for a phone message thread

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param phoneNumberId
  • @param otherNumber
  • @param optional nil or *GetPhoneMessageThreadItemsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) -
  • @param "Size" (optional.Int32) -

@return PagePhoneMessageThreadItemProjection

func (*PhoneControllerApiService) GetPhoneMessageThreads 

func (a *PhoneControllerApiService) GetPhoneMessageThreads(ctx _context.Context, phoneNumberId string, localVarOptionals *GetPhoneMessageThreadsOpts) (PagePhoneMessageThreadProjection, *_nethttp.Response, error)

GetPhoneMessageThreads Get the latest message preview for a thread List message threads for a phone

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param phoneNumberId
  • @param optional nil or *GetPhoneMessageThreadsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) -
  • @param "Size" (optional.Int32) -

@return PagePhoneMessageThreadProjection

func (*PhoneControllerApiService) GetPhoneNumber 

func (a *PhoneControllerApiService) GetPhoneNumber(ctx _context.Context, phoneNumberId string) (PhoneNumberDto, *_nethttp.Response, error)

GetPhoneNumber Get a phone number by ID Get a phone number by ID

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param phoneNumberId

@return PhoneNumberDto

func (*PhoneControllerApiService) GetPhoneNumberByName 

func (a *PhoneControllerApiService) GetPhoneNumberByName(ctx _context.Context, name string) (PhoneNumberDto, *_nethttp.Response, error)

GetPhoneNumberByName Get a phone number by name Get a phone number by name

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name

@return PhoneNumberDto

func (*PhoneControllerApiService) GetPhoneNumberByPhoneNumber 

func (a *PhoneControllerApiService) GetPhoneNumberByPhoneNumber(ctx _context.Context, phoneNumber string) (PhoneNumberDto, *_nethttp.Response, error)

GetPhoneNumberByPhoneNumber Get a phone number by phone number Get a phone number by phone number

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param phoneNumber

@return PhoneNumberDto

func (*PhoneControllerApiService) GetPhoneNumberLineTypeIntelligence 

func (a *PhoneControllerApiService) GetPhoneNumberLineTypeIntelligence(ctx _context.Context, validatePhoneNumberOptions ValidatePhoneNumberOptions) (PhoneNumberLineTypeLookupDto, *_nethttp.Response, error)

GetPhoneNumberLineTypeIntelligence Get line type intelligence for a phone number Lookup line type intelligence for a phone number

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param validatePhoneNumberOptions

@return PhoneNumberLineTypeLookupDto

func (*PhoneControllerApiService) GetPhoneNumberRelease 

func (a *PhoneControllerApiService) GetPhoneNumberRelease(ctx _context.Context, releaseId string) (PhoneNumberReleaseProjection, *_nethttp.Response, error)

GetPhoneNumberRelease Get phone number release Get a released or deleted phone numbers

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param releaseId

@return PhoneNumberReleaseProjection

func (*PhoneControllerApiService) GetPhoneNumberTags 

func (a *PhoneControllerApiService) GetPhoneNumberTags(ctx _context.Context, phoneNumberId string) ([]string, *_nethttp.Response, error)

GetPhoneNumberTags Get phone number tags Get tags for a specific phone number

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param phoneNumberId

@return []string

func (*PhoneControllerApiService) GetPhoneNumbers 

func (a *PhoneControllerApiService) GetPhoneNumbers(ctx _context.Context, localVarOptionals *GetPhoneNumbersOpts) (PagePhoneNumberProjection, *_nethttp.Response, error)

GetPhoneNumbers Get phone numbers List phone numbers for account

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetPhoneNumbersOpts - Optional Parameters:
  • @param "PhoneCountry" (optional.String) - Optional phone country
  • @param "LineType" (optional.String) - Optional line type filter
  • @param "CarrierName" (optional.String) - Optional carrier name filter
  • @param "MobileCountryCode" (optional.String) - Optional mobile country code filter
  • @param "MobileNetworkCode" (optional.String) - Optional mobile network code filter
  • @param "ProviderLabel" (optional.String) - Optional provider label filter such as T1 or T2
  • @param "Page" (optional.Int32) - Optional page index for list pagination
  • @param "Size" (optional.Int32) - Optional page size for list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp
  • @param "Search" (optional.String) - Optional search filter
  • @param "Tag" (optional.Interface of []string) - Optional tags to filter by. A phone must include all provided tags
  • @param "Include" (optional.Interface of []string) - Optional phoneIds to include in result
  • @param "Favourite" (optional.Bool) - Optionally filter results for favourites only

@return PagePhoneNumberProjection

func (*PhoneControllerApiService) GetPhonePlans 

func (a *PhoneControllerApiService) GetPhonePlans(ctx _context.Context) ([]PhonePlanDto, *_nethttp.Response, error)

GetPhonePlans Get phone plans Get phone number plans

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []PhonePlanDto

func (*PhoneControllerApiService) GetPhonePlansAvailability 

func (a *PhoneControllerApiService) GetPhonePlansAvailability(ctx _context.Context) (PhonePlanAvailability, *_nethttp.Response, error)

GetPhonePlansAvailability Get phone plans availability

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return PhonePlanAvailability

func (*PhoneControllerApiService) GetPhonePool 

func (a *PhoneControllerApiService) GetPhonePool(ctx _context.Context, poolId string) (PhonePoolDetailDto, *_nethttp.Response, error)

GetPhonePool Get phone pool Get phone pool details by ID

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param poolId

@return PhonePoolDetailDto

func (*PhoneControllerApiService) GetPhonePoolByName 

func (a *PhoneControllerApiService) GetPhonePoolByName(ctx _context.Context, name string) (PhonePoolDetailDto, *_nethttp.Response, error)

GetPhonePoolByName Get phone pool by name Get phone pool details by name

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name

@return PhonePoolDetailDto

func (*PhoneControllerApiService) GetPhonePools 

func (a *PhoneControllerApiService) GetPhonePools(ctx _context.Context) ([]PhonePoolDto, *_nethttp.Response, error)

GetPhonePools Get phone pools List phone pools for the authenticated user

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []PhonePoolDto

func (*PhoneControllerApiService) GetPhoneProvisioningCapabilities 

func (a *PhoneControllerApiService) GetPhoneProvisioningCapabilities(ctx _context.Context, phoneCountry string, localVarOptionals *GetPhoneProvisioningCapabilitiesOpts) (PhoneProviderCapabilitiesResult, *_nethttp.Response, error)

GetPhoneProvisioningCapabilities Get phone provisioning capabilities Get supported provider-country variant capabilities for advanced provisioning

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param phoneCountry
  • @param optional nil or *GetPhoneProvisioningCapabilitiesOpts - Optional Parameters:
  • @param "ProviderLabel" (optional.String) -

@return PhoneProviderCapabilitiesResult

func (*PhoneControllerApiService) GetPhoneProvisioningJob 

func (a *PhoneControllerApiService) GetPhoneProvisioningJob(ctx _context.Context, jobId string) (PhoneProvisioningJobDto, *_nethttp.Response, error)

GetPhoneProvisioningJob Get phone provisioning job Get advanced phone provisioning job status

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param jobId

@return PhoneProvisioningJobDto

func (*PhoneControllerApiService) GetPhoneSmsPrepaidCredit 

func (a *PhoneControllerApiService) GetPhoneSmsPrepaidCredit(ctx _context.Context, creditId string) (PhoneSmsPrepaidCreditDto, *_nethttp.Response, error)

GetPhoneSmsPrepaidCredit Get SMS prepaid credit Get a specific SMS prepaid credit balance for the authenticated account

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param creditId

@return PhoneSmsPrepaidCreditDto

func (*PhoneControllerApiService) GetPhoneSmsPrepaidCredits 

func (a *PhoneControllerApiService) GetPhoneSmsPrepaidCredits(ctx _context.Context) (PhoneSmsPrepaidCreditsDto, *_nethttp.Response, error)

GetPhoneSmsPrepaidCredits Get SMS prepaid credits List SMS prepaid credits for the authenticated account

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return PhoneSmsPrepaidCreditsDto

func (*PhoneControllerApiService) GetPhoneSummary 

func (a *PhoneControllerApiService) GetPhoneSummary(ctx _context.Context) (PhoneSummaryDto, *_nethttp.Response, error)

GetPhoneSummary Get phone summary Get overview of assigned phones

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return PhoneSummaryDto

func (*PhoneControllerApiService) GetPhoneTags 

func (a *PhoneControllerApiService) GetPhoneTags(ctx _context.Context, localVarOptionals *GetPhoneTagsOpts) ([]string, *_nethttp.Response, error)

GetPhoneTags Get phone tags List all unique tags used by your phone numbers

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetPhoneTagsOpts - Optional Parameters:
  • @param "Search" (optional.String) - Optional search filter

@return []string

func (*PhoneControllerApiService) GetSentSmsByPhoneNumber 

func (a *PhoneControllerApiService) GetSentSmsByPhoneNumber(ctx _context.Context, phoneNumberId string, localVarOptionals *GetSentSmsByPhoneNumberOpts) (PageSentSmsProjection, *_nethttp.Response, error)

GetSentSmsByPhoneNumber List sent TXT messages for a phone number Get sent SMS messages for a phone number

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param phoneNumberId
  • @param optional nil or *GetSentSmsByPhoneNumberOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in SMS list pagination
  • @param "Size" (optional.Int32) - Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Optional filter SMSs received after given date time
  • @param "Before" (optional.Time) - Optional filter SMSs received before given date time
  • @param "Search" (optional.String) - Optional search filter

@return PageSentSmsProjection

func (*PhoneControllerApiService) GetSmsByPhoneNumber 

func (a *PhoneControllerApiService) GetSmsByPhoneNumber(ctx _context.Context, phoneNumberId string, localVarOptionals *GetSmsByPhoneNumberOpts) (PageSmsProjection, *_nethttp.Response, error)

GetSmsByPhoneNumber List SMS messages for a phone number Get SMS messages for a phone number

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param phoneNumberId
  • @param optional nil or *GetSmsByPhoneNumberOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in SMS list pagination
  • @param "Size" (optional.Int32) - Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "UnreadOnly" (optional.Bool) - Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly
  • @param "Since" (optional.Time) - Optional filter SMSs received after given date time
  • @param "Before" (optional.Time) - Optional filter SMSs received before given date time
  • @param "Search" (optional.String) - Optional search filter
  • @param "Favourite" (optional.Bool) - Optionally filter results for favourites only

@return PageSmsProjection

func (*PhoneControllerApiService) ReassignPhoneNumberRelease 

func (a *PhoneControllerApiService) ReassignPhoneNumberRelease(ctx _context.Context, releaseId string) (PhoneNumberDto, *_nethttp.Response, error)

ReassignPhoneNumberRelease Reassign phone number release Reassign phone number that was released or deleted

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param releaseId

@return PhoneNumberDto

func (*PhoneControllerApiService) ReleasePhonePoolLease 

func (a *PhoneControllerApiService) ReleasePhonePoolLease(ctx _context.Context, poolId string, leaseId string) (*_nethttp.Response, error)

ReleasePhonePoolLease Release phone pool lease Release an active phone pool lease

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param poolId
  • @param leaseId

func (*PhoneControllerApiService) RemovePhoneNumberFromPhonePool 

func (a *PhoneControllerApiService) RemovePhoneNumberFromPhonePool(ctx _context.Context, poolId string, phoneNumberId string) (*_nethttp.Response, error)

RemovePhoneNumberFromPhonePool Remove phone number from phone pool Remove a phone number from a pool. If the number is leased from this pool the lease is released.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param poolId
  • @param phoneNumberId

func (*PhoneControllerApiService) RemovePhoneNumberTags 

func (a *PhoneControllerApiService) RemovePhoneNumberTags(ctx _context.Context, phoneNumberId string, phoneNumberTagsOptions PhoneNumberTagsOptions) (PhoneNumberDto, *_nethttp.Response, error)

RemovePhoneNumberTags Remove phone number tags Remove one or more tags from a phone number

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param phoneNumberId
  • @param phoneNumberTagsOptions

@return PhoneNumberDto

func (*PhoneControllerApiService) SearchAvailablePhoneNumbers 

func (a *PhoneControllerApiService) SearchAvailablePhoneNumbers(ctx _context.Context, searchAvailablePhoneNumbersOptions SearchAvailablePhoneNumbersOptions) (AvailablePhoneNumbersResult, *_nethttp.Response, error)

SearchAvailablePhoneNumbers Search available phone numbers Search available numbers for advanced provisioning

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param searchAvailablePhoneNumbersOptions

@return AvailablePhoneNumbersResult

func (*PhoneControllerApiService) SendSmsFromPhoneNumber 

func (a *PhoneControllerApiService) SendSmsFromPhoneNumber(ctx _context.Context, phoneNumberId string, smsSendOptions SmsSendOptions) (SentSmsDto, *_nethttp.Response, error)

SendSmsFromPhoneNumber Send TXT message from a phone number Send SMS from a phone number

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param phoneNumberId
  • @param smsSendOptions

@return SentSmsDto

func (*PhoneControllerApiService) SetConsentStatus 

func (a *PhoneControllerApiService) SetConsentStatus(ctx _context.Context, agree bool) (ConsentStatusDto, *_nethttp.Response, error)

SetConsentStatus Set consent status Give or revoke consent for phone usage

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param agree

@return ConsentStatusDto

func (*PhoneControllerApiService) SetPhoneFavourited 

func (a *PhoneControllerApiService) SetPhoneFavourited(ctx _context.Context, phoneNumberId string, setPhoneFavouritedOptions SetPhoneFavouritedOptions) (PhoneNumberDto, *_nethttp.Response, error)

SetPhoneFavourited Set phone favourited state Set and return new favorite state for a phone

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param phoneNumberId ID of phone to set favourite state
  • @param setPhoneFavouritedOptions

@return PhoneNumberDto

func (*PhoneControllerApiService) SetPhoneNumberTags 

func (a *PhoneControllerApiService) SetPhoneNumberTags(ctx _context.Context, phoneNumberId string, phoneNumberTagsOptions PhoneNumberTagsOptions) (PhoneNumberDto, *_nethttp.Response, error)

SetPhoneNumberTags Set phone number tags Replace all tags on a phone number

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param phoneNumberId
  • @param phoneNumberTagsOptions

@return PhoneNumberDto

func (*PhoneControllerApiService) TestPhoneNumberSendSms 

func (a *PhoneControllerApiService) TestPhoneNumberSendSms(ctx _context.Context, phoneNumberId string, testPhoneNumberOptions TestPhoneNumberOptions, localVarOptionals *TestPhoneNumberSendSmsOpts) (*_nethttp.Response, error)

TestPhoneNumberSendSms Test sending an SMS to a number Test a phone number by sending an SMS to it. NOTE this is only for internal use to check that a phone number is working. For end-to-end phone testing see https://docs.mailslurp.com/txt-sms/

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param phoneNumberId
  • @param testPhoneNumberOptions
  • @param optional nil or *TestPhoneNumberSendSmsOpts - Optional Parameters:
  • @param "XTestId" (optional.String) -

func (*PhoneControllerApiService) UpdatePhoneNumber 

func (a *PhoneControllerApiService) UpdatePhoneNumber(ctx _context.Context, phoneNumberId string, updatePhoneNumberOptions UpdatePhoneNumberOptions) (PhoneNumberDto, *_nethttp.Response, error)

UpdatePhoneNumber Update a phone number Set field for phone number

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param phoneNumberId ID of phone to set favourite state
  • @param updatePhoneNumberOptions

@return PhoneNumberDto

func (*PhoneControllerApiService) UpdatePhonePool 

func (a *PhoneControllerApiService) UpdatePhonePool(ctx _context.Context, poolId string, updatePhonePoolOptions UpdatePhonePoolOptions) (PhonePoolDetailDto, *_nethttp.Response, error)

UpdatePhonePool Update phone pool Update phone pool metadata such as name or description

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param poolId
  • @param updatePhonePoolOptions

@return PhonePoolDetailDto

func (*PhoneControllerApiService) ValidatePhoneNumber 

func (a *PhoneControllerApiService) ValidatePhoneNumber(ctx _context.Context, validatePhoneNumberOptions ValidatePhoneNumberOptions) (PhoneNumberValidationDto, *_nethttp.Response, error)

ValidatePhoneNumber Verify validity of a phone number Validate a phone number

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param validatePhoneNumberOptions

@return PhoneNumberValidationDto

type PhoneMessageThreadItemProjection 

type PhoneMessageThreadItemProjection struct {
	Id               string    `json:"id"`
	Body             string    `json:"body"`
	Created          time.Time `json:"created"`
	PhoneNumberId    string    `json:"phoneNumberId"`
	MessageDirection string    `json:"messageDirection"`
	FromPhoneNumber  string    `json:"fromPhoneNumber"`
	ToPhoneNumber    string    `json:"toPhoneNumber"`
}

PhoneMessageThreadItemProjection struct for PhoneMessageThreadItemProjection

type PhoneMessageThreadProjection 

type PhoneMessageThreadProjection struct {
	PhoneNumber          string    `json:"phoneNumber,omitempty"`
	PhoneNumberId        string    `json:"phoneNumberId"`
	OtherPhoneNumber     string    `json:"otherPhoneNumber,omitempty"`
	LastMessageDirection string    `json:"lastMessageDirection"`
	LastBody             string    `json:"lastBody"`
	LastCreated          time.Time `json:"lastCreated"`
}

PhoneMessageThreadProjection struct for PhoneMessageThreadProjection

type PhoneNumberDto 

type PhoneNumberDto struct {
	Id                string    `json:"id"`
	Name              string    `json:"name,omitempty"`
	Description       string    `json:"description,omitempty"`
	Tags              []string  `json:"tags"`
	UserId            string    `json:"userId"`
	ComplianceAddress string    `json:"complianceAddress,omitempty"`
	EmergencyAddress  string    `json:"emergencyAddress,omitempty"`
	PhoneNumber       string    `json:"phoneNumber"`
	PhoneCountry      string    `json:"phoneCountry"`
	PhonePlan         string    `json:"phonePlan"`
	CreatedAt         time.Time `json:"createdAt"`
	UpdatedAt         time.Time `json:"updatedAt"`
	Favourite         bool      `json:"favourite"`
	PhoneVariant      string    `json:"phoneVariant,omitempty"`
	LineType          string    `json:"lineType,omitempty"`
	CarrierName       string    `json:"carrierName,omitempty"`
	MobileCountryCode string    `json:"mobileCountryCode,omitempty"`
	MobileNetworkCode string    `json:"mobileNetworkCode,omitempty"`
	ProviderLabel     string    `json:"providerLabel,omitempty"`
}

PhoneNumberDto struct for PhoneNumberDto

type PhoneNumberLineTypeIntelligenceDto 

type PhoneNumberLineTypeIntelligenceDto struct {
	Type              string `json:"type,omitempty"`
	CarrierName       string `json:"carrierName,omitempty"`
	MobileCountryCode string `json:"mobileCountryCode,omitempty"`
	MobileNetworkCode string `json:"mobileNetworkCode,omitempty"`
	ErrorCode         int32  `json:"errorCode,omitempty"`
}

PhoneNumberLineTypeIntelligenceDto struct for PhoneNumberLineTypeIntelligenceDto

type PhoneNumberLineTypeLookupDto 

type PhoneNumberLineTypeLookupDto struct {
	PhoneNumber          string                             `json:"phoneNumber"`
	NationalFormat       string                             `json:"nationalFormat,omitempty"`
	CountryCode          string                             `json:"countryCode,omitempty"`
	CountryPrefix        string                             `json:"countryPrefix,omitempty"`
	IsValid              bool                               `json:"isValid"`
	ValidationErrors     []string                           `json:"validationErrors,omitempty"`
	LineTypeIntelligence PhoneNumberLineTypeIntelligenceDto `json:"lineTypeIntelligence,omitempty"`
	MailslurpPhoneNumber bool                               `json:"mailslurpPhoneNumber"`
}

PhoneNumberLineTypeLookupDto struct for PhoneNumberLineTypeLookupDto

type PhoneNumberProjection 

type PhoneNumberProjection struct {
	Name              string    `json:"name,omitempty"`
	Id                string    `json:"id"`
	UserId            string    `json:"userId"`
	PhoneCountry      string    `json:"phoneCountry"`
	CreatedAt         time.Time `json:"createdAt"`
	ProviderLabel     string    `json:"providerLabel,omitempty"`
	LineType          string    `json:"lineType,omitempty"`
	CarrierName       string    `json:"carrierName,omitempty"`
	MobileCountryCode string    `json:"mobileCountryCode,omitempty"`
	MobileNetworkCode string    `json:"mobileNetworkCode,omitempty"`
	PhoneNumber       string    `json:"phoneNumber"`
}

PhoneNumberProjection Phone number projection

type PhoneNumberReleaseProjection 

type PhoneNumberReleaseProjection struct {
	Name                 string    `json:"name,omitempty"`
	Id                   string    `json:"id"`
	UserId               string    `json:"userId"`
	PhoneCountry         string    `json:"phoneCountry"`
	CreatedAt            time.Time `json:"createdAt"`
	PhoneNumber          string    `json:"phoneNumber,omitempty"`
	SubscriptionSchedule string    `json:"subscriptionSchedule,omitempty"`
	PlanCurrency         string    `json:"planCurrency,omitempty"`
}

PhoneNumberReleaseProjection Released phone number projection

type PhoneNumberTagsOptions 

type PhoneNumberTagsOptions struct {
	Tags []string `json:"tags"`
}

PhoneNumberTagsOptions struct for PhoneNumberTagsOptions

type PhoneNumberValidationDto 

type PhoneNumberValidationDto struct {
	CountryCode      string   `json:"countryCode,omitempty"`
	CountryPrefix    string   `json:"countryPrefix,omitempty"`
	PhoneNumber      string   `json:"phoneNumber"`
	IsValid          bool     `json:"isValid"`
	ValidationErrors []string `json:"validationErrors,omitempty"`
}

PhoneNumberValidationDto struct for PhoneNumberValidationDto

type PhonePlanAvailability 

type PhonePlanAvailability struct {
	Items                  []PhonePlanAvailabilityItem `json:"items"`
	DisabledPhoneCountries []string                    `json:"disabledPhoneCountries"`
}

PhonePlanAvailability struct for PhonePlanAvailability

type PhonePlanAvailabilityItem 

type PhonePlanAvailabilityItem struct {
	PhoneCountry       string   `json:"phoneCountry"`
	AvailabilityStatus string   `json:"availabilityStatus"`
	Variants           []string `json:"variants,omitempty"`
}

PhonePlanAvailabilityItem struct for PhonePlanAvailabilityItem

type PhonePlanDto 

type PhonePlanDto struct {
	Id           string    `json:"id"`
	UserId       string    `json:"userId"`
	PhoneCountry string    `json:"phoneCountry"`
	CreatedAt    time.Time `json:"createdAt"`
}

PhonePlanDto struct for PhonePlanDto

type PhonePoolDetailDto 

type PhonePoolDetailDto struct {
	Id                   string               `json:"id"`
	UserId               string               `json:"userId"`
	Name                 string               `json:"name"`
	Description          string               `json:"description,omitempty"`
	CreatedAt            time.Time            `json:"createdAt"`
	UpdatedAt            time.Time            `json:"updatedAt"`
	MemberCount          int32                `json:"memberCount"`
	AvailableMemberCount int32                `json:"availableMemberCount"`
	LeasedMemberCount    int32                `json:"leasedMemberCount"`
	Members              []PhonePoolMemberDto `json:"members"`
}

PhonePoolDetailDto struct for PhonePoolDetailDto

type PhonePoolDto 

type PhonePoolDto struct {
	Id                   string    `json:"id"`
	UserId               string    `json:"userId"`
	Name                 string    `json:"name"`
	Description          string    `json:"description,omitempty"`
	CreatedAt            time.Time `json:"createdAt"`
	UpdatedAt            time.Time `json:"updatedAt"`
	MemberCount          int32     `json:"memberCount"`
	AvailableMemberCount int32     `json:"availableMemberCount"`
	LeasedMemberCount    int32     `json:"leasedMemberCount"`
}

PhonePoolDto struct for PhonePoolDto

type PhonePoolLeaseDto 

type PhonePoolLeaseDto struct {
	Id            string    `json:"id"`
	PoolId        string    `json:"poolId"`
	PhoneNumberId string    `json:"phoneNumberId"`
	PhoneNumber   string    `json:"phoneNumber"`
	PhoneCountry  string    `json:"phoneCountry"`
	PhoneName     string    `json:"phoneName,omitempty"`
	LeaseName     string    `json:"leaseName,omitempty"`
	LeaseOwner    string    `json:"leaseOwner,omitempty"`
	LeasedAt      time.Time `json:"leasedAt"`
	ExpiresAt     time.Time `json:"expiresAt,omitempty"`
}

PhonePoolLeaseDto struct for PhonePoolLeaseDto

type PhonePoolMemberDto 

type PhonePoolMemberDto struct {
	Id            string            `json:"id"`
	PoolId        string            `json:"poolId"`
	PhoneNumberId string            `json:"phoneNumberId"`
	PhoneNumber   string            `json:"phoneNumber"`
	PhoneCountry  string            `json:"phoneCountry"`
	PhoneName     string            `json:"phoneName,omitempty"`
	CreatedAt     time.Time         `json:"createdAt"`
	ActiveLease   PhonePoolLeaseDto `json:"activeLease,omitempty"`
}

PhonePoolMemberDto struct for PhonePoolMemberDto

type PhoneProviderCapabilitiesResult 

type PhoneProviderCapabilitiesResult struct {
	ProviderLabel     string   `json:"providerLabel"`
	PhoneCountry      string   `json:"phoneCountry"`
	SupportedVariants []string `json:"supportedVariants"`
	Warning           string   `json:"warning,omitempty"`
}

PhoneProviderCapabilitiesResult struct for PhoneProviderCapabilitiesResult

type PhoneProvisioningJobDto 

type PhoneProvisioningJobDto struct {
	Id               string                        `json:"id"`
	UserId           string                        `json:"userId"`
	PhoneCountry     string                        `json:"phoneCountry"`
	PhoneVariant     string                        `json:"phoneVariant,omitempty"`
	Status           string                        `json:"status"`
	RequestedCount   int32                         `json:"requestedCount"`
	AttemptedCount   int32                         `json:"attemptedCount"`
	SucceededCount   int32                         `json:"succeededCount"`
	FailedCount      int32                         `json:"failedCount"`
	UnavailableCount int32                         `json:"unavailableCount"`
	CreatedAt        time.Time                     `json:"createdAt"`
	UpdatedAt        time.Time                     `json:"updatedAt"`
	Items            []PhoneProvisioningJobItemDto `json:"items"`
}

PhoneProvisioningJobDto struct for PhoneProvisioningJobDto

type PhoneProvisioningJobItemDto 

type PhoneProvisioningJobItemDto struct {
	Id                string `json:"id"`
	PhoneNumber       string `json:"phoneNumber"`
	ProviderLabel     string `json:"providerLabel,omitempty"`
	Status            string `json:"status"`
	LineType          string `json:"lineType,omitempty"`
	CarrierName       string `json:"carrierName,omitempty"`
	MobileCountryCode string `json:"mobileCountryCode,omitempty"`
	MobileNetworkCode string `json:"mobileNetworkCode,omitempty"`
	PhoneNumberId     string `json:"phoneNumberId,omitempty"`
	FailureMessage    string `json:"failureMessage,omitempty"`
}

PhoneProvisioningJobItemDto struct for PhoneProvisioningJobItemDto

type PhoneSmsPrepaidCreditDto 

type PhoneSmsPrepaidCreditDto struct {
	Id string `json:"id"`
	// Null means the balance is global for the account rather than country-specific.
	PhoneCountry     *string   `json:"phoneCountry,omitempty"`
	Global           bool      `json:"global"`
	RemainingCredits int64     `json:"remainingCredits"`
	InitialCredits   int64     `json:"initialCredits"`
	SentMultiplier   int32     `json:"sentMultiplier"`
	CreatedAt        time.Time `json:"createdAt"`
	UpdatedAt        time.Time `json:"updatedAt"`
}

PhoneSmsPrepaidCreditDto struct for PhoneSmsPrepaidCreditDto

type PhoneSmsPrepaidCreditsDto 

type PhoneSmsPrepaidCreditsDto struct {
	Count                 int32                      `json:"count"`
	TotalRemainingCredits int64                      `json:"totalRemainingCredits"`
	Items                 []PhoneSmsPrepaidCreditDto `json:"items"`
}

PhoneSmsPrepaidCreditsDto struct for PhoneSmsPrepaidCreditsDto

type PhoneSummaryCountryDto 

type PhoneSummaryCountryDto struct {
	PhoneCountryCode string `json:"phoneCountryCode"`
	TotalCount       int64  `json:"totalCount"`
	HasPlan          bool   `json:"hasPlan"`
}

PhoneSummaryCountryDto struct for PhoneSummaryCountryDto

type PhoneSummaryDto 

type PhoneSummaryDto struct {
	PhoneCountrySummaries []PhoneSummaryCountryDto `json:"phoneCountrySummaries"`
	HasPhoneNumbers       bool                     `json:"hasPhoneNumbers"`
	HasMissingPlans       bool                     `json:"hasMissingPlans"`
	TotalPhones           int32                    `json:"totalPhones"`
	Plans                 []PlanSummaryDto         `json:"plans"`
}

PhoneSummaryDto struct for PhoneSummaryDto

type PlanSummaryDto 

type PlanSummaryDto struct {
	SubscriptionSchedule string `json:"subscriptionSchedule,omitempty"`
	PhoneCountry         string `json:"phoneCountry"`
}

PlanSummaryDto struct for PlanSummaryDto

type PlusAddressDto 

type PlusAddressDto struct {
	Id          string    `json:"id"`
	PlusAddress string    `json:"plusAddress"`
	FullAddress string    `json:"fullAddress"`
	UserId      string    `json:"userId"`
	InboxId     string    `json:"inboxId"`
	CreatedAt   time.Time `json:"createdAt"`
	UpdatedAt   time.Time `json:"updatedAt"`
}

PlusAddressDto struct for PlusAddressDto

type PlusAddressProjection 

type PlusAddressProjection struct {
	Id          string    `json:"id"`
	UserId      string    `json:"userId"`
	InboxId     string    `json:"inboxId"`
	UpdatedAt   time.Time `json:"updatedAt"`
	CreatedAt   time.Time `json:"createdAt"`
	PlusAddress string    `json:"plusAddress"`
	FullAddress string    `json:"fullAddress"`
}

PlusAddressProjection struct for PlusAddressProjection

type ProviderSettings 

type ProviderSettings struct {
	MailProvider string `json:"mailProvider"`
	ImapHost     string `json:"imapHost"`
	ImapPort     int32  `json:"imapPort"`
	ImapSsl      bool   `json:"imapSsl"`
	ImapStartTls bool   `json:"imapStartTls,omitempty"`
	SmtpHost     string `json:"smtpHost"`
	SmtpPort     int32  `json:"smtpPort"`
	SmtpSsl      bool   `json:"smtpSsl"`
	SmtpStartTls bool   `json:"smtpStartTls,omitempty"`
}

ProviderSettings struct for ProviderSettings

type RawEmailJson 

type RawEmailJson struct {
	Content string `json:"content"`
}

RawEmailJson Content in raw format

type Recipient 

type Recipient struct {
	RawValue     string  `json:"rawValue"`
	EmailAddress string  `json:"emailAddress"`
	Name         *string `json:"name,omitempty"`
}

Recipient Email recipient

type RecipientProjection 

type RecipientProjection struct {
	Name         string `json:"name,omitempty"`
	EmailAddress string `json:"emailAddress"`
	RawValue     string `json:"rawValue"`
}

RecipientProjection struct for RecipientProjection

type ReplyForSms 

type ReplyForSms struct {
	Reply SentSmsDto `json:"reply,omitempty"`
}

ReplyForSms struct for ReplyForSms

type ReplyToAliasEmailOptions 

type ReplyToAliasEmailOptions struct {
	// Body of the reply email you want to send
	Body string `json:"body"`
	// Is the reply HTML
	IsHTML bool `json:"isHTML"`
	// The charset that your message should be sent with. Optional. Default is UTF-8
	Charset *string `json:"charset,omitempty"`
	// List of uploaded attachments to send with the reply. Optional.
	Attachments *[]string `json:"attachments,omitempty"`
	// Template variables if using a template
	TemplateVariables *map[string]map[string]interface{} `json:"templateVariables,omitempty"`
	// Template ID to use instead of body. Will use template variable map to fill defined variable slots.
	Template *string `json:"template,omitempty"`
	// How an email should be sent based on its recipients
	SendStrategy *string `json:"sendStrategy,omitempty"`
	// Optional custom headers
	CustomHeaders *map[string]string `json:"customHeaders,omitempty"`
	// Optionally use inbox name as display name for sender email address
	UseInboxName *bool `json:"useInboxName,omitempty"`
	Html         bool  `json:"html,omitempty"`
}

ReplyToAliasEmailOptions Options for replying to an alias email using the alias inbox

type ReplyToEmailOptions 

type ReplyToEmailOptions struct {
	// Body of the reply email you want to send
	Body string `json:"body"`
	// Is the reply HTML
	IsHTML bool `json:"isHTML"`
	// The from header that should be used. Optional
	From *string `json:"from,omitempty"`
	// The replyTo header that should be used. Optional
	ReplyTo *string `json:"replyTo,omitempty"`
	// Optional custom headers
	CustomHeaders *map[string]string `json:"customHeaders,omitempty"`
	// The charset that your message should be sent with. Optional. Default is UTF-8
	Charset *string `json:"charset,omitempty"`
	// List of uploaded attachments to send with the reply. Optional.
	Attachments *[]string `json:"attachments,omitempty"`
	// Template variables if using a template
	TemplateVariables *map[string]map[string]interface{} `json:"templateVariables,omitempty"`
	// Template ID to use instead of body. Will use template variable map to fill defined variable slots.
	Template *string `json:"template,omitempty"`
	// How an email should be sent based on its recipients
	SendStrategy *string `json:"sendStrategy,omitempty"`
	// Optionally use inbox name as display name for sender email address
	UseInboxName *bool `json:"useInboxName,omitempty"`
	Html         bool  `json:"html,omitempty"`
}

ReplyToEmailOptions Options for replying to email with API

type ReputationItemProjection 

type ReputationItemProjection struct {
	Id             string    `json:"id"`
	Severity       string    `json:"severity"`
	Source         string    `json:"source,omitempty"`
	CreatedAt      time.Time `json:"createdAt"`
	Recipient      string    `json:"recipient,omitempty"`
	ReputationType string    `json:"reputationType"`
}

ReputationItemProjection struct for ReputationItemProjection

type RulesetControllerApiService 

type RulesetControllerApiService service

RulesetControllerApiService RulesetControllerApi service

func (*RulesetControllerApiService) CreateNewRuleset 

func (a *RulesetControllerApiService) CreateNewRuleset(ctx _context.Context, createRulesetOptions CreateRulesetOptions, localVarOptionals *CreateNewRulesetOpts) (RulesetDto, *_nethttp.Response, error)

CreateNewRuleset Create a ruleset Create a new inbox or phone number rule for forwarding, blocking, and allowing emails or SMS when sending and receiving

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createRulesetOptions
  • @param optional nil or *CreateNewRulesetOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Inbox id to attach ruleset to
  • @param "PhoneId" (optional.Interface of string) - Phone id to attach ruleset to

@return RulesetDto

func (*RulesetControllerApiService) DeleteRuleset 

func (a *RulesetControllerApiService) DeleteRuleset(ctx _context.Context, id string) (*_nethttp.Response, error)

DeleteRuleset Delete a ruleset Delete ruleset

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of ruleset

func (*RulesetControllerApiService) DeleteRulesets 

func (a *RulesetControllerApiService) DeleteRulesets(ctx _context.Context, localVarOptionals *DeleteRulesetsOpts) (*_nethttp.Response, error)

DeleteRulesets Delete rulesets Delete rulesets. Accepts optional inboxId or phoneId filters.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *DeleteRulesetsOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Optional inbox id to attach ruleset to
  • @param "PhoneId" (optional.Interface of string) -

func (*RulesetControllerApiService) GetRuleset 

func (a *RulesetControllerApiService) GetRuleset(ctx _context.Context, id string) (RulesetDto, *_nethttp.Response, error)

GetRuleset Get a ruleset Get ruleset

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of ruleset

@return RulesetDto

func (*RulesetControllerApiService) GetRulesets 

func (a *RulesetControllerApiService) GetRulesets(ctx _context.Context, localVarOptionals *GetRulesetsOpts) (PageRulesetDto, *_nethttp.Response, error)

GetRulesets List rulesets block and allow lists List all rulesets attached to an inbox or phone or account

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetRulesetsOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Optional inbox id to get rulesets from
  • @param "PhoneId" (optional.Interface of string) - Optional phone id to get rulesets from
  • @param "Page" (optional.Int32) - Optional page index in inbox ruleset list pagination
  • @param "Size" (optional.Int32) - Optional page size in inbox ruleset list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "SearchFilter" (optional.String) - Optional search filter
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return PageRulesetDto

func (*RulesetControllerApiService) TestInboxRulesetsForInbox 

func (a *RulesetControllerApiService) TestInboxRulesetsForInbox(ctx _context.Context, inboxId string, rulesetTestOptions RulesetTestOptions) (InboxRulesetTestResult, *_nethttp.Response, error)

TestInboxRulesetsForInbox Test inbox rulesets for inbox Test inbox rulesets for inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId ID of inbox
  • @param rulesetTestOptions

@return InboxRulesetTestResult

func (*RulesetControllerApiService) TestNewRuleset 

func (a *RulesetControllerApiService) TestNewRuleset(ctx _context.Context, testNewInboxRulesetOptions TestNewInboxRulesetOptions) (InboxRulesetTestResult, *_nethttp.Response, error)

TestNewRuleset Test new ruleset Test new ruleset

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testNewInboxRulesetOptions

@return InboxRulesetTestResult

func (*RulesetControllerApiService) TestRuleset 

func (a *RulesetControllerApiService) TestRuleset(ctx _context.Context, id string, rulesetTestOptions RulesetTestOptions) (InboxRulesetTestResult, *_nethttp.Response, error)

TestRuleset Test a ruleset Test an inbox or phone ruleset

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of ruleset
  • @param rulesetTestOptions

@return InboxRulesetTestResult

func (*RulesetControllerApiService) TestRulesetReceiving 

func (a *RulesetControllerApiService) TestRulesetReceiving(ctx _context.Context, testRulesetReceivingOptions TestRulesetReceivingOptions) (TestRulesetReceivingResult, *_nethttp.Response, error)

TestRulesetReceiving Test receiving with rulesets Test whether inbound emails from an email address would be blocked or allowed by inbox rulesets or test if phone number can receive SMS

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testRulesetReceivingOptions

@return TestRulesetReceivingResult

func (*RulesetControllerApiService) TestRulesetSending 

func (a *RulesetControllerApiService) TestRulesetSending(ctx _context.Context, testInboxRulesetSendingOptions TestInboxRulesetSendingOptions) (TestRulesetSendingResult, *_nethttp.Response, error)

TestRulesetSending Test sending with rulesets Test whether outbound emails to an email address would be blocked or allowed by inbox rulesets or whether a phone number can send SMS

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testInboxRulesetSendingOptions

@return TestRulesetSendingResult

type RulesetDto 

type RulesetDto struct {
	Id        string    `json:"id"`
	InboxId   *string   `json:"inboxId,omitempty"`
	PhoneId   *string   `json:"phoneId,omitempty"`
	Scope     string    `json:"scope"`
	Action    string    `json:"action"`
	Target    string    `json:"target"`
	Handler   string    `json:"handler"`
	CreatedAt time.Time `json:"createdAt"`
}

RulesetDto Rules for an inbox or phone number. Rulesets can be used to block, allow, filter, or bounce emails or SMS when sending or receiving.

type RulesetTestOptions 

type RulesetTestOptions struct {
	TestTarget string `json:"testTarget"`
}

RulesetTestOptions Test options for inbox ruleset

type RunDueCampaignProbesOpts 

type RunDueCampaignProbesOpts struct {
	MaxRuns optional.Int32
}

RunDueCampaignProbesOpts Optional parameters for the method 'RunDueCampaignProbes'

type RunDueDomainMonitorsOpts 

type RunDueDomainMonitorsOpts struct {
	MaxRuns optional.Int32
}

RunDueDomainMonitorsOpts Optional parameters for the method 'RunDueDomainMonitors'

type ScheduledJob 

type ScheduledJob struct {
	Id              string    `json:"id"`
	UserId          string    `json:"userId"`
	InboxId         string    `json:"inboxId"`
	JobId           string    `json:"jobId"`
	GroupId         string    `json:"groupId"`
	TriggerId       string    `json:"triggerId"`
	Status          string    `json:"status"`
	SendAtTimestamp time.Time `json:"sendAtTimestamp"`
	CreatedAt       time.Time `json:"createdAt"`
	UpdatedAt       time.Time `json:"updatedAt"`
}

ScheduledJob struct for ScheduledJob

type ScheduledJobDto 

type ScheduledJobDto struct {
	Id              string    `json:"id"`
	UserId          string    `json:"userId"`
	InboxId         string    `json:"inboxId"`
	JobId           string    `json:"jobId"`
	GroupId         string    `json:"groupId"`
	TriggerId       string    `json:"triggerId"`
	Status          string    `json:"status"`
	SendAtTimestamp time.Time `json:"sendAtTimestamp"`
	CreatedAt       time.Time `json:"createdAt"`
	UpdatedAt       time.Time `json:"updatedAt"`
}

ScheduledJobDto struct for ScheduledJobDto

type SearchAvailablePhoneNumbersOptions 

type SearchAvailablePhoneNumbersOptions struct {
	PhoneCountry string  `json:"phoneCountry"`
	PhoneVariant *string `json:"phoneVariant,omitempty"`
	// Quality filter for advanced phone provisioning search
	QualityFilter     *string   `json:"qualityFilter,omitempty"`
	LineType          *string   `json:"lineType,omitempty"`
	CarrierName       *string   `json:"carrierName,omitempty"`
	MobileCountryCode *string   `json:"mobileCountryCode,omitempty"`
	MobileNetworkCode *string   `json:"mobileNetworkCode,omitempty"`
	ProviderLabels    *[]string `json:"providerLabels,omitempty"`
	Limit             *int32    `json:"limit,omitempty"`
}

SearchAvailablePhoneNumbersOptions Search criteria for advanced phone provisioning

type SearchEmailsOptions 

type SearchEmailsOptions struct {
	// Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
	InboxIds []string `json:"inboxIds,omitempty"`
	// Optional page index in email list pagination
	PageIndex int32 `json:"pageIndex,omitempty"`
	// Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results
	PageSize int32 `json:"pageSize,omitempty"`
	// Optional createdAt sort direction ASC or DESC
	SortDirection string `json:"sortDirection,omitempty"`
	// Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
	UnreadOnly bool `json:"unreadOnly,omitempty"`
	// Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body
	SearchFilter string `json:"searchFilter,omitempty"`
	// Optional filter emails received after given date time
	Since time.Time `json:"since,omitempty"`
	// Optional filter emails received before given date time
	Before time.Time `json:"before,omitempty"`
}

SearchEmailsOptions struct for SearchEmailsOptions

type SearchEmailsOpts 

type SearchEmailsOpts struct {
	SyncConnectors optional.Bool
	Favourited     optional.Bool
	PlusAddressId  optional.Interface
}

SearchEmailsOpts Optional parameters for the method 'SearchEmails'

type SearchInboxesOptions 

type SearchInboxesOptions struct {
	// Optional page index in list pagination
	PageIndex *int32 `json:"pageIndex,omitempty"`
	// Optional page size in list pagination
	PageSize *int32 `json:"pageSize,omitempty"`
	// Optional createdAt sort direction ASC or DESC
	SortDirection *string `json:"sortDirection,omitempty"`
	// Optionally filter results for favourites only
	Favourite *bool `json:"favourite,omitempty"`
	// Optionally filter by search words partial matching name and email address
	Search *string `json:"search,omitempty"`
	// Optionally filter by tags. Will return inboxes that include given tags
	Tag *string `json:"tag,omitempty"`
	// Optional filter by created after given date time
	Since *time.Time `json:"since,omitempty"`
	// Optional filter by created before given date time
	Before *time.Time `json:"before,omitempty"`
	// Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).
	InboxType *string `json:"inboxType,omitempty"`
	// Optional filter by inbox function
	InboxFunction *string `json:"inboxFunction,omitempty"`
	// Optional domain ID filter
	DomainId *string `json:"domainId,omitempty"`
}

SearchInboxesOptions struct for SearchInboxesOptions

type SendEmailBodyPart 

type SendEmailBodyPart struct {
	ContentType string `json:"contentType"`
	ContentBody string `json:"contentBody"`
}

SendEmailBodyPart Email body content parts for multipart mime message. Will override body.

type SendEmailFromConnectorOpts 

type SendEmailFromConnectorOpts struct {
	UseFallback optional.Bool
}

SendEmailFromConnectorOpts Optional parameters for the method 'SendEmailFromConnector'

type SendEmailOptions 

type SendEmailOptions struct {
	// Optional list of contact IDs to send email to. Manage your contacts via the API or dashboard. When contacts are used the email is sent to each contact separately so they will not see other recipients.
	ToContacts *[]string `json:"toContacts,omitempty"`
	// Optional contact group ID to send email to. You can create contacts and contact groups in the API or dashboard and use them for email campaigns. When contact groups are used the email is sent to each contact separately so they will not see other recipients
	ToGroup *string `json:"toGroup,omitempty"`
	// List of destination email addresses. Each email address must be RFC 5322 format. Even single recipients must be in array form. Maximum recipients per email depends on your plan. If you need to send many emails try using contacts or contact groups or use a non standard sendStrategy to ensure that spam filters are not triggered (many recipients in one email can affect your spam rating). Be cautious when sending emails that your recipients exist. High bounce rates (meaning a high percentage of emails cannot be delivered because an address does not exist) can result in account freezing.
	To *[]string `json:"to,omitempty"`
	// Optional from address. Email address is RFC 5322 format and may include a display name and email in angle brackets (`my@address.com` or `My inbox <my@address.com>`). If no sender is set the source inbox address will be used for this field. If you set `useInboxName` to `true` the from field will include the inbox name as a display name: `inbox_name <inbox@address.com>`. For this to work use the name field when creating an inbox. Beware of potential spam penalties when setting the from field to an address not used by the inbox. Your emails may get blocked by services if you impersonate another address. To use a custom email addresses use a custom domain. You can create domains with the DomainController. The domain must be verified in the dashboard before it can be used.
	From *string `json:"from,omitempty"`
	// Optional from name if not passed with address. If you set `useInboxName` to `true` the from field will include the inbox name as a display name
	FromName *string `json:"fromName,omitempty"`
	// Optional list of cc destination email addresses
	Cc *[]string `json:"cc,omitempty"`
	// Optional list of bcc destination email addresses
	Bcc *[]string `json:"bcc,omitempty"`
	// Optional email subject line
	Subject *string `json:"subject,omitempty"`
	// Optional replyTo header
	ReplyTo *string `json:"replyTo,omitempty"`
	// Optional custom headers
	CustomHeaders *map[string]string `json:"customHeaders,omitempty"`
	// Optional contents of email. If body contains HTML then set `isHTML` to true to ensure that email clients render it correctly. You can use moustache template syntax in the email body in conjunction with `toGroup` contact variables or `templateVariables` data. If you need more templating control consider creating a template and using the `template` property instead of the body.
	Body *string `json:"body,omitempty"`
	// Optional HTML flag to indicate that contents is HTML. Set's a `content-type: text/html` for email. (Deprecated: use `isHTML` instead.)
	Html *bool `json:"html,omitempty"`
	// Optional HTML flag. If true the `content-type` of the email will be `text/html`. Set to true when sending HTML to ensure proper rending on email clients
	IsHTML *bool `json:"isHTML,omitempty"`
	// Optional charset
	Charset *string `json:"charset,omitempty"`
	// Optional list of attachment IDs to send with this email. You must first upload each attachment separately via method call or dashboard in order to obtain attachment IDs. This way you can reuse attachments with different emails once uploaded. There are several ways to upload that support `multi-part form`, `base64 file encoding`, and octet stream binary uploads. See the `UploadController` for available methods.
	Attachments *[]string `json:"attachments,omitempty"`
	// Optional map of template variables. Will replace moustache syntax variables in subject and body or template with the associated values if found.
	TemplateVariables *map[string]map[string]interface{} `json:"templateVariables,omitempty"`
	// Optional template ID to use for body. Will override body if provided. When using a template make sure you pass the corresponding map of `templateVariables`. You can find which variables are needed by fetching the template itself or viewing it in the dashboard.
	Template *string `json:"template,omitempty"`
	// How an email should be sent based on its recipients
	SendStrategy *string `json:"sendStrategy,omitempty"`
	// Use name of inbox as sender email address name. Will construct RFC 5322 email address with `Inbox name <inbox@address.com>` if the inbox has a name.
	UseInboxName *bool `json:"useInboxName,omitempty"`
	// Add tracking pixel to email
	AddTrackingPixel *bool `json:"addTrackingPixel,omitempty"`
	// Filter recipients to remove any bounced recipients from to, bcc, and cc before sending
	FilterBouncedRecipients *bool `json:"filterBouncedRecipients,omitempty"`
	// Validate recipient email addresses before sending
	ValidateEmailAddresses *string `json:"validateEmailAddresses,omitempty"`
	// Ignore empty recipients after validation removes all recipients as invalid and fail silently
	IgnoreEmptyRecipients *bool `json:"ignoreEmptyRecipients,omitempty"`
	// Is content AMP4EMAIL compatible. If set will send as x-amp-html part.
	IsXAmpHtml *bool `json:"isXAmpHtml,omitempty"`
	// Email body content parts for multipart mime message. Will override body.
	BodyParts *[]SendEmailBodyPart `json:"bodyParts,omitempty"`
}

SendEmailOptions Options for the email to be sent

type SendEmailQueryOpts 

type SendEmailQueryOpts struct {
	SenderId optional.Interface
	Body     optional.String
	Subject  optional.String
}

SendEmailQueryOpts Optional parameters for the method 'SendEmailQuery'

type SendEmailSourceOptionalOpts 

type SendEmailSourceOptionalOpts struct {
	InboxId       optional.Interface
	UseDomainPool optional.Bool
	VirtualSend   optional.Bool
}

SendEmailSourceOptionalOpts Optional parameters for the method 'SendEmailSourceOptional'

type SendOptInConsentEmailOptions 

type SendOptInConsentEmailOptions struct {
	TemplateHtml string `json:"templateHtml"`
	Subject      string `json:"subject"`
	SenderInbox  string `json:"senderInbox,omitempty"`
}

SendOptInConsentEmailOptions struct for SendOptInConsentEmailOptions

type SendSmsOpts 

type SendSmsOpts struct {
	FromPhoneNumber optional.String
	FromPhoneId     optional.Interface
}

SendSmsOpts Optional parameters for the method 'SendSms'

type SendSmtpEnvelopeOptions 

type SendSmtpEnvelopeOptions struct {
	RcptTo   []string `json:"rcptTo"`
	MailFrom string   `json:"mailFrom"`
	Data     string   `json:"data"`
}

SendSmtpEnvelopeOptions Options for the email envelope

type SendWithQueueResult 

type SendWithQueueResult struct {
	Id            string    `json:"id"`
	UserId        string    `json:"userId"`
	Subject       string    `json:"subject,omitempty"`
	InboxId       string    `json:"inboxId,omitempty"`
	HeaderId      string    `json:"headerId"`
	Delivered     bool      `json:"delivered"`
	ExceptionName string    `json:"exceptionName,omitempty"`
	Message       string    `json:"message,omitempty"`
	CreatedAt     time.Time `json:"createdAt"`
	UpdatedAt     time.Time `json:"updatedAt"`
}

SendWithQueueResult struct for SendWithQueueResult

type SendWithScheduleOpts 

type SendWithScheduleOpts struct {
	SendAtTimestamp       optional.Time
	SendAtNowPlusSeconds  optional.Int64
	ValidateBeforeEnqueue optional.Bool
}

SendWithScheduleOpts Optional parameters for the method 'SendWithSchedule'

type Sender 

type Sender struct {
	RawValue     string `json:"rawValue"`
	EmailAddress string `json:"emailAddress"`
	Name         string `json:"name,omitempty"`
}

Sender Sender object containing from email address and from personal name if provided in address

type SenderProjection 

type SenderProjection struct {
	Name         string `json:"name,omitempty"`
	EmailAddress string `json:"emailAddress"`
	RawValue     string `json:"rawValue"`
}

SenderProjection Last sender object

type SentEmailDto 

type SentEmailDto struct {
	// ID of sent email
	Id string `json:"id"`
	// User ID
	UserId string `json:"userId"`
	// Inbox ID email was sent from
	InboxId string `json:"inboxId"`
	// Domain ID
	DomainId *string `json:"domainId,omitempty"`
	// Recipients email was sent to
	To *[]string `json:"to,omitempty"`
	// Sent from address
	From       *string          `json:"from,omitempty"`
	Sender     *Sender          `json:"sender,omitempty"`
	Recipients *EmailRecipients `json:"recipients,omitempty"`
	ReplyTo    *string          `json:"replyTo,omitempty"`
	Cc         *[]string        `json:"cc,omitempty"`
	Bcc        *[]string        `json:"bcc,omitempty"`
	// Array of IDs of attachments that were sent with this email
	Attachments *[]string `json:"attachments,omitempty"`
	Subject     *string   `json:"subject,omitempty"`
	// MD5 Hash
	BodyMD5Hash *string `json:"bodyMD5Hash,omitempty"`
	// Sent email body
	Body       *string   `json:"body,omitempty"`
	ToContacts *[]string `json:"toContacts,omitempty"`
	ToGroup    *string   `json:"toGroup,omitempty"`
	Charset    *string   `json:"charset,omitempty"`
	IsHTML     *bool     `json:"isHTML,omitempty"`
	SentAt     time.Time `json:"sentAt"`
	CreatedAt  time.Time `json:"createdAt"`
	PixelIds   *[]string `json:"pixelIds,omitempty"`
	// RFC 5322 Message-ID header value without angle brackets.
	MessageId         *string                            `json:"messageId,omitempty"`
	MessageIds        *[]string                          `json:"messageIds,omitempty"`
	VirtualSend       *bool                              `json:"virtualSend,omitempty"`
	TemplateId        *string                            `json:"templateId,omitempty"`
	TemplateVariables *map[string]map[string]interface{} `json:"templateVariables,omitempty"`
	Headers           *map[string]string                 `json:"headers,omitempty"`
	// MailSlurp thread ID for email chain that enables lookup for In-Reply-To and References fields.
	ThreadId *string `json:"threadId,omitempty"`
	// An excerpt of the body of the email message for quick preview. Takes HTML content part if exists falls back to TEXT content part if not
	BodyExcerpt *string `json:"bodyExcerpt,omitempty"`
	// An excerpt of the body of the email message for quick preview. Takes TEXT content part if exists
	TextExcerpt *string `json:"textExcerpt,omitempty"`
	// Parsed value of In-Reply-To header. A Message-ID in a thread.
	InReplyTo *string `json:"inReplyTo,omitempty"`
	// Is email favourited
	Favourite *bool `json:"favourite,omitempty"`
	// Size of raw email message in bytes
	SizeBytes *int64 `json:"sizeBytes,omitempty"`
	Html      bool   `json:"html,omitempty"`
}

SentEmailDto Sent email details

type SentEmailProjection 

type SentEmailProjection struct {
	Id          string           `json:"id"`
	ThreadId    *string          `json:"threadId,omitempty"`
	From        *string          `json:"from,omitempty"`
	Subject     *string          `json:"subject,omitempty"`
	Sender      *Sender          `json:"sender,omitempty"`
	Recipients  *EmailRecipients `json:"recipients,omitempty"`
	UserId      string           `json:"userId"`
	InboxId     string           `json:"inboxId"`
	Attachments *[]string        `json:"attachments,omitempty"`
	CreatedAt   time.Time        `json:"createdAt"`
	To          []string         `json:"to,omitempty"`
	Cc          []string         `json:"cc,omitempty"`
	Bcc         []string         `json:"bcc,omitempty"`
	MessageId   *string          `json:"messageId,omitempty"`
	InReplyTo   *string          `json:"inReplyTo,omitempty"`
	VirtualSend bool             `json:"virtualSend"`
	BodyExcerpt *string          `json:"bodyExcerpt,omitempty"`
	TextExcerpt *string          `json:"textExcerpt,omitempty"`
	BodyMD5Hash *string          `json:"bodyMD5Hash,omitempty"`
}

SentEmailProjection struct for SentEmailProjection

type SentEmailsControllerApiService 

type SentEmailsControllerApiService service

SentEmailsControllerApiService SentEmailsControllerApi service

func (*SentEmailsControllerApiService) DeleteAllSentEmails 

func (a *SentEmailsControllerApiService) DeleteAllSentEmails(ctx _context.Context) (*_nethttp.Response, error)

DeleteAllSentEmails Delete all sent email receipts

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*SentEmailsControllerApiService) DeleteSentEmail 

func (a *SentEmailsControllerApiService) DeleteSentEmail(ctx _context.Context, id string) (*_nethttp.Response, error)

DeleteSentEmail Delete sent email receipt

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

func (*SentEmailsControllerApiService) GetAllSentTrackingPixels 

func (a *SentEmailsControllerApiService) GetAllSentTrackingPixels(ctx _context.Context, localVarOptionals *GetAllSentTrackingPixelsOpts) (PageTrackingPixelProjection, *_nethttp.Response, error)

GetAllSentTrackingPixels Method for GetAllSentTrackingPixels Get all sent email tracking pixels in paginated form

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAllSentTrackingPixelsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in sent email tracking pixel list pagination
  • @param "Size" (optional.Int32) - Optional page size in sent email tracking pixel list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "SearchFilter" (optional.String) - Optional search filter
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return PageTrackingPixelProjection

func (*SentEmailsControllerApiService) GetRawSentEmailContents 

func (a *SentEmailsControllerApiService) GetRawSentEmailContents(ctx _context.Context, emailId string) (*_nethttp.Response, error)

GetRawSentEmailContents Get raw sent email string. Returns unparsed raw SMTP message with headers and body. Returns a raw, unparsed, and unprocessed sent email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawSentEmailJson endpoint

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId ID of email

func (*SentEmailsControllerApiService) GetRawSentEmailJson 

func (a *SentEmailsControllerApiService) GetRawSentEmailJson(ctx _context.Context, emailId string) (RawEmailJson, *_nethttp.Response, error)

GetRawSentEmailJson Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format. Returns a raw, unparsed, and unprocessed sent email wrapped in a JSON response object for easier handling when compared with the getRawSentEmail text/plain response

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId ID of email

@return RawEmailJson

func (*SentEmailsControllerApiService) GetSentDeliveryStatus 

func (a *SentEmailsControllerApiService) GetSentDeliveryStatus(ctx _context.Context, deliveryId string) (DeliveryStatusDto, *_nethttp.Response, error)

GetSentDeliveryStatus Method for GetSentDeliveryStatus Get a sent email delivery status

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deliveryId

@return DeliveryStatusDto

func (*SentEmailsControllerApiService) GetSentDeliveryStatuses 

func (a *SentEmailsControllerApiService) GetSentDeliveryStatuses(ctx _context.Context, localVarOptionals *GetSentDeliveryStatusesOpts) (PageDeliveryStatus, *_nethttp.Response, error)

GetSentDeliveryStatuses Method for GetSentDeliveryStatuses Get all sent email delivery statuses

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetSentDeliveryStatusesOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in delivery status list pagination
  • @param "Size" (optional.Int32) - Optional page size in delivery status list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return PageDeliveryStatus

func (*SentEmailsControllerApiService) GetSentDeliveryStatusesBySentId 

func (a *SentEmailsControllerApiService) GetSentDeliveryStatusesBySentId(ctx _context.Context, sentId string, localVarOptionals *GetSentDeliveryStatusesBySentIdOpts) (PageDeliveryStatus, *_nethttp.Response, error)

GetSentDeliveryStatusesBySentId Method for GetSentDeliveryStatusesBySentId Get all sent email delivery statuses

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param sentId ID of the sent email that you want to get the delivery status of. Sent email object is returned when sending an email
  • @param optional nil or *GetSentDeliveryStatusesBySentIdOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in delivery status list pagination
  • @param "Size" (optional.Int32) - Optional page size in delivery status list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return PageDeliveryStatus

func (*SentEmailsControllerApiService) GetSentEmail 

func (a *SentEmailsControllerApiService) GetSentEmail(ctx _context.Context, id string) (SentEmailDto, *_nethttp.Response, error)

GetSentEmail Get sent email receipt

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

@return SentEmailDto

func (*SentEmailsControllerApiService) GetSentEmailHTMLContent 

func (a *SentEmailsControllerApiService) GetSentEmailHTMLContent(ctx _context.Context, id string) (string, *_nethttp.Response, error)

GetSentEmailHTMLContent Get sent email HTML content

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

@return string

func (*SentEmailsControllerApiService) GetSentEmailPreviewURLs 

func (a *SentEmailsControllerApiService) GetSentEmailPreviewURLs(ctx _context.Context, id string) (EmailPreviewUrls, *_nethttp.Response, error)

GetSentEmailPreviewURLs Get sent email URL for viewing in browser or downloading Get a list of URLs for sent email content as text/html or raw SMTP message for viewing the message in a browser.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

@return EmailPreviewUrls

func (*SentEmailsControllerApiService) GetSentEmailTrackingPixels 

func (a *SentEmailsControllerApiService) GetSentEmailTrackingPixels(ctx _context.Context, id string, localVarOptionals *GetSentEmailTrackingPixelsOpts) (PageTrackingPixelProjection, *_nethttp.Response, error)

GetSentEmailTrackingPixels Method for GetSentEmailTrackingPixels Get all tracking pixels for a sent email in paginated form

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param optional nil or *GetSentEmailTrackingPixelsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in sent email tracking pixel list pagination
  • @param "Size" (optional.Int32) - Optional page size in sent email tracking pixel list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "SearchFilter" (optional.String) - Optional search filter
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return PageTrackingPixelProjection

func (*SentEmailsControllerApiService) GetSentEmails 

func (a *SentEmailsControllerApiService) GetSentEmails(ctx _context.Context, localVarOptionals *GetSentEmailsOpts) (PageSentEmailProjection, *_nethttp.Response, error)

GetSentEmails Get all sent emails in paginated form

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetSentEmailsOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Optional inboxId to filter sender of sent emails by
  • @param "Page" (optional.Int32) - Optional page index in inbox sent email list pagination
  • @param "Size" (optional.Int32) - Optional page size in inbox sent email list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "SearchFilter" (optional.String) - Optional search filter
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return PageSentEmailProjection

func (*SentEmailsControllerApiService) GetSentEmailsWithQueueResults 

func (a *SentEmailsControllerApiService) GetSentEmailsWithQueueResults(ctx _context.Context, localVarOptionals *GetSentEmailsWithQueueResultsOpts) (PageSentEmailWithQueueProjection, *_nethttp.Response, error)

GetSentEmailsWithQueueResults Get results of email sent with queues in paginated form

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetSentEmailsWithQueueResultsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in inbox sent email list pagination
  • @param "Size" (optional.Int32) - Optional page size in inbox sent email list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return PageSentEmailWithQueueProjection

func (*SentEmailsControllerApiService) GetSentOrganizationEmails 

func (a *SentEmailsControllerApiService) GetSentOrganizationEmails(ctx _context.Context, localVarOptionals *GetSentOrganizationEmailsOpts) (PageSentEmailProjection, *_nethttp.Response, error)

GetSentOrganizationEmails Method for GetSentOrganizationEmails Get all sent organization emails in paginated form

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetSentOrganizationEmailsOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Optional inboxId to filter sender of sent emails by
  • @param "Page" (optional.Int32) - Optional page index in sent email list pagination
  • @param "Size" (optional.Int32) - Optional page size in sent email list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "SearchFilter" (optional.String) - Optional search filter
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return PageSentEmailProjection

func (*SentEmailsControllerApiService) WaitForDeliveryStatuses 

func (a *SentEmailsControllerApiService) WaitForDeliveryStatuses(ctx _context.Context, localVarOptionals *WaitForDeliveryStatusesOpts) (DeliveryStatusDto, *_nethttp.Response, error)

WaitForDeliveryStatuses Method for WaitForDeliveryStatuses Wait for delivery statuses

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *WaitForDeliveryStatusesOpts - Optional Parameters:
  • @param "SentId" (optional.Interface of string) - Optional sent email ID filter
  • @param "InboxId" (optional.Interface of string) - Optional inbox ID filter
  • @param "Timeout" (optional.Int64) - Optional timeout milliseconds
  • @param "Index" (optional.Int32) - Zero based index of the delivery status to wait for. If 1 delivery status already and you want to wait for the 2nd pass index=1
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return DeliveryStatusDto

type SentSmsDto 

type SentSmsDto struct {
	Id          string    `json:"id"`
	UserId      string    `json:"userId"`
	PhoneNumber string    `json:"phoneNumber"`
	FromNumber  string    `json:"fromNumber"`
	ToNumber    string    `json:"toNumber"`
	Body        string    `json:"body"`
	Sid         string    `json:"sid"`
	ReplyToSid  string    `json:"replyToSid,omitempty"`
	ReplyToId   string    `json:"replyToId,omitempty"`
	CreatedAt   time.Time `json:"createdAt"`
	UpdatedAt   time.Time `json:"updatedAt"`
}

SentSmsDto struct for SentSmsDto

type SentSmsProjection 

type SentSmsProjection struct {
	Id          string    `json:"id"`
	Body        string    `json:"body"`
	UserId      string    `json:"userId"`
	CreatedAt   time.Time `json:"createdAt"`
	PhoneNumber string    `json:"phoneNumber"`
	FromNumber  string    `json:"fromNumber"`
	ToNumber    string    `json:"toNumber"`
	ReplyToId   string    `json:"replyToId,omitempty"`
}

SentSmsProjection Sent SMS projection

type ServerConfiguration 

type ServerConfiguration struct {
	Url         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerEndpoints 

type ServerEndpoints struct {
	Host     string  `json:"host"`
	Port     int32   `json:"port"`
	Tls      bool    `json:"tls"`
	AltPorts []int32 `json:"altPorts"`
}

ServerEndpoints struct for ServerEndpoints

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type SetInboxFavouritedOptions 

type SetInboxFavouritedOptions struct {
	// Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering
	State bool `json:"state"`
}

SetInboxFavouritedOptions Options for setting inbox favourite state

type SetPhoneFavouritedOptions 

type SetPhoneFavouritedOptions struct {
	// Phone favourite state
	State bool `json:"state"`
}

SetPhoneFavouritedOptions Options for setting phone favourite state

type SimpleSendEmailOptions 

type SimpleSendEmailOptions struct {
	// ID of inbox to send from. If null an inbox will be created for sending
	SenderId *string `json:"senderId,omitempty"`
	// Email address to send to
	To string `json:"to"`
	// Body of the email message. Supports HTML
	Body *string `json:"body,omitempty"`
	// Subject line of the email
	Subject *string `json:"subject,omitempty"`
}

SimpleSendEmailOptions Simplified send email options

type SmsControllerApiService 

type SmsControllerApiService service

SmsControllerApiService SmsControllerApi service

func (*SmsControllerApiService) DeleteSentSmsMessage 

func (a *SmsControllerApiService) DeleteSentSmsMessage(ctx _context.Context, sentSmsId string) (*_nethttp.Response, error)

DeleteSentSmsMessage Delete sent SMS message. Delete a sent SMS message

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param sentSmsId

func (*SmsControllerApiService) DeleteSentSmsMessages 

func (a *SmsControllerApiService) DeleteSentSmsMessages(ctx _context.Context, localVarOptionals *DeleteSentSmsMessagesOpts) (*_nethttp.Response, error)

DeleteSentSmsMessages Delete all sent SMS messages Delete all sent SMS messages or all messages for a given phone number

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *DeleteSentSmsMessagesOpts - Optional Parameters:
  • @param "PhoneNumberId" (optional.Interface of string) -

func (*SmsControllerApiService) DeleteSmsMessage 

func (a *SmsControllerApiService) DeleteSmsMessage(ctx _context.Context, smsId string) (*_nethttp.Response, error)

DeleteSmsMessage Delete SMS message. Delete an SMS message

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param smsId

func (*SmsControllerApiService) DeleteSmsMessages 

func (a *SmsControllerApiService) DeleteSmsMessages(ctx _context.Context, localVarOptionals *DeleteSmsMessagesOpts) (*_nethttp.Response, error)

DeleteSmsMessages Delete all SMS messages Delete all SMS messages or all messages for a given phone number

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *DeleteSmsMessagesOpts - Optional Parameters:
  • @param "PhoneNumberId" (optional.Interface of string) -

func (*SmsControllerApiService) GetAllSmsMessages 

func (a *SmsControllerApiService) GetAllSmsMessages(ctx _context.Context, localVarOptionals *GetAllSmsMessagesOpts) (PageSmsProjection, *_nethttp.Response, error)

GetAllSmsMessages Method for GetAllSmsMessages

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAllSmsMessagesOpts - Optional Parameters:
  • @param "PhoneNumber" (optional.Interface of string) - Optional receiving phone number to filter SMS messages for
  • @param "Page" (optional.Int32) - Optional page index in SMS list pagination
  • @param "Size" (optional.Int32) - Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Optional filter SMSs received after given date time
  • @param "Before" (optional.Time) - Optional filter SMSs received before given date time
  • @param "Search" (optional.String) - Optional search filter
  • @param "Favourite" (optional.Bool) - Optionally filter results for favourites only
  • @param "Include" (optional.Interface of []string) - Optional list of IDs to include in result

@return PageSmsProjection

func (*SmsControllerApiService) GetReplyForSmsMessage 

func (a *SmsControllerApiService) GetReplyForSmsMessage(ctx _context.Context, smsId string) (ReplyForSms, *_nethttp.Response, error)

GetReplyForSmsMessage Get reply for an SMS message Get reply for an SMS message.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param smsId

@return ReplyForSms

func (*SmsControllerApiService) GetSentSmsCount 

func (a *SmsControllerApiService) GetSentSmsCount(ctx _context.Context) (CountDto, *_nethttp.Response, error)

GetSentSmsCount Get sent SMS count Get number of sent SMS

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return CountDto

func (*SmsControllerApiService) GetSentSmsMessage 

func (a *SmsControllerApiService) GetSentSmsMessage(ctx _context.Context, sentSmsId string) (SentSmsDto, *_nethttp.Response, error)

GetSentSmsMessage Get sent SMS content including body. Expects sent SMS to exist by ID. Returns an SMS summary object with content.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param sentSmsId

@return SentSmsDto

func (*SmsControllerApiService) GetSentSmsMessagesPaginated 

func (a *SmsControllerApiService) GetSentSmsMessagesPaginated(ctx _context.Context, localVarOptionals *GetSentSmsMessagesPaginatedOpts) (PageSentSmsProjection, *_nethttp.Response, error)

GetSentSmsMessagesPaginated Get all SMS messages in all phone numbers in paginated form. . By default returns all SMS messages across all phone numbers sorted by ascending created at date. Responses are paginated. You can restrict results to a list of phone number IDs. You can also filter out read messages

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetSentSmsMessagesPaginatedOpts - Optional Parameters:
  • @param "PhoneNumber" (optional.Interface of string) - Optional phone number to filter sent SMS messages for
  • @param "Page" (optional.Int32) - Optional page index in SMS list pagination
  • @param "Size" (optional.Int32) - Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Optional filter SMSs received after given date time
  • @param "Before" (optional.Time) - Optional filter SMSs received before given date time
  • @param "Search" (optional.String) - Optional search filter

@return PageSentSmsProjection

func (*SmsControllerApiService) GetSmsCodes 

func (a *SmsControllerApiService) GetSmsCodes(ctx _context.Context, smsId string, localVarOptionals *GetSmsCodesOpts) (ExtractCodesResult, *_nethttp.Response, error)

GetSmsCodes Extract verification codes from an SMS Extract one-time passcodes and verification tokens from SMS body content. Deterministic &#x60;PATTERN&#x60; extraction is available now. Use method flags to control fallback behavior for QA.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param smsId ID of SMS to extract codes from
  • @param optional nil or *GetSmsCodesOpts - Optional Parameters:
  • @param "ExtractCodesOptions" (optional.Interface of ExtractCodesOptions) -

@return ExtractCodesResult

func (*SmsControllerApiService) GetSmsCount 

func (a *SmsControllerApiService) GetSmsCount(ctx _context.Context) (CountDto, *_nethttp.Response, error)

GetSmsCount Get SMS count Get number of SMS

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return CountDto

func (*SmsControllerApiService) GetSmsMessage 

func (a *SmsControllerApiService) GetSmsMessage(ctx _context.Context, smsId string) (SmsDto, *_nethttp.Response, error)

GetSmsMessage Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController. Returns a SMS summary object with content.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param smsId

@return SmsDto

func (*SmsControllerApiService) GetUnreadSmsCount 

func (a *SmsControllerApiService) GetUnreadSmsCount(ctx _context.Context) (UnreadCount, *_nethttp.Response, error)

GetUnreadSmsCount Get unread SMS count Get number of SMS unread. Unread means has not been viewed in dashboard or returned in an email API response

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return UnreadCount

func (*SmsControllerApiService) MarkAllSmsAsRead 

func (a *SmsControllerApiService) MarkAllSmsAsRead(ctx _context.Context, localVarOptionals *MarkAllSmsAsReadOpts) (*_nethttp.Response, error)

MarkAllSmsAsRead Mark all SMS messages as read or unread Sets read state for all SMS messages, optionally scoped to a single phone number. Use &#x60;read&#x3D;false&#x60; to reset unread state in bulk.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *MarkAllSmsAsReadOpts - Optional Parameters:
  • @param "Read" (optional.Bool) -
  • @param "PhoneNumberId" (optional.Interface of string) -

func (*SmsControllerApiService) MarkSmsAsRead 

func (a *SmsControllerApiService) MarkSmsAsRead(ctx _context.Context, smsId string, localVarOptionals *MarkSmsAsReadOpts) (SmsDto, *_nethttp.Response, error)

MarkSmsAsRead Mark an SMS as read or unread Sets read state for one SMS message. Useful when building custom inbox flows that need to restore unread state after inspection.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param smsId
  • @param optional nil or *MarkSmsAsReadOpts - Optional Parameters:
  • @param "Read" (optional.Bool) -

@return SmsDto

func (*SmsControllerApiService) ReplyToSmsMessage 

func (a *SmsControllerApiService) ReplyToSmsMessage(ctx _context.Context, smsId string, smsReplyOptions SmsReplyOptions) (SentSmsDto, *_nethttp.Response, error)

ReplyToSmsMessage Send a reply to a received SMS message. Replies are sent from the receiving number. Reply to an SMS message.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param smsId
  • @param smsReplyOptions

@return SentSmsDto

func (*SmsControllerApiService) SendSms 

func (a *SmsControllerApiService) SendSms(ctx _context.Context, smsSendOptions SmsSendOptions, localVarOptionals *SendSmsOpts) (SentSmsDto, *_nethttp.Response, error)

SendSms Method for SendSms

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param smsSendOptions
  • @param optional nil or *SendSmsOpts - Optional Parameters:
  • @param "FromPhoneNumber" (optional.String) - Phone number to send from in E.164 format
  • @param "FromPhoneId" (optional.Interface of string) - Phone number ID to send from in UUID form

@return SentSmsDto

func (*SmsControllerApiService) SetSmsFavourited 

func (a *SmsControllerApiService) SetSmsFavourited(ctx _context.Context, smsId string, favourited bool) (SmsDto, *_nethttp.Response, error)

SetSmsFavourited Method for SetSmsFavourited

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param smsId ID of SMS to set favourite state
  • @param favourited

@return SmsDto

type SmsDto 

type SmsDto struct {
	Id          string    `json:"id"`
	UserId      string    `json:"userId"`
	PhoneNumber string    `json:"phoneNumber"`
	FromNumber  string    `json:"fromNumber"`
	ToNumber    string    `json:"toNumber,omitempty"`
	Favourite   bool      `json:"favourite"`
	Body        string    `json:"body"`
	Read        bool      `json:"read"`
	CreatedAt   time.Time `json:"createdAt"`
	UpdatedAt   time.Time `json:"updatedAt"`
}

SmsDto struct for SmsDto

type SmsMatchOption 

type SmsMatchOption struct {
	// Fields of an SMS object that can be used to filter results
	Field string `json:"field"`
	// How the value of the email field specified should be compared to the value given in the match options.
	Should string `json:"should"`
	// The value you wish to compare with the value of the field specified using the `should` value passed. For example `BODY` should `CONTAIN` a value passed.
	Value string `json:"value"`
}

SmsMatchOption Options for matching SMS messages in a phone number. Each match option object contains a `field`, `should` and `value` property. Together they form logical conditions such as `BODY` should `CONTAIN` value.

type SmsPreview 

type SmsPreview struct {
	Id     string `json:"id"`
	UserId string `json:"userId"`
	// TXT message content
	Body string `json:"body"`
	// ID of the phone number that received this SMS
	PhoneNumber string `json:"phoneNumber"`
	// Sender number
	FromNumber string `json:"fromNumber"`
	// Is the message read or unread
	Read      bool      `json:"read"`
	CreatedAt time.Time `json:"createdAt"`
}

SmsPreview struct for SmsPreview

type SmsProjection 

type SmsProjection struct {
	Id          string    `json:"id"`
	Body        string    `json:"body"`
	UserId      string    `json:"userId"`
	CreatedAt   time.Time `json:"createdAt"`
	PhoneNumber string    `json:"phoneNumber"`
	FromNumber  string    `json:"fromNumber"`
	Read        bool      `json:"read"`
}

SmsProjection SMS projection

type SmsReplyOptions 

type SmsReplyOptions struct {
	Body string `json:"body"`
}

SmsReplyOptions struct for SmsReplyOptions

type SmsSendOptions 

type SmsSendOptions struct {
	To   string `json:"to"`
	Body string `json:"body"`
}

SmsSendOptions struct for SmsSendOptions

type SmtpAccessDetails 

type SmtpAccessDetails struct {
	// Secure TLS SMTP server host domain
	SecureSmtpServerHost string `json:"secureSmtpServerHost"`
	// Secure TLS SMTP server host port
	SecureSmtpServerPort int32 `json:"secureSmtpServerPort"`
	// Secure TLS SMTP username for login
	SecureSmtpUsername string `json:"secureSmtpUsername"`
	// Secure TLS SMTP password for login
	SecureSmtpPassword string `json:"secureSmtpPassword"`
	// SMTP server host domain
	SmtpServerHost string `json:"smtpServerHost"`
	// SMTP server host port
	SmtpServerPort int32 `json:"smtpServerPort"`
	// SMTP username for login
	SmtpUsername string `json:"smtpUsername"`
	// SMTP password for login
	SmtpPassword string `json:"smtpPassword"`
	// Mail from domain or SMTP HELO value
	MailFromDomain *string `json:"mailFromDomain,omitempty"`
}

SmtpAccessDetails Access details for inbox using SMTP

type SmtpAuthDiagnosticResult 

type SmtpAuthDiagnosticResult struct {
	Attempted bool    `json:"attempted"`
	Success   bool    `json:"success"`
	Mechanism *string `json:"mechanism,omitempty"`
}

SmtpAuthDiagnosticResult struct for SmtpAuthDiagnosticResult

type SmtpDiagnosticStep 

type SmtpDiagnosticStep struct {
	Step    string  `json:"step"`
	Code    *string `json:"code,omitempty"`
	Message string  `json:"message"`
}

SmtpDiagnosticStep Structured SMTP diagnostic transcript entry

type SmtpTlsDiagnosticResult 

type SmtpTlsDiagnosticResult struct {
	Supported  bool    `json:"supported"`
	Negotiated bool    `json:"negotiated"`
	Protocol   *string `json:"protocol,omitempty"`
	Cipher     *string `json:"cipher,omitempty"`
}

SmtpTlsDiagnosticResult struct for SmtpTlsDiagnosticResult

type SortObject 

type SortObject struct {
	Empty    bool `json:"empty,omitempty"`
	Sorted   bool `json:"sorted,omitempty"`
	Unsorted bool `json:"unsorted,omitempty"`
}

SortObject struct for SortObject

type SpellingIssue 

type SpellingIssue struct {
	Group      string `json:"group"`
	Suggestion string `json:"suggestion"`
	Severity   string `json:"severity"`
	Message    string `json:"message"`
}

SpellingIssue struct for SpellingIssue

type SpfMechanismResult 

type SpfMechanismResult struct {
	Kind      string `json:"kind"`
	Value     string `json:"value,omitempty"`
	Qualifier string `json:"qualifier,omitempty"`
}

SpfMechanismResult struct for SpfMechanismResult

type StructuredContentResultDto 

type StructuredContentResultDto struct {
	Result map[string]interface{} `json:"result"`
}

StructuredContentResultDto struct for StructuredContentResultDto

type StructuredOutputSchema 

type StructuredOutputSchema struct {
	AnyOf   *[]StructuredOutputSchema `json:"anyOf,omitempty"`
	Default *map[string]interface{}   `json:"default,omitempty"`
	// Provide a description of the schema to help the AI understand the schema.
	Description *string `json:"description,omitempty"`
	// When using type string and format enum pass a collection of enum values here.
	EnumValues *[]string               `json:"enumValues,omitempty"`
	Example    *map[string]interface{} `json:"example,omitempty"`
	// Format for string types. Can be null, date-time or enum.
	Format    *string                 `json:"format,omitempty"`
	Items     *StructuredOutputSchema `json:"items,omitempty"`
	MaxItems  *int64                  `json:"maxItems,omitempty"`
	MinItems  *int64                  `json:"minItems,omitempty"`
	MaxLength *int64                  `json:"maxLength,omitempty"`
	MinLength *int64                  `json:"minLength,omitempty"`
	// Regex pattern for STRING type
	Pattern *string `json:"pattern,omitempty"`
	// Properties of an OBJECT schema. These are key value pairs where the key is the property name and the value is the schema for that property.
	Properties *map[string]StructuredOutputSchema `json:"properties,omitempty"`
	// Pass an array of property names to specify the order of properties in the generated JSON object if required.
	PropertyOrdering *[]string `json:"propertyOrdering,omitempty"`
	// Is field required
	Required      *[]string `json:"required,omitempty"`
	MaxProperties *int64    `json:"maxProperties,omitempty"`
	MinProperties *int64    `json:"minProperties,omitempty"`
	Maximum       *float32  `json:"maximum,omitempty"`
	Minimum       *float32  `json:"minimum,omitempty"`
	Nullable      *bool     `json:"nullable,omitempty"`
	Title         *string   `json:"title,omitempty"`
	// Primitive JSON schema types with a fallback CUSTOM for unknown values.
	Type *string `json:"type,omitempty"`
}

StructuredOutputSchema JSON output schema for structured content repsonses. This schema dictates the format that an AI should use when responding to your instructions.

type StructuredOutputSchemaValidation 

type StructuredOutputSchemaValidation struct {
	Valid         bool     `json:"valid"`
	Errors        []string `json:"errors,omitempty"`
	ExampleOutput string   `json:"exampleOutput,omitempty"`
}

StructuredOutputSchemaValidation struct for StructuredOutputSchemaValidation

type SubmitFormOpts 

type SubmitFormOpts struct {
	To              optional.String
	Subject         optional.String
	EmailAddress    optional.String
	SuccessMessage  optional.String
	SpamCheck       optional.String
	OtherParameters optional.String
}

SubmitFormOpts Optional parameters for the method 'SubmitForm'

type SyncConnectorOpts 

type SyncConnectorOpts struct {
	Since   optional.Time
	Folder  optional.String
	Logging optional.Bool
}

SyncConnectorOpts Optional parameters for the method 'SyncConnector'

type TemplateControllerApiService 

type TemplateControllerApiService service

TemplateControllerApiService TemplateControllerApi service

func (*TemplateControllerApiService) CreateTemplate 

func (a *TemplateControllerApiService) CreateTemplate(ctx _context.Context, createTemplateOptions CreateTemplateOptions) (TemplateDto, *_nethttp.Response, error)

CreateTemplate Create a Template Create an email template with variables for use with templated transactional emails.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createTemplateOptions

@return TemplateDto

func (*TemplateControllerApiService) DeleteTemplate 

func (a *TemplateControllerApiService) DeleteTemplate(ctx _context.Context, templateId string) (*_nethttp.Response, error)

DeleteTemplate Delete email template Delete template

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param templateId Template ID

func (*TemplateControllerApiService) GetAllTemplates 

func (a *TemplateControllerApiService) GetAllTemplates(ctx _context.Context, localVarOptionals *GetAllTemplatesOpts) (PageTemplateProjection, *_nethttp.Response, error)

GetAllTemplates List templates Get all templates in paginated format

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAllTemplatesOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size in list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return PageTemplateProjection

func (*TemplateControllerApiService) GetTemplate 

func (a *TemplateControllerApiService) GetTemplate(ctx _context.Context, templateId string) (TemplateDto, *_nethttp.Response, error)

GetTemplate Get template Get email template

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param templateId Template ID

@return TemplateDto

func (*TemplateControllerApiService) GetTemplatePreviewHtml 

func (a *TemplateControllerApiService) GetTemplatePreviewHtml(ctx _context.Context, templateId string) (string, *_nethttp.Response, error)

GetTemplatePreviewHtml Get template preview HTML Get email template preview with passed template variables in HTML format for browsers. Pass template variables as query params.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param templateId Template ID

@return string

func (*TemplateControllerApiService) GetTemplatePreviewJson 

func (a *TemplateControllerApiService) GetTemplatePreviewJson(ctx _context.Context, templateId string) (TemplatePreview, *_nethttp.Response, error)

GetTemplatePreviewJson Get template preview Json Get email template preview with passed template variables in JSON format. Pass template variables as query params.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param templateId Template ID

@return TemplatePreview

func (*TemplateControllerApiService) GetTemplates 

func (a *TemplateControllerApiService) GetTemplates(ctx _context.Context) ([]TemplateProjection, *_nethttp.Response, error)

GetTemplates List templates Get all templates

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []TemplateProjection

func (*TemplateControllerApiService) UpdateTemplate 

func (a *TemplateControllerApiService) UpdateTemplate(ctx _context.Context, templateId string, createTemplateOptions CreateTemplateOptions) (TemplateDto, *_nethttp.Response, error)

UpdateTemplate Update template Update email template

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param templateId Template ID
  • @param createTemplateOptions

@return TemplateDto

type TemplateDto 

type TemplateDto struct {
	// ID of template
	Id string `json:"id"`
	// Template name
	Name string `json:"name"`
	// Variables available in template that can be replaced with values
	Variables []TemplateVariable `json:"variables"`
	// Content of the template
	Content string `json:"content"`
	// Created at time
	CreatedAt time.Time `json:"createdAt"`
}

TemplateDto Email template

type TemplatePreview 

type TemplatePreview struct {
	Preview string `json:"preview"`
}

TemplatePreview struct for TemplatePreview

type TemplateProjection 

type TemplateProjection struct {
	Name      string    `json:"name"`
	Id        string    `json:"id"`
	UpdatedAt time.Time `json:"updatedAt"`
	CreatedAt time.Time `json:"createdAt"`
	Variables []string  `json:"variables"`
}

TemplateProjection Email template data

type TemplateVariable 

type TemplateVariable struct {
	// Name of variable. This can be used in a template as {{name}}
	Name string `json:"name"`
	// The type of variable
	VariableType string `json:"variableType"`
}

TemplateVariable Variable for use with email template

type TenantReputationFindingDto 

type TenantReputationFindingDto struct {
	AccountRegion        string    `json:"accountRegion"`
	TenantName           string    `json:"tenantName"`
	TenantArn            string    `json:"tenantArn,omitempty"`
	Type                 string    `json:"type,omitempty"`
	Impact               string    `json:"impact,omitempty"`
	Status               string    `json:"status,omitempty"`
	Description          string    `json:"description,omitempty"`
	CreatedTimestamp     time.Time `json:"createdTimestamp,omitempty"`
	LastUpdatedTimestamp time.Time `json:"lastUpdatedTimestamp,omitempty"`
}

TenantReputationFindingDto struct for TenantReputationFindingDto

type TenantReputationFindingsDto 

type TenantReputationFindingsDto struct {
	GeneratedAt time.Time                    `json:"generatedAt"`
	UserId      string                       `json:"userId"`
	Findings    []TenantReputationFindingDto `json:"findings"`
}

TenantReputationFindingsDto struct for TenantReputationFindingsDto

type TenantReputationStatusRowDto 

type TenantReputationStatusRowDto struct {
	AccountRegion                string    `json:"accountRegion"`
	TenantName                   string    `json:"tenantName"`
	TenantArn                    string    `json:"tenantArn,omitempty"`
	SendingStatus                string    `json:"sendingStatus,omitempty"`
	ReputationStatus             string    `json:"reputationStatus,omitempty"`
	ReputationPolicy             string    `json:"reputationPolicy,omitempty"`
	CustomerManagedSendingStatus string    `json:"customerManagedSendingStatus,omitempty"`
	AwsManagedSendingStatus      string    `json:"awsManagedSendingStatus,omitempty"`
	FindingCount                 int32     `json:"findingCount"`
	BounceRate                   float64   `json:"bounceRate,omitempty"`
	ComplaintRate                float64   `json:"complaintRate,omitempty"`
	SendLastHour                 float64   `json:"sendLastHour,omitempty"`
	MetricTimestamp              time.Time `json:"metricTimestamp,omitempty"`
	Error                        string    `json:"error,omitempty"`
}

TenantReputationStatusRowDto struct for TenantReputationStatusRowDto

type TenantReputationStatusSummaryDto 

type TenantReputationStatusSummaryDto struct {
	GeneratedAt time.Time                      `json:"generatedAt"`
	UserId      string                         `json:"userId"`
	Rows        []TenantReputationStatusRowDto `json:"rows"`
}

TenantReputationStatusSummaryDto struct for TenantReputationStatusSummaryDto

type TestConnectorImapConnectionOpts 

type TestConnectorImapConnectionOpts struct {
	CreateConnectorImapConnectionOptions optional.Interface
}

TestConnectorImapConnectionOpts Optional parameters for the method 'TestConnectorImapConnection'

type TestConnectorSmtpConnectionOpts 

type TestConnectorSmtpConnectionOpts struct {
	CreateConnectorSmtpConnectionOptions optional.Interface
}

TestConnectorSmtpConnectionOpts Optional parameters for the method 'TestConnectorSmtpConnection'

type TestInboxRulesetSendingOptions 

type TestInboxRulesetSendingOptions struct {
	InboxId   *string `json:"inboxId,omitempty"`
	PhoneId   *string `json:"phoneId,omitempty"`
	Recipient string  `json:"recipient"`
}

TestInboxRulesetSendingOptions Test options for ruleset sending test

type TestNewInboxForwarderOptions 

type TestNewInboxForwarderOptions struct {
	InboxForwarderTestOptions   InboxForwarderTestOptions   `json:"inboxForwarderTestOptions"`
	CreateInboxForwarderOptions CreateInboxForwarderOptions `json:"createInboxForwarderOptions"`
}

TestNewInboxForwarderOptions Options for testing new inbox forwarder rules

type TestNewInboxRulesetOptions 

type TestNewInboxRulesetOptions struct {
	InboxRulesetTestOptions RulesetTestOptions   `json:"inboxRulesetTestOptions"`
	CreateRulesetOptions    CreateRulesetOptions `json:"createRulesetOptions"`
}

TestNewInboxRulesetOptions Test inbox ruleset options

type TestPhoneNumberOptions 

type TestPhoneNumberOptions struct {
	Message string `json:"message"`
}

TestPhoneNumberOptions struct for TestPhoneNumberOptions

type TestPhoneNumberSendSmsOpts 

type TestPhoneNumberSendSmsOpts struct {
	XTestId optional.String
}

TestPhoneNumberSendSmsOpts Optional parameters for the method 'TestPhoneNumberSendSms'

type TestRulesetReceivingOptions 

type TestRulesetReceivingOptions struct {
	InboxId    *string `json:"inboxId,omitempty"`
	PhoneId    *string `json:"phoneId,omitempty"`
	FromSender string  `json:"fromSender"`
}

TestRulesetReceivingOptions Test options for inbox ruleset receiving test or phone number receiving test

type TestRulesetReceivingResult 

type TestRulesetReceivingResult struct {
	CanReceive bool `json:"canReceive"`
}

TestRulesetReceivingResult struct for TestRulesetReceivingResult

type TestRulesetSendingResult 

type TestRulesetSendingResult struct {
	CanSend bool `json:"canSend"`
}

TestRulesetSendingResult struct for TestRulesetSendingResult

type TestSmtpServerOptions 

type TestSmtpServerOptions struct {
	// SMTP host name or IP address
	Host         string  `json:"host"`
	Port         int32   `json:"port"`
	UseStartTls  bool    `json:"useStartTls"`
	Username     *string `json:"username,omitempty"`
	Password     *string `json:"password,omitempty"`
	From         *string `json:"from,omitempty"`
	To           *string `json:"to,omitempty"`
	CaptchaToken *string `json:"captchaToken,omitempty"`
}

TestSmtpServerOptions struct for TestSmtpServerOptions

type TestSmtpServerResults 

type TestSmtpServerResults struct {
	Connected  bool                     `json:"connected"`
	Banner     *string                  `json:"banner,omitempty"`
	Tls        SmtpTlsDiagnosticResult  `json:"tls"`
	Auth       SmtpAuthDiagnosticResult `json:"auth"`
	Transcript []SmtpDiagnosticStep     `json:"transcript"`
	Warnings   []string                 `json:"warnings"`
	Errors     []string                 `json:"errors"`
}

TestSmtpServerResults struct for TestSmtpServerResults

type TestTransformerMappingMatchOpts 

type TestTransformerMappingMatchOpts struct {
	EmailId      optional.Interface
	SmsId        optional.Interface
	AttachmentId optional.String
}

TestTransformerMappingMatchOpts Optional parameters for the method 'TestTransformerMappingMatch'

type ToolsControllerApiService 

type ToolsControllerApiService service

ToolsControllerApiService ToolsControllerApi service

func (*ToolsControllerApiService) AnalyzeDmarcReport 

func (a *ToolsControllerApiService) AnalyzeDmarcReport(ctx _context.Context, analyzeDmarcReportOptions AnalyzeDmarcReportOptions) (AnalyzeDmarcReportResults, *_nethttp.Response, error)

AnalyzeDmarcReport Parse and summarize a DMARC aggregate XML report

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param analyzeDmarcReportOptions

@return AnalyzeDmarcReportResults

func (*ToolsControllerApiService) AnalyzeEmailHeaders 

func (a *ToolsControllerApiService) AnalyzeEmailHeaders(ctx _context.Context, analyzeEmailHeadersOptions AnalyzeEmailHeadersOptions) (AnalyzeEmailHeadersResults, *_nethttp.Response, error)

AnalyzeEmailHeaders Analyze email headers for auth results and delivery path

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param analyzeEmailHeadersOptions

@return AnalyzeEmailHeadersResults

func (*ToolsControllerApiService) CheckCampaignProbe 

func (a *ToolsControllerApiService) CheckCampaignProbe(ctx _context.Context, checkCampaignProbeOptions CheckCampaignProbeOptions) (CheckCampaignProbeResults, *_nethttp.Response, error)

CheckCampaignProbe Run a one-shot free campaign probe preflight check

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param checkCampaignProbeOptions

@return CheckCampaignProbeResults

func (*ToolsControllerApiService) CheckDnsPropagation 

func (a *ToolsControllerApiService) CheckDnsPropagation(ctx _context.Context, checkDnsPropagationOptions CheckDnsPropagationOptions) (CheckDnsPropagationResults, *_nethttp.Response, error)

CheckDnsPropagation Check DNS propagation for a host and record type across configured resolvers

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param checkDnsPropagationOptions

@return CheckDnsPropagationResults

func (*ToolsControllerApiService) CheckDomainMonitor 

func (a *ToolsControllerApiService) CheckDomainMonitor(ctx _context.Context, checkDomainMonitorOptions CheckDomainMonitorOptions) (CheckDomainMonitorResults, *_nethttp.Response, error)

CheckDomainMonitor Run a one-shot free domain monitor posture check

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param checkDomainMonitorOptions

@return CheckDomainMonitorResults

func (*ToolsControllerApiService) CheckEmailAudit 

func (a *ToolsControllerApiService) CheckEmailAudit(ctx _context.Context, checkEmailAuditOptions CheckEmailAuditOptions) (EmailAuditAnalysisResult, *_nethttp.Response, error)

CheckEmailAudit Run a one-shot free email audit across links, images, HTML, and client support

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param checkEmailAuditOptions

@return EmailAuditAnalysisResult

func (*ToolsControllerApiService) CheckEmailAuthStack 

func (a *ToolsControllerApiService) CheckEmailAuthStack(ctx _context.Context, checkEmailAuthStackOptions CheckEmailAuthStackOptions) (CheckEmailAuthStackResults, *_nethttp.Response, error)

CheckEmailAuthStack Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param checkEmailAuthStackOptions

@return CheckEmailAuthStackResults

func (*ToolsControllerApiService) CheckEmailBlacklist 

func (a *ToolsControllerApiService) CheckEmailBlacklist(ctx _context.Context, checkEmailBlacklistOptions CheckEmailBlacklistOptions) (CheckEmailBlacklistResults, *_nethttp.Response, error)

CheckEmailBlacklist Check whether a domain or IP appears on configured DNS blacklists

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param checkEmailBlacklistOptions

@return CheckEmailBlacklistResults

func (*ToolsControllerApiService) CheckEmailFeaturesClientSupport 

func (a *ToolsControllerApiService) CheckEmailFeaturesClientSupport(ctx _context.Context, checkEmailFeaturesClientSupportOptions CheckEmailFeaturesClientSupportOptions) (CheckEmailFeaturesClientSupportResults, *_nethttp.Response, error)

CheckEmailFeaturesClientSupport Check email client support for email HTML and CSS features

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param checkEmailFeaturesClientSupportOptions

@return CheckEmailFeaturesClientSupportResults

func (*ToolsControllerApiService) CreateNewFakeEmailAddress 

func (a *ToolsControllerApiService) CreateNewFakeEmailAddress(ctx _context.Context) (NewFakeEmailAddressResult, *_nethttp.Response, error)

CreateNewFakeEmailAddress Create a new email address using the fake email domains

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return NewFakeEmailAddressResult

func (*ToolsControllerApiService) DeleteNewFakeEmailAddress 

func (a *ToolsControllerApiService) DeleteNewFakeEmailAddress(ctx _context.Context, emailAddress string) (*_nethttp.Response, error)

DeleteNewFakeEmailAddress Delete a fake email address using the fake email domains Delete a fake email address using the fake email domains

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailAddress

func (*ToolsControllerApiService) GenerateBimiRecord 

func (a *ToolsControllerApiService) GenerateBimiRecord(ctx _context.Context, generateBimiRecordOptions GenerateBimiRecordOptions) (GenerateBimiRecordResults, *_nethttp.Response, error)

GenerateBimiRecord Create a BIMI record policy

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param generateBimiRecordOptions

@return GenerateBimiRecordResults

func (*ToolsControllerApiService) GenerateDmarcRecord 

func (a *ToolsControllerApiService) GenerateDmarcRecord(ctx _context.Context, generateDmarcRecordOptions GenerateDmarcRecordOptions) (GenerateDmarcRecordResults, *_nethttp.Response, error)

GenerateDmarcRecord Create a DMARC record policy

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param generateDmarcRecordOptions

@return GenerateDmarcRecordResults

func (*ToolsControllerApiService) GenerateMtaStsRecord 

func (a *ToolsControllerApiService) GenerateMtaStsRecord(ctx _context.Context, generateMtaStsRecordOptions GenerateMtaStsRecordOptions) (GenerateMtaStsRecordResults, *_nethttp.Response, error)

GenerateMtaStsRecord Create a TLS reporting record policy

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param generateMtaStsRecordOptions

@return GenerateMtaStsRecordResults

func (*ToolsControllerApiService) GenerateSpfRecord 

func (a *ToolsControllerApiService) GenerateSpfRecord(ctx _context.Context, generateSpfRecordOptions GenerateSpfRecordOptions) (GenerateSpfRecordResults, *_nethttp.Response, error)

GenerateSpfRecord Create an SPF record

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param generateSpfRecordOptions

@return GenerateSpfRecordResults

func (*ToolsControllerApiService) GenerateTlsReportingRecord 

func (a *ToolsControllerApiService) GenerateTlsReportingRecord(ctx _context.Context, generateTlsReportingRecordOptions GenerateTlsReportingRecordOptions) (GenerateTlsReportingRecordResults, *_nethttp.Response, error)

GenerateTlsReportingRecord Create a TLS reporting record policy

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param generateTlsReportingRecordOptions

@return GenerateTlsReportingRecordResults

func (*ToolsControllerApiService) GetFakeEmailByEmailAddress 

func (a *ToolsControllerApiService) GetFakeEmailByEmailAddress(ctx _context.Context, emailAddress string) (FakeEmailResult, *_nethttp.Response, error)

GetFakeEmailByEmailAddress Method for GetFakeEmailByEmailAddress

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailAddress

@return FakeEmailResult

func (*ToolsControllerApiService) GetFakeEmailById 

func (a *ToolsControllerApiService) GetFakeEmailById(ctx _context.Context, id string) (FakeEmailResult, *_nethttp.Response, error)

GetFakeEmailById Get a fake email by its ID Get a fake email by its ID

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

@return FakeEmailResult

func (*ToolsControllerApiService) GetFakeEmailRaw 

func (a *ToolsControllerApiService) GetFakeEmailRaw(ctx _context.Context, id string) (string, *_nethttp.Response, error)

GetFakeEmailRaw Get raw fake email content Retrieve the raw content of a fake email by its ID

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

@return string

func (*ToolsControllerApiService) GetFakeEmailsForAddress 

func (a *ToolsControllerApiService) GetFakeEmailsForAddress(ctx _context.Context, emailAddress string, localVarOptionals *GetFakeEmailsForAddressOpts) ([]FakeEmailPreview, *_nethttp.Response, error)

GetFakeEmailsForAddress Get fake emails for an address Get fake emails for an address

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailAddress
  • @param optional nil or *GetFakeEmailsForAddressOpts - Optional Parameters:
  • @param "Page" (optional.Int32) -

@return []FakeEmailPreview

func (*ToolsControllerApiService) LookupBimiDomain 

func (a *ToolsControllerApiService) LookupBimiDomain(ctx _context.Context, lookupBimiDomainOptions LookupBimiDomainOptions) (LookupBimiDomainResults, *_nethttp.Response, error)

LookupBimiDomain Lookup a BIMI record policy

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param lookupBimiDomainOptions

@return LookupBimiDomainResults

func (*ToolsControllerApiService) LookupDkimDomain 

func (a *ToolsControllerApiService) LookupDkimDomain(ctx _context.Context, lookupDkimDomainOptions LookupDkimDomainOptions) (LookupDkimDomainResults, *_nethttp.Response, error)

LookupDkimDomain Lookup and validate a DKIM record

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param lookupDkimDomainOptions

@return LookupDkimDomainResults

func (*ToolsControllerApiService) LookupDmarcDomain 

func (a *ToolsControllerApiService) LookupDmarcDomain(ctx _context.Context, lookupDmarcDomainOptions LookupDmarcDomainOptions) (LookupDmarcDomainResults, *_nethttp.Response, error)

LookupDmarcDomain Lookup a DMARC record policy

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param lookupDmarcDomainOptions

@return LookupDmarcDomainResults

func (*ToolsControllerApiService) LookupMtaStsDomain 

func (a *ToolsControllerApiService) LookupMtaStsDomain(ctx _context.Context, lookupMtaStsDomainOptions LookupMtaStsDomainOptions) (LookupMtaStsDomainResults, *_nethttp.Response, error)

LookupMtaStsDomain Lookup a MTA-STS domain policy

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param lookupMtaStsDomainOptions

@return LookupMtaStsDomainResults

func (*ToolsControllerApiService) LookupMxRecord 

func (a *ToolsControllerApiService) LookupMxRecord(ctx _context.Context, lookupMxRecordsOptions LookupMxRecordsOptions) (LookupMxRecordsResults, *_nethttp.Response, error)

LookupMxRecord Lookup a MX records for a domain

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param lookupMxRecordsOptions

@return LookupMxRecordsResults

func (*ToolsControllerApiService) LookupPtr 

func (a *ToolsControllerApiService) LookupPtr(ctx _context.Context, lookupPtrOptions LookupPtrOptions) (LookupPtrResults, *_nethttp.Response, error)

LookupPtr Lookup PTR records for an IP address

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param lookupPtrOptions

@return LookupPtrResults

func (*ToolsControllerApiService) LookupSpfDomain 

func (a *ToolsControllerApiService) LookupSpfDomain(ctx _context.Context, lookupSpfDomainOptions LookupSpfDomainOptions) (LookupSpfDomainResults, *_nethttp.Response, error)

LookupSpfDomain Lookup and validate an SPF record

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param lookupSpfDomainOptions

@return LookupSpfDomainResults

func (*ToolsControllerApiService) LookupTlsReportingDomain 

func (a *ToolsControllerApiService) LookupTlsReportingDomain(ctx _context.Context, lookupTlsReportingDomainOptions LookupTlsReportingDomainOptions) (LookupTlsReportingDomainResults, *_nethttp.Response, error)

LookupTlsReportingDomain Lookup a TLS reporting domain policy

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param lookupTlsReportingDomainOptions

@return LookupTlsReportingDomainResults

func (*ToolsControllerApiService) TestSmtpServer 

func (a *ToolsControllerApiService) TestSmtpServer(ctx _context.Context, testSmtpServerOptions TestSmtpServerOptions) (TestSmtpServerResults, *_nethttp.Response, error)

TestSmtpServer Run a conservative SMTP connectivity, TLS, and AUTH diagnostic

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param testSmtpServerOptions

@return TestSmtpServerResults

type TotpDeviceCodeDto 

type TotpDeviceCodeDto struct {
	Code      string     `json:"code"`
	ExpiresAt *time.Time `json:"expiresAt,omitempty"`
}

TotpDeviceCodeDto struct for TotpDeviceCodeDto

type TotpDeviceDto 

type TotpDeviceDto struct {
	Id        string    `json:"id"`
	Name      *string   `json:"name,omitempty"`
	Username  *string   `json:"username,omitempty"`
	Issuer    *string   `json:"issuer,omitempty"`
	Digits    *int32    `json:"digits,omitempty"`
	Period    *int32    `json:"period,omitempty"`
	Algorithm *string   `json:"algorithm,omitempty"`
	CreatedAt time.Time `json:"createdAt"`
	UpdatedAt time.Time `json:"updatedAt"`
}

TotpDeviceDto struct for TotpDeviceDto

type TotpDeviceOptionalDto 

type TotpDeviceOptionalDto struct {
	Device TotpDeviceDto `json:"device,omitempty"`
}

TotpDeviceOptionalDto struct for TotpDeviceOptionalDto

type TrackingControllerApiService 

type TrackingControllerApiService service

TrackingControllerApiService TrackingControllerApi service

func (*TrackingControllerApiService) CreateTrackingPixel 

func (a *TrackingControllerApiService) CreateTrackingPixel(ctx _context.Context, createTrackingPixelOptions CreateTrackingPixelOptions) (TrackingPixelDto, *_nethttp.Response, error)

CreateTrackingPixel Create tracking pixel Create a tracking pixel. A tracking pixel is an image that can be embedded in an email. When the email is viewed and the image is seen MailSlurp will mark the pixel as seen. Use tracking pixels to monitor email open events. You can receive open notifications via webhook or by fetching the pixel.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createTrackingPixelOptions

@return TrackingPixelDto

func (*TrackingControllerApiService) GetAllTrackingPixels 

func (a *TrackingControllerApiService) GetAllTrackingPixels(ctx _context.Context, localVarOptionals *GetAllTrackingPixelsOpts) (PageTrackingPixelProjection, *_nethttp.Response, error)

GetAllTrackingPixels Get tracking pixels List tracking pixels in paginated form

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAllTrackingPixelsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size in list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "SearchFilter" (optional.String) - Optional search filter
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@return PageTrackingPixelProjection

func (*TrackingControllerApiService) GetTrackingPixel 

func (a *TrackingControllerApiService) GetTrackingPixel(ctx _context.Context, id string) (TrackingPixelDto, *_nethttp.Response, error)

GetTrackingPixel Get pixel

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

@return TrackingPixelDto

type TrackingPixelDto 

type TrackingPixelDto struct {
	Id          string     `json:"id"`
	Seen        bool       `json:"seen"`
	Recipient   *string    `json:"recipient,omitempty"`
	Html        string     `json:"html"`
	Url         string     `json:"url"`
	InboxId     *string    `json:"inboxId,omitempty"`
	SentEmailId *string    `json:"sentEmailId,omitempty"`
	SeenAt      *time.Time `json:"seenAt,omitempty"`
	CreatedAt   time.Time  `json:"createdAt"`
}

TrackingPixelDto Tracking pixel

type TrackingPixelProjection 

type TrackingPixelProjection struct {
	Name        string    `json:"name,omitempty"`
	Id          string    `json:"id"`
	UserId      string    `json:"userId"`
	InboxId     string    `json:"inboxId,omitempty"`
	SentEmailId string    `json:"sentEmailId,omitempty"`
	CreatedAt   time.Time `json:"createdAt"`
	Recipient   string    `json:"recipient,omitempty"`
	Seen        bool      `json:"seen"`
	SeenAt      time.Time `json:"seenAt,omitempty"`
}

TrackingPixelProjection Tracking pixel data

type UnknownMissedEmailProjection 

type UnknownMissedEmailProjection struct {
	Id        string    `json:"id"`
	From      string    `json:"from,omitempty"`
	Subject   string    `json:"subject,omitempty"`
	CreatedAt time.Time `json:"createdAt"`
	To        []string  `json:"to,omitempty"`
}

UnknownMissedEmailProjection Unknown missed email projection

type UnreadCount 

type UnreadCount struct {
	Count int64 `json:"count"`
}

UnreadCount Number of unread entities

type UnseenErrorCountDto 

type UnseenErrorCountDto struct {
	Count int64 `json:"count"`
}

UnseenErrorCountDto Number of unseen errors

type UpdateAliasOptions 

type UpdateAliasOptions struct {
	// Optional name for alias
	Name *string `json:"name,omitempty"`
}

UpdateAliasOptions Update an email alias

type UpdateCampaignProbeOptions 

type UpdateCampaignProbeOptions struct {
	// Optional display name
	Name *string `json:"name,omitempty"`
	// Enable or disable SES monitor ingestion for this probe
	Enabled *bool `json:"enabled,omitempty"`
	// Scheduled run interval in seconds
	IntervalSeconds *int64 `json:"intervalSeconds,omitempty"`
	// Enable or disable scheduled campaign probe runs. Direct run-now remains available.
	SchedulingEnabled *bool `json:"schedulingEnabled,omitempty"`
}

UpdateCampaignProbeOptions Update options for a campaign probe

type UpdateDeliverabilityTestOptions 

type UpdateDeliverabilityTestOptions struct {
	// Optional updated name
	Name *string `json:"name,omitempty"`
	// Optional updated description
	Description *string `json:"description,omitempty"`
	// Optional updated receive-window start time. Only applied while test is not terminal.
	StartAt *time.Time `json:"startAt,omitempty"`
	// Optional updated timeout in seconds
	MaxDurationSeconds *int64 `json:"maxDurationSeconds,omitempty"`
	// Set true to clear timeout. If true, maxDurationSeconds is ignored for this request.
	ClearMaxDuration *bool `json:"clearMaxDuration,omitempty"`
	// Optional updated acceptable success threshold percentage (0,100].
	SuccessThresholdPercent *float64 `json:"successThresholdPercent,omitempty"`
	// Set true to clear success threshold. If true, successThresholdPercent is ignored for this request.
	ClearSuccessThreshold *bool `json:"clearSuccessThreshold,omitempty"`
	// Optional replacement expectations
	Expectations *[]DeliverabilityExpectation `json:"expectations,omitempty"`
}

UpdateDeliverabilityTestOptions Update a deliverability/load test

type UpdateDevicePreviewFeedbackOptions 

type UpdateDevicePreviewFeedbackOptions struct {
	Status             string            `json:"status,omitempty"`
	Rating             int32             `json:"rating,omitempty"`
	Title              string            `json:"title,omitempty"`
	Comment            string            `json:"comment,omitempty"`
	InternalNote       string            `json:"internalNote,omitempty"`
	AppendInternalNote bool              `json:"appendInternalNote,omitempty"`
	SessionId          string            `json:"sessionId,omitempty"`
	LiveViewUrl        string            `json:"liveViewUrl,omitempty"`
	Metadata           map[string]string `json:"metadata,omitempty"`
}

UpdateDevicePreviewFeedbackOptions struct for UpdateDevicePreviewFeedbackOptions

type UpdateDomainMonitorOptions 

type UpdateDomainMonitorOptions struct {
	// Optional display name
	Name *string `json:"name,omitempty"`
	// Interval in seconds
	IntervalSeconds *int64 `json:"intervalSeconds,omitempty"`
	// Enable/disable scheduled monitor runs (legacy alias for schedulingEnabled)
	Enabled *bool `json:"enabled,omitempty"`
	// Enable/disable scheduled monitor runs. Direct run-now remains available.
	SchedulingEnabled *bool `json:"schedulingEnabled,omitempty"`
}

UpdateDomainMonitorOptions Update options for a domain monitor

type UpdateDomainOptions 

type UpdateDomainOptions struct {
	CatchAllInboxId *string `json:"catchAllInboxId,omitempty"`
}

UpdateDomainOptions Options for creating a domain to use with MailSlurp. You must have ownership access to this domain in order to verify it. Domains will not functionally currently until the domain has been verified. See https://www.mailslurp.com/guides/custom-domains for help.

type UpdateGroupContacts 

type UpdateGroupContacts struct {
	ContactIds []string `json:"contactIds"`
}

UpdateGroupContacts Update group contacts options. Pass a list of contact ids to replace existing group contacts.

type UpdateImapAccessOptions 

type UpdateImapAccessOptions struct {
	// IMAP username for login
	ImapUsername *string `json:"imapUsername,omitempty"`
	// IMAP password for login
	ImapPassword *string `json:"imapPassword,omitempty"`
}

UpdateImapAccessOptions Edit access details for inbox using IMAP

type UpdateImapAccessOpts 

type UpdateImapAccessOpts struct {
	InboxId optional.Interface
}

UpdateImapAccessOpts Optional parameters for the method 'UpdateImapAccess'

type UpdateInboxOptions 

type UpdateInboxOptions struct {
	// Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search
	Name *string `json:"name,omitempty"`
	// Description of an inbox for labelling and searching purposes
	Description *string `json:"description,omitempty"`
	// Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
	Tags *[]string `json:"tags,omitempty"`
	// Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email.
	ExpiresAt *time.Time `json:"expiresAt,omitempty"`
	// Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering
	Favourite *bool `json:"favourite,omitempty"`
}

UpdateInboxOptions Options for updating inbox properties

type UpdateInboxReplierOptions 

type UpdateInboxReplierOptions struct {
	// Inbox ID to attach replier to
	InboxId string `json:"inboxId"`
	// Name for replier
	Name *string `json:"name,omitempty"`
	// Field to match against to trigger inbox replier for inbound email
	Field *string `json:"field,omitempty"`
	// String or wildcard style match for field specified when evaluating reply rules
	Match *string `json:"match,omitempty"`
	// Reply-to email address when sending replying
	ReplyTo *string `json:"replyTo,omitempty"`
	// Subject override when replying to email
	Subject *string `json:"subject,omitempty"`
	// Send email from address
	From *string `json:"from,omitempty"`
	// Email reply charset
	Charset *string `json:"charset,omitempty"`
	// Send HTML email
	IsHTML *bool `json:"isHTML,omitempty"`
	// Ignore sender replyTo when responding. Send directly to the sender if enabled.
	IgnoreReplyTo *bool `json:"ignoreReplyTo,omitempty"`
	// Email body for reply
	Body *string `json:"body,omitempty"`
	// ID of template to use when sending a reply
	TemplateId *string `json:"templateId,omitempty"`
	// Template variable values
	TemplateVariables *map[string]map[string]interface{} `json:"templateVariables,omitempty"`
	// Comparison mode for inbox automation matching.
	Should       *string                      `json:"should,omitempty"`
	MatchOptions *InboxAutomationMatchOptions `json:"matchOptions,omitempty"`
}

UpdateInboxReplierOptions Options for updating an inbox replier

type UpdatePhoneNumberOptions 

type UpdatePhoneNumberOptions struct {
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
}

UpdatePhoneNumberOptions struct for UpdatePhoneNumberOptions

type UpdatePhonePoolOptions 

type UpdatePhonePoolOptions struct {
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
}

UpdatePhonePoolOptions struct for UpdatePhonePoolOptions

type UpdateSmtpAccessOptions 

type UpdateSmtpAccessOptions struct {
	// SMTP username for login
	SmtpUsername *string `json:"smtpUsername,omitempty"`
	// SMTP password for login
	SmtpPassword *string `json:"smtpPassword,omitempty"`
}

UpdateSmtpAccessOptions Edit access details for inbox using SMTP

type UpdateSmtpAccessOpts 

type UpdateSmtpAccessOpts struct {
	InboxId optional.Interface
}

UpdateSmtpAccessOpts Optional parameters for the method 'UpdateSmtpAccess'

type UpdateWebhookOpts 

type UpdateWebhookOpts struct {
	InboxId         optional.Interface
	AiTransformerId optional.Interface
	PhoneNumberId   optional.Interface
	OverrideAuth    optional.Bool
}

UpdateWebhookOpts Optional parameters for the method 'UpdateWebhook'

type UploadAttachmentBytesOpts 

type UploadAttachmentBytesOpts struct {
	ContentType  optional.String
	ContentType2 optional.String
	ContentId    optional.String
	Filename     optional.String
	FileSize     optional.Int64
	Filename2    optional.String
}

UploadAttachmentBytesOpts Optional parameters for the method 'UploadAttachmentBytes'

type UploadAttachmentOptions 

type UploadAttachmentOptions struct {
	// Optional contentId for file.
	ContentId *string `json:"contentId,omitempty"`
	// Optional contentType for file. For instance `application/pdf`
	ContentType *string `json:"contentType,omitempty"`
	// Optional filename to save upload with. Will be the name that is shown in email clients
	Filename *string `json:"filename,omitempty"`
	// Base64 encoded string of file contents. Typically this means reading the bytes or string content of a file and then converting that to a base64 encoded string. For examples of how to do this see https://www.mailslurp.com/guides/base64-file-uploads/
	Base64Contents string `json:"base64Contents"`
}

UploadAttachmentOptions Options for uploading files for attachments. When sending emails with the API that require attachments first upload each attachment. Then use the returned attachment ID in your `SendEmailOptions` when sending an email. This way you can use attachments multiple times once they have been uploaded.

type UploadMultipartFormOpts 

type UploadMultipartFormOpts struct {
	ContentId         optional.String
	ContentType       optional.String
	Filename          optional.String
	ContentTypeHeader optional.String
	XFilename         optional.String
	XFilenameRaw      optional.String
	XFilesize         optional.Int64
	InlineObject2     optional.Interface
}

UploadMultipartFormOpts Optional parameters for the method 'UploadMultipartForm'

type UserControllerApiService 

type UserControllerApiService service

UserControllerApiService UserControllerApi service

func (*UserControllerApiService) CreateOrUpdateInboxRetentionPolicyForAccount 

func (a *UserControllerApiService) CreateOrUpdateInboxRetentionPolicyForAccount(ctx _context.Context, createInboxRetentionPolicyForAccountOptions CreateInboxRetentionPolicyForAccountOptions) (InboxRetentionPolicyDto, *_nethttp.Response, error)

CreateOrUpdateInboxRetentionPolicyForAccount Method for CreateOrUpdateInboxRetentionPolicyForAccount Create inbox retention policy for your global account

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createInboxRetentionPolicyForAccountOptions

@return InboxRetentionPolicyDto

func (*UserControllerApiService) DeleteInboxRetentionPolicyForAccount 

func (a *UserControllerApiService) DeleteInboxRetentionPolicyForAccount(ctx _context.Context) (EmptyResponseDto, *_nethttp.Response, error)

DeleteInboxRetentionPolicyForAccount Method for DeleteInboxRetentionPolicyForAccount Delete inbox retention policy for your global account

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return EmptyResponseDto

func (*UserControllerApiService) GetEntityAutomations 

func (a *UserControllerApiService) GetEntityAutomations(ctx _context.Context, localVarOptionals *GetEntityAutomationsOpts) (PageEntityAutomationItems, *_nethttp.Response, error)

GetEntityAutomations Method for GetEntityAutomations

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetEntityAutomationsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index
  • @param "Size" (optional.Int32) - Optional page size
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp
  • @param "InboxId" (optional.Interface of string) - Optional inbox ID
  • @param "PhoneId" (optional.Interface of string) - Optional phone ID
  • @param "Filter" (optional.String) - Optional automation type filter

@return PageEntityAutomationItems

func (*UserControllerApiService) GetEntityEvents 

func (a *UserControllerApiService) GetEntityEvents(ctx _context.Context, localVarOptionals *GetEntityEventsOpts) (PageEntityEventItems, *_nethttp.Response, error)

GetEntityEvents Method for GetEntityEvents

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetEntityEventsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index
  • @param "Size" (optional.Int32) - Optional page size
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp
  • @param "InboxId" (optional.Interface of string) - Optional inbox ID
  • @param "EmailId" (optional.Interface of string) - Optional email ID
  • @param "PhoneId" (optional.Interface of string) - Optional phone ID
  • @param "SmsId" (optional.Interface of string) - Optional SMS ID
  • @param "AttachmentId" (optional.Interface of string) - Optional attachment ID
  • @param "Filter" (optional.String) - Optional type filter

@return PageEntityEventItems

func (*UserControllerApiService) GetEntityFavorites 

func (a *UserControllerApiService) GetEntityFavorites(ctx _context.Context, localVarOptionals *GetEntityFavoritesOpts) (PageEntityFavouriteItems, *_nethttp.Response, error)

GetEntityFavorites Method for GetEntityFavorites

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetEntityFavoritesOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index
  • @param "Size" (optional.Int32) - Optional page size
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp
  • @param "Filter" (optional.String) - Optional type filter

@return PageEntityFavouriteItems

func (*UserControllerApiService) GetInboxRetentionPolicyForAccount 

func (a *UserControllerApiService) GetInboxRetentionPolicyForAccount(ctx _context.Context) (InboxRetentionPolicyOptionalDto, *_nethttp.Response, error)

GetInboxRetentionPolicyForAccount Method for GetInboxRetentionPolicyForAccount Get inbox retention policy for your global account

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return InboxRetentionPolicyOptionalDto

func (*UserControllerApiService) GetJsonPropertyAsString 

func (a *UserControllerApiService) GetJsonPropertyAsString(ctx _context.Context, property string, body map[string]interface{}) (string, *_nethttp.Response, error)

GetJsonPropertyAsString Method for GetJsonPropertyAsString Utility function to extract properties from JSON objects in language where this is cumbersome.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param property JSON property name or dot separated path selector such as `a.b.c`
  • @param body

@return string

func (*UserControllerApiService) GetUserInfo 

func (a *UserControllerApiService) GetUserInfo(ctx _context.Context) (UserInfoDto, *_nethttp.Response, error)

GetUserInfo Method for GetUserInfo Get account information for your user

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return UserInfoDto

type UserInfoDto 

type UserInfoDto struct {
	Id               string    `json:"id"`
	EmailAddress     string    `json:"emailAddress"`
	AccountState     string    `json:"accountState"`
	SubscriptionType string    `json:"subscriptionType,omitempty"`
	AccountType      string    `json:"accountType"`
	CreatedAt        time.Time `json:"createdAt"`
}

UserInfoDto struct for UserInfoDto

type ValidateEmailAddressListOptions 

type ValidateEmailAddressListOptions struct {
	EmailAddressList []string `json:"emailAddressList"`
	IgnoreOldResults *bool    `json:"ignoreOldResults,omitempty"`
}

ValidateEmailAddressListOptions Options for validating a list of email addresses

type ValidateEmailAddressListResult 

type ValidateEmailAddressListResult struct {
	ValidEmailAddresses          []string        `json:"validEmailAddresses"`
	InvalidEmailAddresses        []string        `json:"invalidEmailAddresses"`
	ResultMapEmailAddressIsValid map[string]bool `json:"resultMapEmailAddressIsValid"`
}

ValidateEmailAddressListResult Result of validating a list of email addresses

type ValidatePhoneNumberOptions 

type ValidatePhoneNumberOptions struct {
	PhoneNumber string `json:"phoneNumber"`
}

ValidatePhoneNumberOptions struct for ValidatePhoneNumberOptions

type ValidationDto 

type ValidationDto struct {
	// ID of the email validated
	EmailId string                `json:"emailId"`
	Html    *HtmlValidationResult `json:"html"`
}

ValidationDto Response object for email validation operation

type ValidationMessage 

type ValidationMessage struct {
	LineNumber int32  `json:"lineNumber"`
	Message    string `json:"message,omitempty"`
}

ValidationMessage Optional warnings resulting from HTML validation

type VerifyEmailAddressOptions 

type VerifyEmailAddressOptions struct {
	MailServerDomain   *string `json:"mailServerDomain,omitempty"`
	EmailAddress       string  `json:"emailAddress"`
	SenderEmailAddress *string `json:"senderEmailAddress,omitempty"`
	Port               *int32  `json:"port,omitempty"`
}

VerifyEmailAddressOptions Options for verifying that an email address exists at a remote mail server.

type VerifyWebhookSignatureOptions 

type VerifyWebhookSignatureOptions struct {
	MessageId string `json:"messageId"`
	Signature string `json:"signature"`
}

VerifyWebhookSignatureOptions struct for VerifyWebhookSignatureOptions

type VerifyWebhookSignatureResults 

type VerifyWebhookSignatureResults struct {
	IsValid bool `json:"isValid"`
}

VerifyWebhookSignatureResults struct for VerifyWebhookSignatureResults

type WaitForConditions 

type WaitForConditions struct {
	// ID of inbox to search within and apply conditions to. Essentially filtering the emails found to give a count.
	InboxId string `json:"inboxId"`
	// Number of results that should match conditions. Either exactly or at least this amount based on the `countType`. If count condition is not met and the timeout has not been reached the `waitFor` method will retry the operation.
	Count *int32 `json:"count,omitempty"`
	// Max time in milliseconds to wait between retries if a `timeout` is specified.
	DelayTimeout *int64 `json:"delayTimeout,omitempty"`
	// Max time in milliseconds to retry the `waitFor` operation until conditions are met.
	Timeout int64 `json:"timeout"`
	// Apply conditions only to **unread** emails. All emails begin with `read=false`. An email is marked `read=true` when an `EmailDto` representation of it has been returned to the user at least once. For example you have called `getEmail` or `waitForLatestEmail` etc., or you have viewed the email in the dashboard.
	UnreadOnly *bool `json:"unreadOnly,omitempty"`
	// How result size should be compared with the expected size. Exactly or at-least matching result?
	CountType *string `json:"countType,omitempty"`
	// Conditions that should be matched for an email to qualify for results. Each condition will be applied in order to each email within an inbox to filter a result list of matching emails you are waiting for.
	Matches *[]MatchOption `json:"matches,omitempty"`
	// Direction to sort matching emails by created time
	SortDirection *string `json:"sortDirection,omitempty"`
	// ISO Date Time earliest time of email to consider. Filter for matching emails that were received after this date
	Since *time.Time `json:"since,omitempty"`
	// ISO Date Time latest time of email to consider. Filter for matching emails that were received before this date
	Before *time.Time `json:"before,omitempty"`
}

WaitForConditions Conditions to apply to emails that you are waiting for

type WaitForControllerApiService 

type WaitForControllerApiService service

WaitForControllerApiService WaitForControllerApi service

func (*WaitForControllerApiService) WaitFor 

func (a *WaitForControllerApiService) WaitFor(ctx _context.Context, waitForConditions WaitForConditions) ([]EmailPreview, *_nethttp.Response, error)

WaitFor Wait for an email to match the provided filter conditions such as subject contains keyword. Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param waitForConditions

@return []EmailPreview

func (*WaitForControllerApiService) WaitForEmailCount 

func (a *WaitForControllerApiService) WaitForEmailCount(ctx _context.Context, inboxId string, count int32, localVarOptionals *WaitForEmailCountOpts) ([]EmailPreview, *_nethttp.Response, error)

WaitForEmailCount Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs If inbox contains count or more emails at time of request then return count worth of emails. If not wait until the count is reached and return those or return an error if timeout is exceeded.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId Id of the inbox we are fetching emails from
  • @param count Number of emails to wait for. Must be greater that 1
  • @param optional nil or *WaitForEmailCountOpts - Optional Parameters:
  • @param "Timeout" (optional.Int64) - Max milliseconds to wait
  • @param "UnreadOnly" (optional.Bool) - Optional filter for unread only
  • @param "Before" (optional.Time) - Filter for emails that were received before the given timestamp
  • @param "Since" (optional.Time) - Filter for emails that were received after the given timestamp
  • @param "Sort" (optional.String) - Sort direction
  • @param "Delay" (optional.Int64) - Max milliseconds delay between calls

@return []EmailPreview

func (*WaitForControllerApiService) WaitForLatestEmail 

func (a *WaitForControllerApiService) WaitForLatestEmail(ctx _context.Context, localVarOptionals *WaitForLatestEmailOpts) (Email, *_nethttp.Response, error)

WaitForLatestEmail Fetch inbox's latest email or if empty wait for an email to arrive Will return either the last received email or wait for an email to arrive and return that. If you need to wait for an email for a non-empty inbox set &#x60;unreadOnly&#x3D;true&#x60; or see the other receive methods such as &#x60;waitForNthEmail&#x60; or &#x60;waitForEmailCount&#x60;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *WaitForLatestEmailOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Id of the inbox we are fetching emails from
  • @param "Timeout" (optional.Int64) - Max milliseconds to wait
  • @param "UnreadOnly" (optional.Bool) - Optional filter for unread only.
  • @param "Before" (optional.Time) - Filter for emails that were before after the given timestamp
  • @param "Since" (optional.Time) - Filter for emails that were received after the given timestamp
  • @param "Sort" (optional.String) - Sort direction
  • @param "Delay" (optional.Int64) - Max milliseconds delay between calls

@return Email

func (*WaitForControllerApiService) WaitForLatestSms 

func (a *WaitForControllerApiService) WaitForLatestSms(ctx _context.Context, waitForSingleSmsOptions WaitForSingleSmsOptions) (SmsDto, *_nethttp.Response, error)

WaitForLatestSms Wait for the latest SMS message to match the provided filter conditions such as body contains keyword. Wait until a phone number meets given conditions or return immediately if already met

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param waitForSingleSmsOptions

@return SmsDto

func (*WaitForControllerApiService) WaitForMatchingEmails 

func (a *WaitForControllerApiService) WaitForMatchingEmails(ctx _context.Context, inboxId string, count int32, matchOptions MatchOptions, localVarOptionals *WaitForMatchingEmailsOpts) ([]EmailPreview, *_nethttp.Response, error)

WaitForMatchingEmails Wait or return list of emails that match simple matching patterns Perform a search of emails in an inbox with the given patterns. If results match expected count then return or else retry the search until results are found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the &#x60;MatchOptions&#x60; object for options. An example payload is &#x60;{ matches: [{field: &#39;SUBJECT&#39;,should:&#39;CONTAIN&#39;,value:&#39;needle&#39;}] }&#x60;. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController &#x60;getEmailContentMatch&#x60; method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId Id of the inbox we are fetching emails from
  • @param count Number of emails to wait for. Must be greater or equal to 1
  • @param matchOptions
  • @param optional nil or *WaitForMatchingEmailsOpts - Optional Parameters:
  • @param "Before" (optional.Time) - Filter for emails that were received before the given timestamp
  • @param "Since" (optional.Time) - Filter for emails that were received after the given timestamp
  • @param "Sort" (optional.String) - Sort direction
  • @param "Delay" (optional.Int64) - Max milliseconds delay between calls
  • @param "Timeout" (optional.Int64) - Max milliseconds to wait
  • @param "UnreadOnly" (optional.Bool) - Optional filter for unread only

@return []EmailPreview

func (*WaitForControllerApiService) WaitForMatchingFirstEmail 

func (a *WaitForControllerApiService) WaitForMatchingFirstEmail(ctx _context.Context, inboxId string, matchOptions MatchOptions, localVarOptionals *WaitForMatchingFirstEmailOpts) (Email, *_nethttp.Response, error)

WaitForMatchingFirstEmail Wait for or return the first email that matches provided MatchOptions array Perform a search of emails in an inbox with the given patterns. If a result if found then return or else retry the search until a result is found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the &#x60;MatchOptions&#x60; object for options. An example payload is &#x60;{ matches: [{field: &#39;SUBJECT&#39;,should:&#39;CONTAIN&#39;,value:&#39;needle&#39;}] }&#x60;. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController &#x60;getEmailContentMatch&#x60; method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId Id of the inbox we are matching an email for
  • @param matchOptions
  • @param optional nil or *WaitForMatchingFirstEmailOpts - Optional Parameters:
  • @param "Timeout" (optional.Int64) - Max milliseconds to wait
  • @param "UnreadOnly" (optional.Bool) - Optional filter for unread only
  • @param "Since" (optional.Time) - Filter for emails that were received after the given timestamp
  • @param "Before" (optional.Time) - Filter for emails that were received before the given timestamp
  • @param "Sort" (optional.String) - Sort direction
  • @param "Delay" (optional.Int64) - Max milliseconds delay between calls

@return Email

func (*WaitForControllerApiService) WaitForNthEmail 

func (a *WaitForControllerApiService) WaitForNthEmail(ctx _context.Context, localVarOptionals *WaitForNthEmailOpts) (Email, *_nethttp.Response, error)

WaitForNthEmail Wait for or fetch the email with a given index in the inbox specified. If index doesn't exist waits for it to exist or timeout to occur. If nth email is already present in inbox then return it. If not hold the connection open until timeout expires or the nth email is received and returned.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *WaitForNthEmailOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Id of the inbox you are fetching emails from
  • @param "Index" (optional.Int32) - Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index=1
  • @param "Timeout" (optional.Int64) - Max milliseconds to wait for the nth email if not already present
  • @param "UnreadOnly" (optional.Bool) - Optional filter for unread only
  • @param "Since" (optional.Time) - Filter for emails that were received after the given timestamp
  • @param "Before" (optional.Time) - Filter for emails that were received before the given timestamp
  • @param "Sort" (optional.String) - Sort direction
  • @param "Delay" (optional.Int64) - Max milliseconds delay between calls

@return Email

func (*WaitForControllerApiService) WaitForSms 

func (a *WaitForControllerApiService) WaitForSms(ctx _context.Context, waitForSmsConditions WaitForSmsConditions) ([]SmsPreview, *_nethttp.Response, error)

WaitForSms Wait for an SMS message to match the provided filter conditions such as body contains keyword. Generic waitFor method that will wait until a phone number meets given conditions or return immediately if already met

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param waitForSmsConditions

@return []SmsPreview

type WaitForDeliveryStatusesOpts 

type WaitForDeliveryStatusesOpts struct {
	SentId  optional.Interface
	InboxId optional.Interface
	Timeout optional.Int64
	Index   optional.Int32
	Since   optional.Time
	Before  optional.Time
}

WaitForDeliveryStatusesOpts Optional parameters for the method 'WaitForDeliveryStatuses'

type WaitForEmailCountOpts 

type WaitForEmailCountOpts struct {
	Timeout    optional.Int64
	UnreadOnly optional.Bool
	Before     optional.Time
	Since      optional.Time
	Sort       optional.String
	Delay      optional.Int64
}

WaitForEmailCountOpts Optional parameters for the method 'WaitForEmailCount'

type WaitForLatestEmailOpts 

type WaitForLatestEmailOpts struct {
	InboxId    optional.Interface
	Timeout    optional.Int64
	UnreadOnly optional.Bool
	Before     optional.Time
	Since      optional.Time
	Sort       optional.String
	Delay      optional.Int64
}

WaitForLatestEmailOpts Optional parameters for the method 'WaitForLatestEmail'

type WaitForMatchingEmailsOpts 

type WaitForMatchingEmailsOpts struct {
	Before     optional.Time
	Since      optional.Time
	Sort       optional.String
	Delay      optional.Int64
	Timeout    optional.Int64
	UnreadOnly optional.Bool
}

WaitForMatchingEmailsOpts Optional parameters for the method 'WaitForMatchingEmails'

type WaitForMatchingFirstEmailOpts 

type WaitForMatchingFirstEmailOpts struct {
	Timeout    optional.Int64
	UnreadOnly optional.Bool
	Since      optional.Time
	Before     optional.Time
	Sort       optional.String
	Delay      optional.Int64
}

WaitForMatchingFirstEmailOpts Optional parameters for the method 'WaitForMatchingFirstEmail'

type WaitForNthEmailOpts 

type WaitForNthEmailOpts struct {
	InboxId    optional.Interface
	Index      optional.Int32
	Timeout    optional.Int64
	UnreadOnly optional.Bool
	Since      optional.Time
	Before     optional.Time
	Sort       optional.String
	Delay      optional.Int64
}

WaitForNthEmailOpts Optional parameters for the method 'WaitForNthEmail'

type WaitForNthMissedEmailOpts 

type WaitForNthMissedEmailOpts struct {
	InboxId optional.Interface
	Timeout optional.Int64
	Since   optional.Time
	Before  optional.Time
}

WaitForNthMissedEmailOpts Optional parameters for the method 'WaitForNthMissedEmail'

type WaitForSingleSmsOptions 

type WaitForSingleSmsOptions struct {
	PhoneNumberId string    `json:"phoneNumberId"`
	Timeout       int64     `json:"timeout"`
	UnreadOnly    bool      `json:"unreadOnly,omitempty"`
	Before        time.Time `json:"before,omitempty"`
	Since         time.Time `json:"since,omitempty"`
	SortDirection string    `json:"sortDirection,omitempty"`
	Delay         int64     `json:"delay,omitempty"`
}

WaitForSingleSmsOptions struct for WaitForSingleSmsOptions

type WaitForSmsConditions 

type WaitForSmsConditions struct {
	// ID of phone number to search within and apply conditions to. Essentially filtering the SMS found to give a count.
	PhoneNumberId string `json:"phoneNumberId"`
	// Limit results
	Limit *int32 `json:"limit,omitempty"`
	// Number of results that should match conditions. Either exactly or at least this amount based on the `countType`. If count condition is not met and the timeout has not been reached the `waitFor` method will retry the operation.
	Count int64 `json:"count"`
	// Max time in milliseconds to wait between retries if a `timeout` is specified.
	DelayTimeout *int64 `json:"delayTimeout,omitempty"`
	// Max time in milliseconds to retry the `waitFor` operation until conditions are met.
	Timeout int64 `json:"timeout"`
	// Apply conditions only to **unread** SMS. All SMS messages begin with `read=false`. An SMS is marked `read=true` when an `SMS` has been returned to the user at least once. For example you have called `getSms`, or you have viewed the SMS in the dashboard.
	UnreadOnly *bool `json:"unreadOnly,omitempty"`
	// How result size should be compared with the expected size. Exactly or at-least matching result?
	CountType *string `json:"countType,omitempty"`
	// Conditions that should be matched for an SMS to qualify for results. Each condition will be applied in order to each SMS within a phone number to filter a result list of matching SMSs you are waiting for.
	Matches *[]SmsMatchOption `json:"matches,omitempty"`
	// Direction to sort matching SMSs by created time
	SortDirection *string `json:"sortDirection,omitempty"`
	// ISO Date Time earliest time of SMS to consider. Filter for matching SMSs that were received after this date
	Since *time.Time `json:"since,omitempty"`
	// ISO Date Time latest time of SMS to consider. Filter for matching SMSs that were received before this date
	Before *time.Time `json:"before,omitempty"`
}

WaitForSmsConditions Conditions to apply to emails that you are waiting for

type WebhookBouncePayload 

type WebhookBouncePayload struct {
	// Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
	MessageId string `json:"messageId"`
	// ID of webhook entity being triggered
	WebhookId string `json:"webhookId"`
	// Name of the event type webhook is being triggered for.
	EventName string `json:"eventName"`
	// Name of the webhook being triggered
	WebhookName *string `json:"webhookName,omitempty"`
	// ID of the bounce email record. Use the ID with the bounce controller to view more information
	BounceId string `json:"bounceId"`
	// Email sent to recipients
	SentToRecipients *[]string `json:"sentToRecipients,omitempty"`
	// Sender causing bounce
	Sender string `json:"sender"`
	// Email addresses that resulted in a bounce or email being rejected. Please save these recipients and avoid emailing them in the future to maintain your reputation.
	BounceRecipients *[]string `json:"bounceRecipients,omitempty"`
}

WebhookBouncePayload BOUNCE webhook payload. Sent to your webhook url endpoint via HTTP POST when an email bounced or was rejected by a recipient. Save the recipients to a ban list on your server and avoid emailing them again. It is recommended you also listen to the BOUNCE_RECIPIENT payload.

type WebhookBounceRecipientPayload 

type WebhookBounceRecipientPayload struct {
	// Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
	MessageId string `json:"messageId"`
	// ID of webhook entity being triggered
	WebhookId string `json:"webhookId"`
	// Name of the event type webhook is being triggered for.
	EventName string `json:"eventName"`
	// Name of the webhook being triggered
	WebhookName *string `json:"webhookName,omitempty"`
	// Email address that caused a bounce. Make note of the address and try not to message it again to preserve your reputation.
	Recipient string `json:"recipient"`
}

WebhookBounceRecipientPayload BOUNCE_RECIPIENT webhook payload. Sent to your webhook url endpoint via HTTP POST when an email caused a bounce to occur for a recipient. Save the recipient to a ban list of your server and avoid email them again.

type WebhookControllerApiService 

type WebhookControllerApiService service

WebhookControllerApiService WebhookControllerApi service

func (*WebhookControllerApiService) CreateAccountWebhook 

func (a *WebhookControllerApiService) CreateAccountWebhook(ctx _context.Context, createWebhookOptions CreateWebhookOptions) (WebhookDto, *_nethttp.Response, error)

CreateAccountWebhook Attach a WebHook URL to an inbox Get notified of account level events such as bounce and bounce recipient.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createWebhookOptions

@return WebhookDto

func (*WebhookControllerApiService) CreateWebhook 

func (a *WebhookControllerApiService) CreateWebhook(ctx _context.Context, inboxId string, createWebhookOptions CreateWebhookOptions) (WebhookDto, *_nethttp.Response, error)

CreateWebhook Attach a WebHook URL to an inbox Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId
  • @param createWebhookOptions

@return WebhookDto

func (*WebhookControllerApiService) CreateWebhookForAITransformer 

func (a *WebhookControllerApiService) CreateWebhookForAITransformer(ctx _context.Context, transformerId string, createWebhookOptions CreateWebhookOptions) (WebhookDto, *_nethttp.Response, error)

CreateWebhookForAITransformer Attach a WebHook URL to an AI transformer Get notified whenever AI transformation pipeline converts and email or SMS into structured data via a WebHook URL.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param transformerId
  • @param createWebhookOptions

@return WebhookDto

func (*WebhookControllerApiService) CreateWebhookForPhoneNumber 

func (a *WebhookControllerApiService) CreateWebhookForPhoneNumber(ctx _context.Context, phoneNumberId string, createWebhookOptions CreateWebhookOptions) (WebhookDto, *_nethttp.Response, error)

CreateWebhookForPhoneNumber Attach a WebHook URL to a phone number Get notified whenever a phone number receives an SMS via a WebHook URL.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param phoneNumberId
  • @param createWebhookOptions

@return WebhookDto

func (*WebhookControllerApiService) DeleteAllWebhooks 

func (a *WebhookControllerApiService) DeleteAllWebhooks(ctx _context.Context, localVarOptionals *DeleteAllWebhooksOpts) (*_nethttp.Response, error)

DeleteAllWebhooks Delete all webhooks

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *DeleteAllWebhooksOpts - Optional Parameters:
  • @param "Before" (optional.Time) - before

func (*WebhookControllerApiService) DeleteWebhook 

func (a *WebhookControllerApiService) DeleteWebhook(ctx _context.Context, inboxId string, webhookId string) (*_nethttp.Response, error)

DeleteWebhook Delete and disable a Webhook for an Inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId
  • @param webhookId

func (*WebhookControllerApiService) DeleteWebhookById 

func (a *WebhookControllerApiService) DeleteWebhookById(ctx _context.Context, webhookId string) (*_nethttp.Response, error)

DeleteWebhookById Delete a webhook

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param webhookId

func (*WebhookControllerApiService) GetAllAccountWebhooks 

func (a *WebhookControllerApiService) GetAllAccountWebhooks(ctx _context.Context, localVarOptionals *GetAllAccountWebhooksOpts) (PageWebhookProjection, *_nethttp.Response, error)

GetAllAccountWebhooks List account webhooks Paginated List account webhooks in paginated form. Allows for page index, page size, and sort direction.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAllAccountWebhooksOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size for paginated result list.
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp
  • @param "EventType" (optional.String) - Optional event type
  • @param "Health" (optional.String) - Filter by webhook health
  • @param "SearchFilter" (optional.String) - Optional search filter

@return PageWebhookProjection

func (*WebhookControllerApiService) GetAllWebhookEndpoints 

func (a *WebhookControllerApiService) GetAllWebhookEndpoints(ctx _context.Context, localVarOptionals *GetAllWebhookEndpointsOpts) (PageWebhookEndpointProjection, *_nethttp.Response, error)

GetAllWebhookEndpoints List Webhooks endpoints Paginated List webhooks URL in paginated form. Allows for page index, page size, and sort direction.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAllWebhookEndpointsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size for paginated result list.
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "SearchFilter" (optional.String) - Optional search filter
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "InboxId" (optional.Interface of string) - Filter by inboxId
  • @param "PhoneId" (optional.Interface of string) - Filter by phoneId
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp
  • @param "Health" (optional.String) - Filter by webhook health
  • @param "EventType" (optional.String) - Optional event type

@return PageWebhookEndpointProjection

func (*WebhookControllerApiService) GetAllWebhookResults 

func (a *WebhookControllerApiService) GetAllWebhookResults(ctx _context.Context, localVarOptionals *GetAllWebhookResultsOpts) (PageWebhookResult, *_nethttp.Response, error)

GetAllWebhookResults Get results for all webhooks

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAllWebhookResultsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size in list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "SearchFilter" (optional.String) - Optional search filter
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp
  • @param "UnseenOnly" (optional.Bool) - Filter for unseen exceptions only
  • @param "ResultType" (optional.String) - Filter by result type
  • @param "EventName" (optional.String) - Filter by event name
  • @param "MinStatusCode" (optional.Int32) - Minimum response status
  • @param "MaxStatusCode" (optional.Int32) - Maximum response status
  • @param "InboxId" (optional.Interface of string) - Inbox ID
  • @param "SmsId" (optional.Interface of string) - Sms ID
  • @param "AttachmentId" (optional.Interface of string) - Attachment ID
  • @param "EmailId" (optional.Interface of string) - Email ID
  • @param "PhoneId" (optional.Interface of string) - Phone ID
  • @param "AiTransformerId" (optional.Interface of string) - AI Transformer ID

@return PageWebhookResult

func (*WebhookControllerApiService) GetAllWebhooks 

func (a *WebhookControllerApiService) GetAllWebhooks(ctx _context.Context, localVarOptionals *GetAllWebhooksOpts) (PageWebhookProjection, *_nethttp.Response, error)

GetAllWebhooks List Webhooks Paginated List webhooks in paginated form. Allows for page index, page size, and sort direction.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetAllWebhooksOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size for paginated result list.
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "SearchFilter" (optional.String) - Optional search filter
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "InboxId" (optional.Interface of string) - Filter by inboxId
  • @param "AiTransformerId" (optional.Interface of string) - Filter by aiTransformerId
  • @param "PhoneId" (optional.Interface of string) - Filter by phoneId
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp
  • @param "Health" (optional.String) - Filter by webhook health
  • @param "EventType" (optional.String) - Optional event type
  • @param "Url" (optional.String) - Optional url endpoint filter
  • @param "EventTypeSource" (optional.String) - Webhook source type category such as phone, inbox, aiTranformer
  • @param "IncludeAccountWide" (optional.Bool) - Include account scope webhooks when passing phoneId, inboxId, or aiTransformerId filters

@return PageWebhookProjection

func (*WebhookControllerApiService) GetInboxWebhooksPaginated 

func (a *WebhookControllerApiService) GetInboxWebhooksPaginated(ctx _context.Context, inboxId string, localVarOptionals *GetInboxWebhooksPaginatedOpts) (PageWebhookProjection, *_nethttp.Response, error)

GetInboxWebhooksPaginated Get paginated webhooks for an Inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId
  • @param optional nil or *GetInboxWebhooksPaginatedOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size in list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "SearchFilter" (optional.String) - Optional search filter
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp
  • @param "Health" (optional.String) - Filter by webhook health
  • @param "EventType" (optional.String) - Optional event type
  • @param "IncludeAccountWide" (optional.Bool) - Include account scope inbox webhooks

@return PageWebhookProjection

func (*WebhookControllerApiService) GetJsonSchemaForWebhookEvent 

func (a *WebhookControllerApiService) GetJsonSchemaForWebhookEvent(ctx _context.Context, event string) (JsonSchemaDto, *_nethttp.Response, error)

GetJsonSchemaForWebhookEvent Method for GetJsonSchemaForWebhookEvent Get JSON Schema definition for webhook payload by event

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param event

@return JsonSchemaDto

func (*WebhookControllerApiService) GetJsonSchemaForWebhookPayload 

func (a *WebhookControllerApiService) GetJsonSchemaForWebhookPayload(ctx _context.Context, webhookId string) (JsonSchemaDto, *_nethttp.Response, error)

GetJsonSchemaForWebhookPayload Method for GetJsonSchemaForWebhookPayload Get JSON Schema definition for webhook payload

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param webhookId

@return JsonSchemaDto

func (*WebhookControllerApiService) GetPhoneNumberWebhooksPaginated 

func (a *WebhookControllerApiService) GetPhoneNumberWebhooksPaginated(ctx _context.Context, phoneId string, localVarOptionals *GetPhoneNumberWebhooksPaginatedOpts) (PageWebhookProjection, *_nethttp.Response, error)

GetPhoneNumberWebhooksPaginated Get paginated webhooks for a phone number

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param phoneId
  • @param optional nil or *GetPhoneNumberWebhooksPaginatedOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size in list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp
  • @param "EventType" (optional.String) - Optional event type
  • @param "SearchFilter" (optional.String) - Optional search filter
  • @param "Health" (optional.String) - Filter by webhook health
  • @param "IncludeAccountWide" (optional.Bool) - Include account scope phone webhooks

@return PageWebhookProjection

func (*WebhookControllerApiService) GetTestWebhookPayload 

func (a *WebhookControllerApiService) GetTestWebhookPayload(ctx _context.Context, localVarOptionals *GetTestWebhookPayloadOpts) (AbstractWebhookPayload, *_nethttp.Response, error)

GetTestWebhookPayload Method for GetTestWebhookPayload Get test webhook payload example. Response content depends on eventName passed. Uses &#x60;EMAIL_RECEIVED&#x60; as default.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetTestWebhookPayloadOpts - Optional Parameters:
  • @param "EventName" (optional.String) -

@return AbstractWebhookPayload

func (*WebhookControllerApiService) GetTestWebhookPayloadBounce 

func (a *WebhookControllerApiService) GetTestWebhookPayloadBounce(ctx _context.Context) (WebhookBouncePayload, *_nethttp.Response, error)

GetTestWebhookPayloadBounce Method for GetTestWebhookPayloadBounce Get webhook test payload for bounce

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return WebhookBouncePayload

func (*WebhookControllerApiService) GetTestWebhookPayloadBounceRecipient 

func (a *WebhookControllerApiService) GetTestWebhookPayloadBounceRecipient(ctx _context.Context) (WebhookBounceRecipientPayload, *_nethttp.Response, error)

GetTestWebhookPayloadBounceRecipient Method for GetTestWebhookPayloadBounceRecipient Get webhook test payload for bounce recipient

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return WebhookBounceRecipientPayload

func (*WebhookControllerApiService) GetTestWebhookPayloadDeliveryStatus 

func (a *WebhookControllerApiService) GetTestWebhookPayloadDeliveryStatus(ctx _context.Context) (WebhookDeliveryStatusPayload, *_nethttp.Response, error)

GetTestWebhookPayloadDeliveryStatus Get webhook test payload for delivery status event

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return WebhookDeliveryStatusPayload

func (*WebhookControllerApiService) GetTestWebhookPayloadEmailOpened 

func (a *WebhookControllerApiService) GetTestWebhookPayloadEmailOpened(ctx _context.Context) (WebhookEmailOpenedPayload, *_nethttp.Response, error)

GetTestWebhookPayloadEmailOpened Method for GetTestWebhookPayloadEmailOpened Get webhook test payload for email opened event

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return WebhookEmailOpenedPayload

func (*WebhookControllerApiService) GetTestWebhookPayloadEmailRead 

func (a *WebhookControllerApiService) GetTestWebhookPayloadEmailRead(ctx _context.Context) (WebhookEmailReadPayload, *_nethttp.Response, error)

GetTestWebhookPayloadEmailRead Method for GetTestWebhookPayloadEmailRead Get webhook test payload for email opened event

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return WebhookEmailReadPayload

func (*WebhookControllerApiService) GetTestWebhookPayloadForWebhook 

func (a *WebhookControllerApiService) GetTestWebhookPayloadForWebhook(ctx _context.Context, webhookId string) (AbstractWebhookPayload, *_nethttp.Response, error)

GetTestWebhookPayloadForWebhook Method for GetTestWebhookPayloadForWebhook Get example payload for webhook

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param webhookId

@return AbstractWebhookPayload

func (*WebhookControllerApiService) GetTestWebhookPayloadNewAITransformResult 

func (a *WebhookControllerApiService) GetTestWebhookPayloadNewAITransformResult(ctx _context.Context) (WebhookNewAiTransformResultPayload, *_nethttp.Response, error)

GetTestWebhookPayloadNewAITransformResult Get webhook test payload for new ai transform result event

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return WebhookNewAiTransformResultPayload

func (*WebhookControllerApiService) GetTestWebhookPayloadNewAttachment 

func (a *WebhookControllerApiService) GetTestWebhookPayloadNewAttachment(ctx _context.Context) (WebhookNewAttachmentPayload, *_nethttp.Response, error)

GetTestWebhookPayloadNewAttachment Get webhook test payload for new attachment event

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return WebhookNewAttachmentPayload

func (*WebhookControllerApiService) GetTestWebhookPayloadNewContact 

func (a *WebhookControllerApiService) GetTestWebhookPayloadNewContact(ctx _context.Context) (WebhookNewContactPayload, *_nethttp.Response, error)

GetTestWebhookPayloadNewContact Get webhook test payload for new contact event

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return WebhookNewContactPayload

func (*WebhookControllerApiService) GetTestWebhookPayloadNewEmail 

func (a *WebhookControllerApiService) GetTestWebhookPayloadNewEmail(ctx _context.Context) (WebhookNewEmailPayload, *_nethttp.Response, error)

GetTestWebhookPayloadNewEmail Get webhook test payload for new email event

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return WebhookNewEmailPayload

func (*WebhookControllerApiService) GetTestWebhookPayloadNewSms 

func (a *WebhookControllerApiService) GetTestWebhookPayloadNewSms(ctx _context.Context) (WebhookNewSmsPayload, *_nethttp.Response, error)

GetTestWebhookPayloadNewSms Get webhook test payload for new sms event

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return WebhookNewSmsPayload

func (*WebhookControllerApiService) GetWebhook 

func (a *WebhookControllerApiService) GetWebhook(ctx _context.Context, webhookId string) (WebhookDto, *_nethttp.Response, error)

GetWebhook Get a webhook

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param webhookId

@return WebhookDto

func (*WebhookControllerApiService) GetWebhookResult 

func (a *WebhookControllerApiService) GetWebhookResult(ctx _context.Context, webhookResultId string) (WebhookResultDto, *_nethttp.Response, error)

GetWebhookResult Get a webhook result for a webhook

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param webhookResultId Webhook Result ID

@return WebhookResultDto

func (*WebhookControllerApiService) GetWebhookResults 

func (a *WebhookControllerApiService) GetWebhookResults(ctx _context.Context, webhookId string, localVarOptionals *GetWebhookResultsOpts) (PageWebhookResult, *_nethttp.Response, error)

GetWebhookResults Get a webhook results for a webhook

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param webhookId ID of webhook to get results for
  • @param optional nil or *GetWebhookResultsOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size in list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC
  • @param "SearchFilter" (optional.String) - Optional search filter
  • @param "Since" (optional.Time) - Filter by created at after the given timestamp
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp
  • @param "UnseenOnly" (optional.Bool) - Filter for unseen exceptions only
  • @param "ResultType" (optional.String) - Filter by result type
  • @param "EventName" (optional.String) - Filter by event name
  • @param "MinStatusCode" (optional.Int32) - Minimum response status
  • @param "MaxStatusCode" (optional.Int32) - Maximum response status
  • @param "InboxId" (optional.Interface of string) - Inbox ID
  • @param "SmsId" (optional.Interface of string) - Sms ID
  • @param "AttachmentId" (optional.Interface of string) - Attachment ID
  • @param "EmailId" (optional.Interface of string) - Email ID
  • @param "PhoneId" (optional.Interface of string) - Phone ID
  • @param "AiTransformerId" (optional.Interface of string) - AI Transformer ID

@return PageWebhookResult

func (*WebhookControllerApiService) GetWebhookResultsCount 

func (a *WebhookControllerApiService) GetWebhookResultsCount(ctx _context.Context, webhookId string) (CountDto, *_nethttp.Response, error)

GetWebhookResultsCount Get a webhook results count for a webhook

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param webhookId ID of webhook to get results for

@return CountDto

func (*WebhookControllerApiService) GetWebhookResultsUnseenErrorCount 

func (a *WebhookControllerApiService) GetWebhookResultsUnseenErrorCount(ctx _context.Context) (UnseenErrorCountDto, *_nethttp.Response, error)

GetWebhookResultsUnseenErrorCount Get count of unseen webhook results with error status

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return UnseenErrorCountDto

func (*WebhookControllerApiService) GetWebhooks 

func (a *WebhookControllerApiService) GetWebhooks(ctx _context.Context, inboxId string, localVarOptionals *GetWebhooksOpts) ([]WebhookProjection, *_nethttp.Response, error)

GetWebhooks Get all webhooks for an Inbox

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inboxId
  • @param optional nil or *GetWebhooksOpts - Optional Parameters:
  • @param "Page" (optional.Int32) - Optional page index in list pagination
  • @param "Size" (optional.Int32) - Optional page size in list pagination
  • @param "Sort" (optional.String) - Optional createdAt sort direction ASC or DESC

@return []WebhookProjection

func (*WebhookControllerApiService) RedriveAllWebhookResults 

func (a *WebhookControllerApiService) RedriveAllWebhookResults(ctx _context.Context) (WebhookRedriveAllResult, *_nethttp.Response, error)

RedriveAllWebhookResults Redrive all webhook results that have failed status Allows you to resend webhook payloads for any recorded webhook result that failed to deliver the payload.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return WebhookRedriveAllResult

func (*WebhookControllerApiService) RedriveWebhookResult 

func (a *WebhookControllerApiService) RedriveWebhookResult(ctx _context.Context, webhookResultId string) (WebhookRedriveResult, *_nethttp.Response, error)

RedriveWebhookResult Get a webhook result and try to resend the original webhook payload Allows you to resend a webhook payload that was already sent. Webhooks that fail are retried automatically for 24 hours and then put in a dead letter queue. You can retry results manually using this method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param webhookResultId Webhook Result ID

@return WebhookRedriveResult

func (*WebhookControllerApiService) SendTestData 

func (a *WebhookControllerApiService) SendTestData(ctx _context.Context, webhookId string) (WebhookTestResult, *_nethttp.Response, error)

SendTestData Send webhook test data

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param webhookId

@return WebhookTestResult

func (*WebhookControllerApiService) UpdateWebhook 

func (a *WebhookControllerApiService) UpdateWebhook(ctx _context.Context, webhookId string, createWebhookOptions CreateWebhookOptions, localVarOptionals *UpdateWebhookOpts) (WebhookDto, *_nethttp.Response, error)

UpdateWebhook Update a webhook

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param webhookId
  • @param createWebhookOptions
  • @param optional nil or *UpdateWebhookOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) -
  • @param "AiTransformerId" (optional.Interface of string) -
  • @param "PhoneNumberId" (optional.Interface of string) -
  • @param "OverrideAuth" (optional.Bool) -

@return WebhookDto

func (*WebhookControllerApiService) UpdateWebhookHeaders 

func (a *WebhookControllerApiService) UpdateWebhookHeaders(ctx _context.Context, webhookId string, webhookHeaders WebhookHeaders) (WebhookDto, *_nethttp.Response, error)

UpdateWebhookHeaders Update a webhook request headers

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param webhookId
  • @param webhookHeaders

@return WebhookDto

func (*WebhookControllerApiService) VerifyWebhookSignature 

func (a *WebhookControllerApiService) VerifyWebhookSignature(ctx _context.Context, verifyWebhookSignatureOptions VerifyWebhookSignatureOptions) (VerifyWebhookSignatureResults, *_nethttp.Response, error)

VerifyWebhookSignature Verify a webhook payload signature Verify a webhook payload using the messageId and signature. This allows you to be sure that MailSlurp sent the payload and not another server.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param verifyWebhookSignatureOptions

@return VerifyWebhookSignatureResults

func (*WebhookControllerApiService) WaitForWebhookResults 

func (a *WebhookControllerApiService) WaitForWebhookResults(ctx _context.Context, webhookId string, expectedCount int32, timeout int32) ([]WebhookResultDto, *_nethttp.Response, error)

WaitForWebhookResults Wait for webhook results for a webhook

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param webhookId ID of webhook to get results for
  • @param expectedCount Expected result count
  • @param timeout Max time to wait in milliseconds

@return []WebhookResultDto

type WebhookDeliveryStatusPayload 

type WebhookDeliveryStatusPayload struct {
	// Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
	MessageId string `json:"messageId"`
	// ID of webhook entity being triggered
	WebhookId string `json:"webhookId"`
	// Name of the event type webhook is being triggered for.
	EventName string `json:"eventName"`
	// Name of the webhook being triggered
	WebhookName *string `json:"webhookName,omitempty"`
	// ID of delivery status
	Id string `json:"id"`
	// User ID of event
	UserId string `json:"userId"`
	// ID of sent email
	SentId *string `json:"sentId,omitempty"`
	// IP address of the remote Mail Transfer Agent
	RemoteMtaIp *string `json:"remoteMtaIp,omitempty"`
	// Id of the inbox
	InboxId *string `json:"inboxId,omitempty"`
	// Mail Transfer Agent reporting delivery status
	ReportingMta *string `json:"reportingMta,omitempty"`
	// Recipients for delivery
	Recipients *[]string `json:"recipients,omitempty"`
	// SMTP server response message
	SmtpResponse *string `json:"smtpResponse,omitempty"`
	// SMTP server status
	SmtpStatusCode *int32 `json:"smtpStatusCode,omitempty"`
	// Time in milliseconds for delivery processing
	ProcessingTimeMillis *int64 `json:"processingTimeMillis,omitempty"`
	// Time event was received
	Received *time.Time `json:"received,omitempty"`
	// Email subject
	Subject *string `json:"subject,omitempty"`
}

WebhookDeliveryStatusPayload DELIVERY_STATUS webhook payload. Sent to your webhook url endpoint via HTTP POST when an email delivery status is created. This could be a successful delivery or a delivery failure.

type WebhookDto 

type WebhookDto struct {
	// ID of the Webhook
	Id string `json:"id"`
	// User ID of the Webhook
	UserId string `json:"userId"`
	// Does webhook expect basic authentication? If true it means you created this webhook with a username and password. MailSlurp will use these in the URL to authenticate itself.
	BasicAuth bool `json:"basicAuth"`
	// Name of the webhook
	Name *string `json:"name,omitempty"`
	// The phoneNumberId that the Webhook will be triggered by. If null then webhook triggered at account level or inbox level if inboxId set
	PhoneId *string `json:"phoneId,omitempty"`
	// The inbox that the Webhook will be triggered by. If null then webhook triggered at account level or phone level if phoneId set
	InboxId *string `json:"inboxId,omitempty"`
	// Request body template for HTTP request that will be sent for the webhook. Use Moustache style template variables to insert values from the original event payload.
	RequestBodyTemplate *string `json:"requestBodyTemplate,omitempty"`
	// URL of your server that the webhook will be sent to. The schema of the JSON that is sent is described by the payloadJsonSchema.
	Url string `json:"url"`
	// HTTP method that your server endpoint must listen for
	Method string `json:"method"`
	// Deprecated. Fetch JSON Schema for webhook using the getJsonSchemaForWebhookPayload method
	PayloadJsonSchema string `json:"payloadJsonSchema"`
	// When the webhook was created
	CreatedAt *time.Time `json:"createdAt"`
	UpdatedAt time.Time  `json:"updatedAt"`
	// Webhook trigger event name
	EventName      *string        `json:"eventName,omitempty"`
	RequestHeaders WebhookHeaders `json:"requestHeaders,omitempty"`
	// ID of AI transformer for payload
	AiTransformId *string `json:"aiTransformId,omitempty"`
	// Should notifier ignore insecure SSL certificates
	IgnoreInsecureSslCertificates *bool `json:"ignoreInsecureSslCertificates,omitempty"`
	// Should notifier use static IP range when sending webhook payload
	UseStaticIpRange *bool `json:"useStaticIpRange,omitempty"`
	// Webhook health
	HealthStatus *string `json:"healthStatus,omitempty"`
}

WebhookDto Representation of a webhook for an inbox. The URL specified will be using by MailSlurp whenever an email is received by the attached inbox. A webhook entity should have a URL that points to your server. Your server should accept HTTP/S POST requests and return a success 200. MailSlurp will retry your webhooks if they fail. See https://golang.api.mailslurp.com/schemas/webhook-payload for the payload schema.

type WebhookEmailOpenedPayload 

type WebhookEmailOpenedPayload struct {
	// Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
	MessageId string `json:"messageId"`
	// ID of webhook entity being triggered
	WebhookId string `json:"webhookId"`
	// Name of the event type webhook is being triggered for.
	EventName string `json:"eventName"`
	// Name of the webhook being triggered
	WebhookName *string `json:"webhookName,omitempty"`
	// Id of the inbox
	InboxId string `json:"inboxId"`
	// ID of the tracking pixel
	PixelId string `json:"pixelId"`
	// ID of sent email
	SentEmailId string `json:"sentEmailId"`
	// Email address for the recipient of the tracking pixel
	Recipient string `json:"recipient"`
	// Date time of event creation
	CreatedAt time.Time `json:"createdAt"`
}

WebhookEmailOpenedPayload EMAIL_OPENED webhook payload. Sent to your webhook url endpoint via HTTP POST when an email containing a tracking pixel is opened and the pixel image is loaded by a reader.

type WebhookEmailReadPayload 

type WebhookEmailReadPayload struct {
	// Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
	MessageId string `json:"messageId"`
	// ID of webhook entity being triggered
	WebhookId string `json:"webhookId"`
	// Name of the event type webhook is being triggered for.
	EventName string `json:"eventName"`
	// Name of the webhook being triggered
	WebhookName *string `json:"webhookName,omitempty"`
	// ID of the email that was received. Use this ID for fetching the email with the `EmailController`.
	EmailId string `json:"emailId"`
	// Id of the inbox
	InboxId string `json:"inboxId"`
	// Is the email read
	EmailIsRead bool `json:"emailIsRead"`
	// Date time of event creation
	CreatedAt time.Time `json:"createdAt"`
}

WebhookEmailReadPayload EMAIL_READ webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is read. This happens when an email is requested in full from the API or a user views the email in the dashboard.

type WebhookEndpointProjection 

type WebhookEndpointProjection struct {
	Url    string `json:"url"`
	Health string `json:"health"`
}

WebhookEndpointProjection struct for WebhookEndpointProjection

type WebhookHeaderNameValue 

type WebhookHeaderNameValue struct {
	// Name of header
	Name string `json:"name"`
	// Value of header
	Value string `json:"value"`
}

WebhookHeaderNameValue Name value pair for webhook header

type WebhookHeaders 

type WebhookHeaders struct {
	// List of header name value pairs to include with webhook requests
	Headers []WebhookHeaderNameValue `json:"headers"`
}

WebhookHeaders Webhook HTTP headers to include with each request from MailSlurp to your server

type WebhookNewAiTransformResultPayload 

type WebhookNewAiTransformResultPayload struct {
	// Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
	MessageId string `json:"messageId"`
	// ID of webhook entity being triggered
	WebhookId string `json:"webhookId"`
	// Name of the event type webhook is being triggered for.
	EventName string `json:"eventName"`
	// Name of the webhook being triggered
	WebhookName *string `json:"webhookName,omitempty"`
	// AI Transform ID of event
	AiTransformResultId string `json:"aiTransformResultId"`
	// User ID of event
	UserId string `json:"userId"`
	// ID of AI Transform
	AiTransformId string `json:"aiTransformId"`
	// ID of AI Transform mapping
	AiTransformMappingId *string `json:"aiTransformMappingId,omitempty"`
	// ID of entity that triggered the transformation
	EntityId *string `json:"entityId,omitempty"`
	// Entity type that triggered the transformation
	EntityType *string `json:"entityType,omitempty"`
	// JSON string result of the AI transformation
	Result *string `json:"result,omitempty"`
}

WebhookNewAiTransformResultPayload NEW_AI_TRANSFORM_RESULT webhook payload. Sent to your webhook url endpoint via HTTP POST when a structured data result is generated by the AI Transformer that your webhook is attached to. Use the AI Transform Result ID to fetch the full details.

type WebhookNewAttachmentPayload 

type WebhookNewAttachmentPayload struct {
	// Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
	MessageId string `json:"messageId"`
	// ID of webhook entity being triggered
	WebhookId string `json:"webhookId"`
	// Name of the webhook being triggered
	WebhookName *string `json:"webhookName,omitempty"`
	// Name of the event type webhook is being triggered for.
	EventName string `json:"eventName"`
	// ID of attachment. Use the `AttachmentController` to
	AttachmentId string `json:"attachmentId"`
	// Filename of the attachment if present
	Name string `json:"name"`
	// Content type of attachment such as 'image/png' or 'application/pdf
	ContentType string `json:"contentType"`
	// Size of attachment in bytes
	ContentLength int64 `json:"contentLength"`
}

WebhookNewAttachmentPayload NEW_ATTACHMENT webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is received by the inbox that your webhook is attached to that contains an attachment. You can use the attachmentId to download the attachment.

type WebhookNewContactPayload 

type WebhookNewContactPayload struct {
	// Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
	MessageId string `json:"messageId"`
	// ID of webhook entity being triggered
	WebhookId string `json:"webhookId"`
	// Name of the webhook being triggered
	WebhookName *string `json:"webhookName,omitempty"`
	// Name of the event type webhook is being triggered for.
	EventName string `json:"eventName"`
	// Contact ID
	ContactId string `json:"contactId"`
	// Contact group ID
	GroupId *string `json:"groupId,omitempty"`
	// Contact first name
	FirstName *string `json:"firstName,omitempty"`
	// Contact last name
	LastName *string `json:"lastName,omitempty"`
	// Contact company name
	Company *string `json:"company,omitempty"`
	// Primary email address for contact
	PrimaryEmailAddress *string `json:"primaryEmailAddress,omitempty"`
	// Email addresses for contact
	EmailAddresses []string `json:"emailAddresses"`
	// Tags for contact
	Tags     []string                `json:"tags"`
	MetaData *map[string]interface{} `json:"metaData,omitempty"`
	// Has contact opted out of emails
	OptOut bool `json:"optOut"`
	// Date time of event creation
	CreatedAt time.Time `json:"createdAt"`
}

WebhookNewContactPayload NEW_CONTACT webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is received by the inbox that your webhook is attached to that contains a recipient that has not been saved as a contact.

type WebhookNewEmailPayload 

type WebhookNewEmailPayload struct {
	// Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
	MessageId string `json:"messageId"`
	// ID of webhook entity being triggered
	WebhookId string `json:"webhookId"`
	// Name of the event type webhook is being triggered for.
	EventName string `json:"eventName"`
	// Name of the webhook being triggered
	WebhookName *string `json:"webhookName,omitempty"`
	// Id of the inbox
	InboxId string `json:"inboxId"`
	// Id of the domain that received an email
	DomainId *string `json:"domainId,omitempty"`
	// ID of the email that was received. Use this ID for fetching the email with the `EmailController`.
	EmailId string `json:"emailId"`
	// Date time of event creation
	CreatedAt time.Time `json:"createdAt"`
	// List of `To` recipient email addresses that the email was addressed to. See recipients object for names.
	To []string `json:"to"`
	// Who the email was sent from. An email address - see fromName for the sender name.
	From string `json:"from"`
	// List of `CC` recipients email addresses that the email was addressed to. See recipients object for names.
	Cc []string `json:"cc"`
	// List of `BCC` recipients email addresses that the email was addressed to. See recipients object for names.
	Bcc []string `json:"bcc"`
	// The subject line of the email message as specified by SMTP subject header
	Subject *string `json:"subject,omitempty"`
	// List of attachment meta data objects if attachments present
	AttachmentMetaDatas []AttachmentMetaData `json:"attachmentMetaDatas"`
}

WebhookNewEmailPayload NEW_EMAIL webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is received by the inbox that your webhook is attached to. Use the email ID to fetch the full email body or attachments.

type WebhookNewSmsPayload 

type WebhookNewSmsPayload struct {
	// Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
	MessageId string `json:"messageId"`
	// ID of webhook entity being triggered
	WebhookId string `json:"webhookId"`
	// Name of the event type webhook is being triggered for.
	EventName string `json:"eventName"`
	// Name of the webhook being triggered
	WebhookName *string `json:"webhookName,omitempty"`
	// ID of SMS message
	SmsId string `json:"smsId"`
	// User ID of event
	UserId string `json:"userId"`
	// ID of phone number receiving SMS
	PhoneNumber string `json:"phoneNumber"`
	// Recipient phone number
	ToNumber string `json:"toNumber"`
	// Sender phone number
	FromNumber string `json:"fromNumber"`
	// SMS message body
	Body string `json:"body"`
	// SMS has been read
	Read bool `json:"read"`
}

WebhookNewSmsPayload NEW_SMS webhook payload. Sent to your webhook url endpoint via HTTP POST when an sms is received by the phone number that your webhook is attached to. Use the SMS ID to fetch the full SMS details.

type WebhookProjection 

type WebhookProjection struct {
	Name            string    `json:"name,omitempty"`
	Id              string    `json:"id"`
	Url             string    `json:"url"`
	Password        string    `json:"password,omitempty"`
	Username        string    `json:"username,omitempty"`
	UserId          string    `json:"userId"`
	InboxId         string    `json:"inboxId,omitempty"`
	EventName       string    `json:"eventName,omitempty"`
	UpdatedAt       time.Time `json:"updatedAt"`
	CreatedAt       time.Time `json:"createdAt"`
	HealthStatus    string    `json:"healthStatus,omitempty"`
	AiTransformerId string    `json:"aiTransformerId,omitempty"`
	AiTransformId   string    `json:"aiTransformId,omitempty"`
	PhoneNumberId   string    `json:"phoneNumberId,omitempty"`
}

WebhookProjection Representation of a webhook

type WebhookRedriveAllResult 

type WebhookRedriveAllResult struct {
	Success bool    `json:"success"`
	Message *string `json:"message,omitempty"`
}

WebhookRedriveAllResult Result of retrying all failed webhook

type WebhookRedriveResult 

type WebhookRedriveResult struct {
	WebhookResultId string  `json:"webhookResultId"`
	Success         bool    `json:"success"`
	Message         *string `json:"message,omitempty"`
}

WebhookRedriveResult Result of retrying webhook

type WebhookResultDto 

type WebhookResultDto struct {
	Id                  *string   `json:"id,omitempty"`
	UserId              string    `json:"userId"`
	WebhookId           string    `json:"webhookId"`
	WebhookUrl          string    `json:"webhookUrl"`
	MessageId           string    `json:"messageId"`
	RedriveId           *string   `json:"redriveId,omitempty"`
	HttpMethod          string    `json:"httpMethod"`
	WebhookEvent        string    `json:"webhookEvent"`
	ResponseStatus      *int32    `json:"responseStatus,omitempty"`
	ResponseTimeMillis  int64     `json:"responseTimeMillis"`
	ResponseBodyExtract *string   `json:"responseBodyExtract,omitempty"`
	ResultType          *string   `json:"resultType,omitempty"`
	CreatedAt           time.Time `json:"createdAt"`
	UpdatedAt           time.Time `json:"updatedAt"`
	Seen                bool      `json:"seen"`
	InboxId             *string   `json:"inboxId,omitempty"`
	EmailId             *string   `json:"emailId,omitempty"`
	AttachmentId        *string   `json:"attachmentId,omitempty"`
	PhoneId             *string   `json:"phoneId,omitempty"`
	SmsId               *string   `json:"smsId,omitempty"`
	AiTransformerId     *string   `json:"aiTransformerId,omitempty"`
}

WebhookResultDto Result of a webhook notification

type WebhookTestRequest 

type WebhookTestRequest struct {
	Url     string            `json:"url"`
	Method  string            `json:"method"`
	Headers map[string]string `json:"headers"`
	Payload *string           `json:"payload,omitempty"`
}

WebhookTestRequest Result of webhook test request

type WebhookTestResponse 

type WebhookTestResponse struct {
	StatusCode *int32  `json:"statusCode,omitempty"`
	Message    *string `json:"message,omitempty"`
}

WebhookTestResponse Response from webhook test request

type WebhookTestResult 

type WebhookTestResult struct {
	Message  *string             `json:"message,omitempty"`
	Response WebhookTestResponse `json:"response"`
	Request  WebhookTestRequest  `json:"request"`
}

WebhookTestResult Results of testing a webhook

Source Files

View all Source files

Jump to

Keyboard shortcuts

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