MailSlurpClient

package module
v0.0.0-...-8f84f48 Latest Latest
Warning

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

 Go to latest Published: Jun 14, 2023 License: MIT Imports: 23 Imported by: 1

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 APIClient ¶ 

type APIClient struct {
	AliasControllerApi *AliasControllerApiService

	AttachmentControllerApi *AttachmentControllerApiService

	BounceControllerApi *BounceControllerApiService

	BulkActionsControllerApi *BulkActionsControllerApiService

	CommonActionsControllerApi *CommonActionsControllerApiService

	ContactControllerApi *ContactControllerApiService

	DomainControllerApi *DomainControllerApiService

	EmailControllerApi *EmailControllerApiService

	EmailVerificationControllerApi *EmailVerificationControllerApiService

	ExpiredControllerApi *ExpiredControllerApiService

	ExportControllerApi *ExportControllerApiService

	FormControllerApi *FormControllerApiService

	GroupControllerApi *GroupControllerApiService

	InboxControllerApi *InboxControllerApiService

	InboxForwarderControllerApi *InboxForwarderControllerApiService

	InboxReplierControllerApi *InboxReplierControllerApiService

	InboxRulesetControllerApi *InboxRulesetControllerApiService

	MailServerControllerApi *MailServerControllerApiService

	MissedEmailControllerApi *MissedEmailControllerApiService

	PhoneControllerApi *PhoneControllerApiService

	SentEmailsControllerApi *SentEmailsControllerApiService

	SmsControllerApi *SmsControllerApiService

	TemplateControllerApi *TemplateControllerApiService

	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"`
	MessageId   string `json:"messageId"`
	WebhookId   string `json:"webhookId"`
	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 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) (PageThreadProjection, *_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 PageThreadProjection

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 "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) 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"`
	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"`
	CreatedAt    time.Time `json:"createdAt"`
	UpdatedAt    time.Time `json:"updatedAt"`
	UseThreads   bool      `json:"useThreads,omitempty"`
}

AliasProjection Representation of a alias

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

  • @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

  • @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) GetAttachment ¶ 

func (a *AttachmentControllerApiService) GetAttachment(ctx _context.Context, attachmentId string) (AttachmentEntity, *_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 AttachmentEntity

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

@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, inlineObject1 InlineObject1, 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 inlineObject1
  • @param optional nil or *UploadAttachmentBytesOpts - Optional Parameters:
  • @param "ContentType" (optional.String) - Optional contentType for file. For instance `application/pdf`
  • @param "Filename" (optional.String) - Optional filename to save upload with

@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 "ContentType" (optional.String) - Optional content type of attachment
  • @param "Filename" (optional.String) - Optional name of file
  • @param "XFilename" (optional.String) - Optional content type header of attachment
  • @param "InlineObject" (optional.Interface of InlineObject) -

@return []string

type AttachmentEntity ¶ 

type AttachmentEntity struct {
	Id            string    `json:"id,omitempty"`
	AttachmentId  string    `json:"attachmentId"`
	Bucket        string    `json:"bucket,omitempty"`
	UserId        string    `json:"userId"`
	ContentType   string    `json:"contentType,omitempty"`
	ContentLength int64     `json:"contentLength,omitempty"`
	Name          string    `json:"name,omitempty"`
	CreatedAt     time.Time `json:"createdAt"`
	UpdatedAt     time.Time `json:"updatedAt"`
}

AttachmentEntity struct for AttachmentEntity

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

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"`
	// Content length of attachment in bytes
	ContentLength *int64    `json:"contentLength,omitempty"`
	UserId        string    `json:"userId"`
	CreatedAt     time.Time `json:"createdAt"`
	UpdatedAt     time.Time `json:"updatedAt"`
	// Attachment ID
	AttachmentId string `json:"attachmentId"`
	// Content type of attachment.
	ContentType *string `json:"contentType,omitempty"`
}

AttachmentProjection Email attachment data

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

type BounceProjection ¶ 

type BounceProjection struct {
	Id         string    `json:"id,omitempty"`
	Sender     string    `json:"sender"`
	Subject    *string   `json:"subject,omitempty"`
	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"`
	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"`
	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 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) -

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

@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

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

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

@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) ([]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

@return []string

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"`
	FirstName      *string   `json:"firstName,omitempty"`
	LastName       *string   `json:"lastName,omitempty"`
	Company        *string   `json:"company,omitempty"`
	EmailAddresses *[]string `json:"emailAddresses,omitempty"`
	OptOut         bool      `json:"optOut"`
}

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

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

CreateContactOptions Options for creating an email contact in address book

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 `mx.mailslurp.com` while `HTTP` inboxes are handled by AWS SES.

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

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"`
	// String or wildcard style match for field specified when evaluating forwarding rules
	Match string `json:"match"`
	// Email addresses to forward an email to if it matches the field and match criteria of the forwarder
	ForwardToRecipients []string `json:"forwardToRecipients"`
}

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
}

CreateInboxOpts Optional parameters for the method 'CreateInbox'

type CreateInboxReplierOptions ¶ 

type CreateInboxReplierOptions 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"`
	// String or wildcard style match for field specified when evaluating reply rules. Use `*` to match anything.
	Match string `json:"match"`
	// 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"`
}

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 CreateInboxRulesetOptions ¶ 

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

CreateInboxRulesetOptions 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 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
}

CreateNewEmailAddressOpts Optional parameters for the method 'CreateNewEmailAddress'

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
}

CreateRandomInboxOpts Optional parameters for the method 'CreateRandomInbox'

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

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 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 DeleteInboxRulesetsOpts ¶ 

type DeleteInboxRulesetsOpts struct {
	InboxId optional.Interface
}

DeleteInboxRulesetsOpts Optional parameters for the method 'DeleteInboxRulesets'

type DeleteSmsMessagesOpts ¶ 

type DeleteSmsMessagesOpts struct {
	PhoneNumberId optional.Interface
}

DeleteSmsMessagesOpts Optional parameters for the method 'DeleteSmsMessages'

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 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 DoesInboxExistOpts ¶ 

type DoesInboxExistOpts struct {
	AllowCatchAll optional.Bool
}

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) 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) 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 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 DomainIssuesDto ¶ 

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

DomainIssuesDto struct for DomainIssuesDto

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

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 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 .
	BodyExcerpt *string `json:"bodyExcerpt,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"`
	Html       bool `json:"html,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 EmailContentMatchResult ¶ 

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

EmailContentMatchResult Matches for the given pattern

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. Apply RFC3501 section-2.3.2 IMAP flag operations on an email

  • @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) DeleteAllEmails ¶ 

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

DeleteAllEmails Delete all emails in all inboxes. Deletes all emails in your account. 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().

func (*EmailControllerApiService) DeleteEmail ¶ 

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

DeleteEmail Delete an email Deletes an email and removes it from the inbox. Deleted emails cannot be recovered.

  • @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 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 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 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 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 the specified email body for a given email as a string

  • @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. Returns the specified email body for a given email as a stream / array of bytes.

  • @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 Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the &#x60;from&#x60; option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email 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 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 the metadata such as name and content-type for a given attachment and email.

  • @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, localVarOptionals *GetEmailOpts) (Email, *_nethttp.Response, error)

GetEmail Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController. Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param emailId
  • @param optional nil or *GetEmailOpts - Optional Parameters:
  • @param "Decode" (optional.Bool) - Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing

@return Email

func (*EmailControllerApiService) GetEmailAttachments ¶ 

func (a *EmailControllerApiService) GetEmailAttachments(ctx _context.Context, emailId string) ([]AttachmentMetaData, *_nethttp.Response, error)

GetEmailAttachments Get all email attachment metadata. Metadata includes name and size of attachments. Returns an array of attachment metadata such as name and content-type for a given email if present.

  • @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) GetEmailContentMatch ¶ 

func (a *EmailControllerApiService) GetEmailContentMatch(ctx _context.Context, emailId string, contentMatchOptions ContentMatchOptions) (EmailContentMatchResult, *_nethttp.Response, error)

GetEmailContentMatch Get email content regex pattern match results. Runs regex against email body and returns match groups. Return the matches for a given Java style regex pattern. Do not include the typical &#x60;/&#x60; at start or end of regex in some languages. Given an example &#x60;your code is: 12345&#x60; the pattern to extract match looks like &#x60;code is: (\\d{6})&#x60;. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: &#x60;[&#39;code is: 123456&#39;, &#39;123456&#39;]&#x60; See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns.

  • @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) GetEmailCount ¶ 

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

GetEmailCount Get email count

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

@return CountDto

func (*EmailControllerApiService) GetEmailHTML ¶ 

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

GetEmailHTML Get email content as HTML. For displaying emails in browser context. Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: &#x60;?apiKey&#x3D;xxx&#x60;. Returns content-type &#x60;text/html;charset&#x3D;utf-8&#x60; so you must call expecting that content response not JSON. For JSON response see the &#x60;getEmailHTMLJson&#x60; method.

  • @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 "Decode" (optional.Bool) -

@return string

func (*EmailControllerApiService) GetEmailHTMLJson ¶ 

func (a *EmailControllerApiService) GetEmailHTMLJson(ctx _context.Context, emailId string, localVarOptionals *GetEmailHTMLJsonOpts) (EmailHtmlDto, *_nethttp.Response, error)

GetEmailHTMLJson Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content Retrieve email content as HTML response. Decodes quoted-printable entities and converts charset to UTF-8. Returns content-type &#x60;application/json;charset&#x3D;utf-8&#x60; so you must call expecting that content response not JSON.

  • @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 "Decode" (optional.Bool) -

@return EmailHtmlDto

func (*EmailControllerApiService) GetEmailHTMLQuery ¶ 

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

GetEmailHTMLQuery Parse and return text from an email, stripping HTML and decoding encoded characters Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors

  • @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) (EmailLinksResult, *_nethttp.Response, error)

GetEmailLinks Parse and return list of links found in an email (only works for HTML content) HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes

  • @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

@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 Get a list of URLs for 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 emailId

@return EmailPreviewUrls

func (*EmailControllerApiService) GetEmailTextLines ¶ 

func (a *EmailControllerApiService) GetEmailTextLines(ctx _context.Context, emailId string, localVarOptionals *GetEmailTextLinesOpts) (EmailTextLinesResult, *_nethttp.Response, error)

GetEmailTextLines Parse and return text from an email, stripping HTML and decoding encoded characters Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators.

  • @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) 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. By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox 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 *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. Searches email recipients, sender, subject, email address and ID. Does not search email body
  • @param "Since" (optional.Time) - Optional filter emails received after given date time
  • @param "Before" (optional.Time) - Optional filter emails received before given date time

@return PageEmailProjection

func (*EmailControllerApiService) GetGravatarUrlForEmailAddress ¶ 

func (a *EmailControllerApiService) GetGravatarUrlForEmailAddress(ctx _context.Context, emailAddress string, localVarOptionals *GetGravatarUrlForEmailAddressOpts) (GravatarUrl, *_nethttp.Response, error)

GetGravatarUrlForEmailAddress Method for GetGravatarUrlForEmailAddress Get gravatar url for email 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 *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. Get the newest email in all inboxes or in a passed set 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. Get the newest email in all inboxes or in a passed set of inbox IDs

  • @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 Get all organization emails. List team or shared test email accounts By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox 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 *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
  • @param "Before" (optional.Time) - Optional filter emails received before given date time

@return PageEmailProjection

func (*EmailControllerApiService) GetRawEmailContents ¶ 

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

GetRawEmailContents Get raw email string. Returns unparsed raw SMTP message with headers and body. Returns a raw, unparsed, and unprocessed 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 getRawEmailJson endpoint

  • @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) 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 a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail 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 (*EmailControllerApiService) GetUnreadEmailCount ¶ 

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

GetUnreadEmailCount Get unread email count Get number of emails 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 (*EmailControllerApiService) MarkAsRead ¶ 

func (a *EmailControllerApiService) MarkAsRead(ctx _context.Context, emailId string, localVarOptionals *MarkAsReadOpts) (EmailPreview, *_nethttp.Response, error)

MarkAsRead Mark an email as read on unread Marks an email as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it 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 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 emailId ID of the email that should be replied to
  • @param replyToEmailOptions

@return SentEmailDto

func (*EmailControllerApiService) SendEmailSourceOptional ¶ 

func (a *EmailControllerApiService) SendEmailSourceOptional(ctx _context.Context, sendEmailOptions SendEmailOptions, localVarOptionals *SendEmailSourceOptionalOpts) (*_nethttp.Response, error)

SendEmailSourceOptional Send email Alias for &#x60;InboxController.sendEmail&#x60; method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email.

  • @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) ValidateEmail ¶ 

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

ValidateEmail Validate email HTML contents Validate the HTML content of email if HTML is found. Considered valid if no HTML is present.

  • @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 EmailHtmlDto ¶ 

type EmailHtmlDto struct {
	Subject string `json:"subject,omitempty"`
	Body    string `json:"body,omitempty"`
}

EmailHtmlDto struct for EmailHtmlDto

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

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

EmailPreviewUrls URLs for email body

type EmailProjection ¶ 

type EmailProjection struct {
	Id          string    `json:"id"`
	From        *string   `json:"from,omitempty"`
	Subject     *string   `json:"subject,omitempty"`
	InboxId     string    `json:"inboxId"`
	Attachments *[]string `json:"attachments,omitempty"`
	CreatedAt   time.Time `json:"createdAt"`
	To          []string  `json:"to"`
	Bcc         *[]string `json:"bcc,omitempty"`
	Cc          *[]string `json:"cc,omitempty"`
	DomainId    *string   `json:"domainId,omitempty"`
	Read        bool      `json:"read"`
	BodyExcerpt *string   `json:"bodyExcerpt,omitempty"`
	TeamAccess  bool      `json:"teamAccess"`
	BodyMD5Hash *string   `json:"bodyMD5Hash,omitempty"`
}

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 EmailTextLinesResult ¶ 

type EmailTextLinesResult struct {
	Lines []string `json:"lines"`
	Body  string   `json:"body"`
}

EmailTextLinesResult Parsed text of an email

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

  • @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.

  • @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,omitempty"`
	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 ExpirationDefaults ¶ 

type ExpirationDefaults struct {
	DefaultExpirationMillis  *int64     `json:"defaultExpirationMillis,omitempty"`
	MaxExpirationMillis      *int64     `json:"maxExpirationMillis,omitempty"`
	DefaultExpiresAt         *time.Time `json:"defaultExpiresAt,omitempty"`
	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

@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 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 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 "RedirectTo" (optional.String) - Optional URL to redirect form submitter to after submission. If not present user will see a success message.
  • @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 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 {
	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
	EventType optional.String
	Since     optional.Time
	Before    optional.Time
}

GetAllAccountWebhooksOpts Optional parameters for the method 'GetAllAccountWebhooks'

type GetAllContactsOpts ¶ 

type GetAllContactsOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
}

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 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
	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 GetAllScheduledJobsOpts ¶ 

type GetAllScheduledJobsOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
}

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

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
	PhoneId      optional.Interface
	Before       optional.Time
}

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
}

GetAttachmentsOpts Optional parameters for the method 'GetAttachments'

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 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 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 GetDomainOpts ¶ 

type GetDomainOpts struct {
	CheckForErrors optional.Bool
}

GetDomainOpts Optional parameters for the method 'GetDomain'

type GetEmailHTMLJsonOpts ¶ 

type GetEmailHTMLJsonOpts struct {
	Decode optional.Bool
}

GetEmailHTMLJsonOpts Optional parameters for the method 'GetEmailHTMLJson'

type GetEmailHTMLOpts ¶ 

type GetEmailHTMLOpts struct {
	Decode optional.Bool
}

GetEmailHTMLOpts Optional parameters for the method 'GetEmailHTML'

type GetEmailOpts ¶ 

type GetEmailOpts struct {
	Decode optional.Bool
}

GetEmailOpts Optional parameters for the method 'GetEmail'

type GetEmailTextLinesOpts ¶ 

type GetEmailTextLinesOpts struct {
	DecodeHtmlEntities optional.Bool
	LineSeparator      optional.String
}

GetEmailTextLinesOpts Optional parameters for the method 'GetEmailTextLines'

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
}

GetEmailsPaginatedOpts Optional parameters for the method 'GetEmailsPaginated'

type GetExpiredInboxesOpts ¶ 

type GetExpiredInboxesOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
}

GetExpiredInboxesOpts Optional parameters for the method 'GetExpiredInboxes'

type GetExportLinkOpts ¶ 

type GetExportLinkOpts struct {
	ApiKey optional.String
}

GetExportLinkOpts Optional parameters for the method 'GetExportLink'

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

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 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 GetInboxRulesetsOpts ¶ 

type GetInboxRulesetsOpts struct {
	InboxId      optional.Interface
	Page         optional.Int32
	Size         optional.Int32
	Sort         optional.String
	SearchFilter optional.String
	Since        optional.Time
	Before       optional.Time
}

GetInboxRulesetsOpts Optional parameters for the method 'GetInboxRulesets'

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 GetInboxWebhooksPaginatedOpts ¶ 

type GetInboxWebhooksPaginatedOpts struct {
	Page         optional.Int32
	Size         optional.Int32
	Sort         optional.String
	SearchFilter optional.String
	Since        optional.Time
	Before       optional.Time
}

GetInboxWebhooksPaginatedOpts Optional parameters for the method 'GetInboxWebhooksPaginated'

type GetInboxesOpts ¶ 

type GetInboxesOpts struct {
	Size                   optional.Int32
	Sort                   optional.String
	Since                  optional.Time
	ExcludeCatchAllInboxes optional.Bool
	Before                 optional.Time
}

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

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 GetPhoneNumberWebhooksPaginatedOpts ¶ 

type GetPhoneNumberWebhooksPaginatedOpts struct {
	Page   optional.Int32
	Size   optional.Int32
	Sort   optional.String
	Since  optional.Time
	Before optional.Time
}

GetPhoneNumberWebhooksPaginatedOpts Optional parameters for the method 'GetPhoneNumberWebhooksPaginated'

type GetPhoneNumbersOpts ¶ 

type GetPhoneNumbersOpts struct {
	PhoneCountry optional.String
	Page         optional.Int32
	Size         optional.Int32
	Sort         optional.String
	Since        optional.Time
	Before       optional.Time
}

GetPhoneNumbersOpts Optional parameters for the method 'GetPhoneNumbers'

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 GetSmsMessagesPaginatedOpts ¶ 

type GetSmsMessagesPaginatedOpts struct {
	PhoneNumber optional.Interface
	Page        optional.Int32
	Size        optional.Int32
	Sort        optional.String
	UnreadOnly  optional.Bool
	Since       optional.Time
	Before      optional.Time
}

GetSmsMessagesPaginatedOpts Optional parameters for the method 'GetSmsMessagesPaginated'

type GetTestWebhookPayloadOpts ¶ 

type GetTestWebhookPayloadOpts struct {
	EventName optional.String
}

GetTestWebhookPayloadOpts Optional parameters for the method 'GetTestWebhookPayload'

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
}

GetWebhookResultsOpts Optional parameters for the method 'GetWebhookResults'

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 HtmlValidationResult ¶ 

type HtmlValidationResult struct {
	// Is HTML validation result valid
	IsValid bool `json:"isValid"`
	// 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 ImapFlagOperationOptions ¶ 

type ImapFlagOperationOptions struct {
	FlagOperation string   `json:"flagOperation"`
	Flags         []string `json:"flags"`
}

ImapFlagOperationOptions IMAP operation flags

type ImapSmtpAccessDetails ¶ 

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

ImapSmtpAccessDetails Access details for inbox using SMTP or IMAP

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 `mx.mailslurp.com`.
  • @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.

@return InboxDto

func (*InboxControllerApiService) CreateInboxRuleset ¶ 

func (a *InboxControllerApiService) CreateInboxRuleset(ctx _context.Context, inboxId string, createInboxRulesetOptions CreateInboxRulesetOptions) (InboxRulesetDto, *_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 createInboxRulesetOptions

@return InboxRulesetDto

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

@return InboxExistsDto

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 ID, tags, 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 "DomainId" (optional.Interface of string) - Optional domain ID filter

@return PageInboxProjection

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

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

@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) 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) ([]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().

@return []string

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

@return []InboxDto

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) 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) 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) ListInboxRulesets ¶ 

func (a *InboxControllerApiService) ListInboxRulesets(ctx _context.Context, inboxId string, localVarOptionals *ListInboxRulesetsOpts) (PageInboxRulesetDto, *_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 PageInboxRulesetDto

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

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

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 `mx.mailslurp.com` 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"`
}

InboxExistsDto Result of email exists query

type InboxForwarderControllerApiService ¶ 

type InboxForwarderControllerApiService service

InboxForwarderControllerApiService InboxForwarderControllerApi service

func (*InboxForwarderControllerApiService) CreateNewInboxForwarder ¶ 

func (a *InboxForwarderControllerApiService) CreateNewInboxForwarder(ctx _context.Context, inboxId string, createInboxForwarderOptions CreateInboxForwarderOptions) (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 inboxId Inbox id to attach forwarder to
  • @param createInboxForwarderOptions

@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) GetInboxForwarder ¶ 

func (a *InboxForwarderControllerApiService) GetInboxForwarder(ctx _context.Context, id string) (InboxForwarderDto, *_nethttp.Response, error)

GetInboxForwarder Get an inbox forwarder 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 forwarder

@return InboxForwarderDto

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 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 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 ruleset

  • @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"`
	// Name of inbox forwarder
	Name *string `json:"name,omitempty"`
	// Which field to match against
	Field string `json:"field"`
	// Wild-card type pattern to apply to field
	Match string `json:"match"`
	// Who to send forwarded email to
	ForwardToRecipients []string  `json:"forwardToRecipients"`
	CreatedAt           time.Time `json:"createdAt"`
}

InboxForwarderDto Inbox forwarder. Describes how an inbox will forward matching emails to designated recipients.

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"`
	ForwarderId *string   `json:"forwarderId,omitempty"`
}

InboxForwarderEventProjection Inbox forwarder event

type InboxForwarderTestOptions ¶ 

type InboxForwarderTestOptions struct {
	TestValue string `json:"testValue"`
}

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,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"`
	// 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 *string `json:"expiresAt,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) 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"`
	Name              *string                            `json:"name,omitempty"`
	Field             string                             `json:"field"`
	Match             string                             `json:"match"`
	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"`
}

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"`
	UserId     *string   `json:"userId,omitempty"`
	Recipients *[]string `json:"recipients,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 InboxRulesetControllerApiService ¶ 

type InboxRulesetControllerApiService service

InboxRulesetControllerApiService InboxRulesetControllerApi service

func (*InboxRulesetControllerApiService) CreateNewInboxRuleset ¶ 

func (a *InboxRulesetControllerApiService) CreateNewInboxRuleset(ctx _context.Context, inboxId string, createInboxRulesetOptions CreateInboxRulesetOptions) (InboxRulesetDto, *_nethttp.Response, error)

CreateNewInboxRuleset 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 Inbox id to attach ruleset to
  • @param createInboxRulesetOptions

@return InboxRulesetDto

func (*InboxRulesetControllerApiService) DeleteInboxRuleset ¶ 

func (a *InboxRulesetControllerApiService) DeleteInboxRuleset(ctx _context.Context, id string) (*_nethttp.Response, error)

DeleteInboxRuleset Delete an inbox ruleset Delete 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 ruleset

func (*InboxRulesetControllerApiService) DeleteInboxRulesets ¶ 

func (a *InboxRulesetControllerApiService) DeleteInboxRulesets(ctx _context.Context, localVarOptionals *DeleteInboxRulesetsOpts) (*_nethttp.Response, error)

DeleteInboxRulesets Delete inbox rulesets Delete inbox rulesets. 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 *DeleteInboxRulesetsOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Optional inbox id to attach ruleset to

func (*InboxRulesetControllerApiService) GetInboxRuleset ¶ 

func (a *InboxRulesetControllerApiService) GetInboxRuleset(ctx _context.Context, id string) (InboxRulesetDto, *_nethttp.Response, error)

GetInboxRuleset Get an inbox ruleset 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 ruleset

@return InboxRulesetDto

func (*InboxRulesetControllerApiService) GetInboxRulesets ¶ 

func (a *InboxRulesetControllerApiService) GetInboxRulesets(ctx _context.Context, localVarOptionals *GetInboxRulesetsOpts) (PageInboxRulesetDto, *_nethttp.Response, error)

GetInboxRulesets 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 optional nil or *GetInboxRulesetsOpts - Optional Parameters:
  • @param "InboxId" (optional.Interface of string) - Optional inbox 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 PageInboxRulesetDto

func (*InboxRulesetControllerApiService) TestInboxRuleset ¶ 

func (a *InboxRulesetControllerApiService) TestInboxRuleset(ctx _context.Context, id string, inboxRulesetTestOptions InboxRulesetTestOptions) (InboxRulesetTestResult, *_nethttp.Response, error)

TestInboxRuleset Test an inbox ruleset Test an 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 ruleset
  • @param inboxRulesetTestOptions

@return InboxRulesetTestResult

func (*InboxRulesetControllerApiService) TestInboxRulesetsForInbox ¶ 

func (a *InboxRulesetControllerApiService) TestInboxRulesetsForInbox(ctx _context.Context, inboxId string, inboxRulesetTestOptions InboxRulesetTestOptions) (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 inboxRulesetTestOptions

@return InboxRulesetTestResult

func (*InboxRulesetControllerApiService) TestNewInboxRuleset ¶ 

func (a *InboxRulesetControllerApiService) TestNewInboxRuleset(ctx _context.Context, testNewInboxRulesetOptions TestNewInboxRulesetOptions) (InboxRulesetTestResult, *_nethttp.Response, error)

TestNewInboxRuleset Test new inbox ruleset Test new inbox ruleset

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

@return InboxRulesetTestResult

type InboxRulesetDto ¶ 

type InboxRulesetDto struct {
	Id        string    `json:"id"`
	InboxId   string    `json:"inboxId"`
	Scope     string    `json:"scope"`
	Action    string    `json:"action"`
	Target    string    `json:"target"`
	Handler   string    `json:"handler"`
	CreatedAt time.Time `json:"createdAt"`
}

InboxRulesetDto Rules for inbox

type InboxRulesetTestOptions ¶ 

type InboxRulesetTestOptions struct {
	TestTarget string `json:"testTarget"`
}

InboxRulesetTestOptions Test options for inbox ruleset

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 {
	// Optional content type header of attachment
	ContentTypeHeader string   `json:"contentTypeHeader,omitempty"`
	File              *os.File `json:"file"`
}

InlineObject struct for InlineObject

type InlineObject1 ¶ 

type InlineObject1 struct {
	Short    int32   `json:"short,omitempty"`
	Char     string  `json:"char,omitempty"`
	Int      int32   `json:"int,omitempty"`
	Long     int64   `json:"long,omitempty"`
	Float    float32 `json:"float,omitempty"`
	Double   float64 `json:"double,omitempty"`
	Direct   bool    `json:"direct,omitempty"`
	ReadOnly bool    `json:"readOnly,omitempty"`
}

InlineObject1 Byte array request body

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 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 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) 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 MarkAsReadOpts ¶ 

type MarkAsReadOpts struct {
	Read optional.Bool
}

MarkAsReadOpts Optional parameters for the method 'MarkAsRead'

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"`
	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"`
	UserId    *string   `json:"userId,omitempty"`
	Subject   *string   `json:"subject,omitempty"`
	CreatedAt time.Time `json:"createdAt"`
}

MissedEmailProjection Missed email data

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

OrganizationInboxProjection Organization team inbox

type PageAlias ¶ 

type PageAlias struct {
	Content          []AliasProjection `json:"content,omitempty"`
	Pageable         PageableObject    `json:"pageable,omitempty"`
	Total            int64             `json:"total,omitempty"`
	TotalElements    int64             `json:"totalElements,omitempty"`
	TotalPages       int32             `json:"totalPages,omitempty"`
	Last             bool              `json:"last,omitempty"`
	Size             int32             `json:"size,omitempty"`
	Number           int32             `json:"number,omitempty"`
	Sort             Sort              `json:"sort,omitempty"`
	NumberOfElements int32             `json:"numberOfElements,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 PageAttachmentEntity ¶ 

type PageAttachmentEntity struct {
	Content          []AttachmentProjection `json:"content,omitempty"`
	Pageable         PageableObject         `json:"pageable,omitempty"`
	Total            int64                  `json:"total,omitempty"`
	TotalElements    int64                  `json:"totalElements,omitempty"`
	TotalPages       int32                  `json:"totalPages,omitempty"`
	Last             bool                   `json:"last,omitempty"`
	Size             int32                  `json:"size,omitempty"`
	Number           int32                  `json:"number,omitempty"`
	Sort             Sort                   `json:"sort,omitempty"`
	NumberOfElements int32                  `json:"numberOfElements,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"`
	Total            int64              `json:"total,omitempty"`
	TotalElements    int64              `json:"totalElements,omitempty"`
	TotalPages       int32              `json:"totalPages,omitempty"`
	Last             bool               `json:"last,omitempty"`
	Size             int32              `json:"size,omitempty"`
	Number           int32              `json:"number,omitempty"`
	Sort             Sort               `json:"sort,omitempty"`
	NumberOfElements int32              `json:"numberOfElements,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"`
	Total            int64                       `json:"total,omitempty"`
	TotalElements    int64                       `json:"totalElements,omitempty"`
	TotalPages       int32                       `json:"totalPages,omitempty"`
	Last             bool                        `json:"last,omitempty"`
	Size             int32                       `json:"size,omitempty"`
	Number           int32                       `json:"number,omitempty"`
	Sort             Sort                        `json:"sort,omitempty"`
	NumberOfElements int32                       `json:"numberOfElements,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"`
	Total            int64          `json:"total,omitempty"`
	TotalElements    int64          `json:"totalElements,omitempty"`
	TotalPages       int32          `json:"totalPages,omitempty"`
	Last             bool           `json:"last,omitempty"`
	Size             int32          `json:"size,omitempty"`
	Number           int32          `json:"number,omitempty"`
	Sort             Sort           `json:"sort,omitempty"`
	NumberOfElements int32          `json:"numberOfElements,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 PageContactProjection ¶ 

type PageContactProjection struct {
	Content          []ContactProjection `json:"content,omitempty"`
	Pageable         PageableObject      `json:"pageable,omitempty"`
	Total            int64               `json:"total,omitempty"`
	TotalElements    int64               `json:"totalElements,omitempty"`
	TotalPages       int32               `json:"totalPages,omitempty"`
	Last             bool                `json:"last,omitempty"`
	Size             int32               `json:"size,omitempty"`
	Number           int32               `json:"number,omitempty"`
	Sort             Sort                `json:"sort,omitempty"`
	NumberOfElements int32               `json:"numberOfElements,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"`
	Total            int64               `json:"total,omitempty"`
	TotalElements    int64               `json:"totalElements,omitempty"`
	TotalPages       int32               `json:"totalPages,omitempty"`
	Last             bool                `json:"last,omitempty"`
	Size             int32               `json:"size,omitempty"`
	Number           int32               `json:"number,omitempty"`
	Sort             Sort                `json:"sort,omitempty"`
	NumberOfElements int32               `json:"numberOfElements,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 PageEmailPreview ¶ 

type PageEmailPreview struct {
	Content          []EmailPreview `json:"content,omitempty"`
	Pageable         PageableObject `json:"pageable,omitempty"`
	Total            int64          `json:"total,omitempty"`
	TotalElements    int64          `json:"totalElements,omitempty"`
	TotalPages       int32          `json:"totalPages,omitempty"`
	Last             bool           `json:"last,omitempty"`
	Size             int32          `json:"size,omitempty"`
	Number           int32          `json:"number,omitempty"`
	Sort             Sort           `json:"sort,omitempty"`
	NumberOfElements int32          `json:"numberOfElements,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"`
	Total            int64             `json:"total,omitempty"`
	TotalElements    int64             `json:"totalElements,omitempty"`
	TotalPages       int32             `json:"totalPages,omitempty"`
	Last             bool              `json:"last,omitempty"`
	Size             int32             `json:"size,omitempty"`
	Number           int32             `json:"number,omitempty"`
	Sort             Sort              `json:"sort,omitempty"`
	NumberOfElements int32             `json:"numberOfElements,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 PageEmailValidationRequest ¶ 

type PageEmailValidationRequest struct {
	Content          []EmailValidationRequestDto `json:"content,omitempty"`
	Pageable         PageableObject              `json:"pageable,omitempty"`
	Total            int64                       `json:"total,omitempty"`
	TotalElements    int64                       `json:"totalElements,omitempty"`
	TotalPages       int32                       `json:"totalPages,omitempty"`
	Last             bool                        `json:"last,omitempty"`
	Size             int32                       `json:"size,omitempty"`
	Number           int32                       `json:"number,omitempty"`
	Sort             Sort                        `json:"sort,omitempty"`
	NumberOfElements int32                       `json:"numberOfElements,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 PageExpiredInboxRecordProjection ¶ 

type PageExpiredInboxRecordProjection struct {
	Content          []ExpiredInboxRecordProjection `json:"content,omitempty"`
	Pageable         PageableObject                 `json:"pageable,omitempty"`
	Total            int64                          `json:"total,omitempty"`
	TotalElements    int64                          `json:"totalElements,omitempty"`
	TotalPages       int32                          `json:"totalPages,omitempty"`
	Last             bool                           `json:"last,omitempty"`
	Size             int32                          `json:"size,omitempty"`
	Number           int32                          `json:"number,omitempty"`
	Sort             Sort                           `json:"sort,omitempty"`
	NumberOfElements int32                          `json:"numberOfElements,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"`
	Total            int64             `json:"total,omitempty"`
	TotalElements    int64             `json:"totalElements,omitempty"`
	TotalPages       int32             `json:"totalPages,omitempty"`
	Last             bool              `json:"last,omitempty"`
	Size             int32             `json:"size,omitempty"`
	Number           int32             `json:"number,omitempty"`
	Sort             Sort              `json:"sort,omitempty"`
	NumberOfElements int32             `json:"numberOfElements,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 PageInboxForwarderDto ¶ 

type PageInboxForwarderDto struct {
	Content          []InboxForwarderDto `json:"content,omitempty"`
	Pageable         PageableObject      `json:"pageable,omitempty"`
	Total            int64               `json:"total,omitempty"`
	TotalElements    int64               `json:"totalElements,omitempty"`
	TotalPages       int32               `json:"totalPages,omitempty"`
	Last             bool                `json:"last,omitempty"`
	Size             int32               `json:"size,omitempty"`
	Number           int32               `json:"number,omitempty"`
	Sort             Sort                `json:"sort,omitempty"`
	NumberOfElements int32               `json:"numberOfElements,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"`
	Total            int64                           `json:"total,omitempty"`
	TotalElements    int64                           `json:"totalElements,omitempty"`
	TotalPages       int32                           `json:"totalPages,omitempty"`
	Last             bool                            `json:"last,omitempty"`
	Size             int32                           `json:"size,omitempty"`
	Number           int32                           `json:"number,omitempty"`
	Sort             Sort                            `json:"sort,omitempty"`
	NumberOfElements int32                           `json:"numberOfElements,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"`
	Total            int64          `json:"total,omitempty"`
	TotalElements    int64          `json:"totalElements,omitempty"`
	TotalPages       int32          `json:"totalPages,omitempty"`
	Last             bool           `json:"last,omitempty"`
	Size             int32          `json:"size,omitempty"`
	Number           int32          `json:"number,omitempty"`
	Sort             Sort           `json:"sort,omitempty"`
	NumberOfElements int32          `json:"numberOfElements,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"`
	Total            int64             `json:"total,omitempty"`
	TotalElements    int64             `json:"totalElements,omitempty"`
	TotalPages       int32             `json:"totalPages,omitempty"`
	Last             bool              `json:"last,omitempty"`
	Size             int32             `json:"size,omitempty"`
	Number           int32             `json:"number,omitempty"`
	Sort             Sort              `json:"sort,omitempty"`
	NumberOfElements int32             `json:"numberOfElements,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"`
	Total            int64                         `json:"total,omitempty"`
	TotalElements    int64                         `json:"totalElements,omitempty"`
	TotalPages       int32                         `json:"totalPages,omitempty"`
	Last             bool                          `json:"last,omitempty"`
	Size             int32                         `json:"size,omitempty"`
	Number           int32                         `json:"number,omitempty"`
	Sort             Sort                          `json:"sort,omitempty"`
	NumberOfElements int32                         `json:"numberOfElements,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 PageInboxRulesetDto ¶ 

type PageInboxRulesetDto struct {
	Content          []InboxRulesetDto `json:"content,omitempty"`
	Pageable         PageableObject    `json:"pageable,omitempty"`
	Total            int64             `json:"total,omitempty"`
	TotalElements    int64             `json:"totalElements,omitempty"`
	TotalPages       int32             `json:"totalPages,omitempty"`
	Last             bool              `json:"last,omitempty"`
	Size             int32             `json:"size,omitempty"`
	Number           int32             `json:"number,omitempty"`
	Sort             Sort              `json:"sort,omitempty"`
	NumberOfElements int32             `json:"numberOfElements,omitempty"`
	First            bool              `json:"first,omitempty"`
	Empty            bool              `json:"empty,omitempty"`
}

PageInboxRulesetDto Paginated inbox ruleset 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 PageListUnsubscribeRecipients ¶ 

type PageListUnsubscribeRecipients struct {
	Content          []ListUnsubscribeRecipientProjection `json:"content,omitempty"`
	Pageable         PageableObject                       `json:"pageable,omitempty"`
	Total            int64                                `json:"total,omitempty"`
	TotalElements    int64                                `json:"totalElements,omitempty"`
	TotalPages       int32                                `json:"totalPages,omitempty"`
	Last             bool                                 `json:"last,omitempty"`
	Size             int32                                `json:"size,omitempty"`
	Number           int32                                `json:"number,omitempty"`
	Sort             Sort                                 `json:"sort,omitempty"`
	NumberOfElements int32                                `json:"numberOfElements,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"`
	Total            int64                   `json:"total,omitempty"`
	TotalElements    int64                   `json:"totalElements,omitempty"`
	TotalPages       int32                   `json:"totalPages,omitempty"`
	Last             bool                    `json:"last,omitempty"`
	Size             int32                   `json:"size,omitempty"`
	Number           int32                   `json:"number,omitempty"`
	Sort             Sort                    `json:"sort,omitempty"`
	NumberOfElements int32                   `json:"numberOfElements,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 PageOrganizationInboxProjection ¶ 

type PageOrganizationInboxProjection struct {
	Content          []OrganizationInboxProjection `json:"content,omitempty"`
	Pageable         PageableObject                `json:"pageable,omitempty"`
	Total            int64                         `json:"total,omitempty"`
	TotalElements    int64                         `json:"totalElements,omitempty"`
	TotalPages       int32                         `json:"totalPages,omitempty"`
	Last             bool                          `json:"last,omitempty"`
	Size             int32                         `json:"size,omitempty"`
	Number           int32                         `json:"number,omitempty"`
	Sort             Sort                          `json:"sort,omitempty"`
	NumberOfElements int32                         `json:"numberOfElements,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 PagePhoneNumberProjection ¶ 

type PagePhoneNumberProjection struct {
	Content          []PhoneNumberProjection `json:"content,omitempty"`
	Pageable         PageableObject          `json:"pageable,omitempty"`
	Total            int64                   `json:"total,omitempty"`
	TotalElements    int64                   `json:"totalElements,omitempty"`
	TotalPages       int32                   `json:"totalPages,omitempty"`
	Last             bool                    `json:"last,omitempty"`
	Size             int32                   `json:"size,omitempty"`
	Number           int32                   `json:"number,omitempty"`
	Sort             Sort                    `json:"sort,omitempty"`
	NumberOfElements int32                   `json:"numberOfElements,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 PageScheduledJobs ¶ 

type PageScheduledJobs struct {
	Content          []ScheduledJob `json:"content,omitempty"`
	Pageable         PageableObject `json:"pageable,omitempty"`
	Total            int64          `json:"total,omitempty"`
	TotalElements    int64          `json:"totalElements,omitempty"`
	TotalPages       int32          `json:"totalPages,omitempty"`
	Last             bool           `json:"last,omitempty"`
	Size             int32          `json:"size,omitempty"`
	Number           int32          `json:"number,omitempty"`
	Sort             Sort           `json:"sort,omitempty"`
	NumberOfElements int32          `json:"numberOfElements,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 {
	// Collection of items
	Content  []SentEmailProjection `json:"content"`
	Pageable PageableObject        `json:"pageable,omitempty"`
	Total    int64                 `json:"total,omitempty"`
	// Size of page requested
	Size int32 `json:"size"`
	// Page number starting at 0
	Number int32 `json:"number"`
	// Number of items returned
	NumberOfElements int32 `json:"numberOfElements"`
	// Total number of items available for querying
	TotalElements int64 `json:"totalElements"`
	// Total number of pages available
	TotalPages int32 `json:"totalPages"`
	Last       bool  `json:"last,omitempty"`
	Sort       Sort  `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 {
	// Collection of items
	Content  []SendWithQueueResult `json:"content"`
	Pageable PageableObject        `json:"pageable,omitempty"`
	Total    int64                 `json:"total,omitempty"`
	// Size of page requested
	Size int32 `json:"size"`
	// Page number starting at 0
	Number int32 `json:"number"`
	// Number of items returned
	NumberOfElements int32 `json:"numberOfElements"`
	// Total number of items available for querying
	TotalElements int64 `json:"totalElements"`
	// Total number of pages available
	TotalPages int32 `json:"totalPages"`
	Last       bool  `json:"last,omitempty"`
	Sort       Sort  `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 PageSmsProjection ¶ 

type PageSmsProjection struct {
	Content          []SmsProjection `json:"content,omitempty"`
	Pageable         PageableObject  `json:"pageable,omitempty"`
	Total            int64           `json:"total,omitempty"`
	TotalElements    int64           `json:"totalElements,omitempty"`
	TotalPages       int32           `json:"totalPages,omitempty"`
	Last             bool            `json:"last,omitempty"`
	Size             int32           `json:"size,omitempty"`
	Number           int32           `json:"number,omitempty"`
	Sort             Sort            `json:"sort,omitempty"`
	NumberOfElements int32           `json:"numberOfElements,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 PageTemplateProjection ¶ 

type PageTemplateProjection struct {
	Content          []TemplateProjection `json:"content,omitempty"`
	Pageable         PageableObject       `json:"pageable,omitempty"`
	Total            int64                `json:"total,omitempty"`
	TotalElements    int64                `json:"totalElements,omitempty"`
	TotalPages       int32                `json:"totalPages,omitempty"`
	Last             bool                 `json:"last,omitempty"`
	Size             int32                `json:"size,omitempty"`
	Number           int32                `json:"number,omitempty"`
	Sort             Sort                 `json:"sort,omitempty"`
	NumberOfElements int32                `json:"numberOfElements,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 PageThreadProjection ¶ 

type PageThreadProjection struct {
	Content          []ThreadProjection `json:"content,omitempty"`
	Pageable         PageableObject     `json:"pageable,omitempty"`
	Total            int64              `json:"total,omitempty"`
	TotalElements    int64              `json:"totalElements,omitempty"`
	TotalPages       int32              `json:"totalPages,omitempty"`
	Last             bool               `json:"last,omitempty"`
	Size             int32              `json:"size,omitempty"`
	Number           int32              `json:"number,omitempty"`
	Sort             Sort               `json:"sort,omitempty"`
	NumberOfElements int32              `json:"numberOfElements,omitempty"`
	First            bool               `json:"first,omitempty"`
	Empty            bool               `json:"empty,omitempty"`
}

PageThreadProjection 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 PageTrackingPixelProjection ¶ 

type PageTrackingPixelProjection struct {
	Content          []TrackingPixelProjection `json:"content,omitempty"`
	Pageable         PageableObject            `json:"pageable,omitempty"`
	Total            int64                     `json:"total,omitempty"`
	TotalElements    int64                     `json:"totalElements,omitempty"`
	TotalPages       int32                     `json:"totalPages,omitempty"`
	Last             bool                      `json:"last,omitempty"`
	Size             int32                     `json:"size,omitempty"`
	Number           int32                     `json:"number,omitempty"`
	Sort             Sort                      `json:"sort,omitempty"`
	NumberOfElements int32                     `json:"numberOfElements,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"`
	Total            int64                          `json:"total,omitempty"`
	TotalElements    int64                          `json:"totalElements,omitempty"`
	TotalPages       int32                          `json:"totalPages,omitempty"`
	Last             bool                           `json:"last,omitempty"`
	Size             int32                          `json:"size,omitempty"`
	Number           int32                          `json:"number,omitempty"`
	Sort             Sort                           `json:"sort,omitempty"`
	NumberOfElements int32                          `json:"numberOfElements,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 PageWebhookProjection ¶ 

type PageWebhookProjection struct {
	Content          []WebhookProjection `json:"content,omitempty"`
	Pageable         PageableObject      `json:"pageable,omitempty"`
	Total            int64               `json:"total,omitempty"`
	TotalElements    int64               `json:"totalElements,omitempty"`
	TotalPages       int32               `json:"totalPages,omitempty"`
	Last             bool                `json:"last,omitempty"`
	Size             int32               `json:"size,omitempty"`
	Number           int32               `json:"number,omitempty"`
	Sort             Sort                `json:"sort,omitempty"`
	NumberOfElements int32               `json:"numberOfElements,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"`
	Total            int64              `json:"total,omitempty"`
	TotalElements    int64              `json:"totalElements,omitempty"`
	TotalPages       int32              `json:"totalPages,omitempty"`
	Last             bool               `json:"last,omitempty"`
	Size             int32              `json:"size,omitempty"`
	Number           int32              `json:"number,omitempty"`
	Sort             Sort               `json:"sort,omitempty"`
	NumberOfElements int32              `json:"numberOfElements,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"`
	Sort       Sort  `json:"sort,omitempty"`
	PageNumber int32 `json:"pageNumber,omitempty"`
	PageSize   int32 `json:"pageSize,omitempty"`
	Paged      bool  `json:"paged,omitempty"`
	Unpaged    bool  `json:"unpaged,omitempty"`
}

PageableObject struct for PageableObject

type PhoneControllerApiService ¶ 

type PhoneControllerApiService service

PhoneControllerApiService PhoneControllerApi service

func (*PhoneControllerApiService) CreateEmergencyAddress ¶ 

func (a *PhoneControllerApiService) CreateEmergencyAddress(ctx _context.Context, createEmergencyAddressOptions CreateEmergencyAddressOptions) (EmergencyAddress, *_nethttp.Response, error)

CreateEmergencyAddress Method for CreateEmergencyAddress

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

@return EmergencyAddress

func (*PhoneControllerApiService) DeleteEmergencyAddress ¶ 

func (a *PhoneControllerApiService) DeleteEmergencyAddress(ctx _context.Context, addressId string) (EmptyResponseDto, *_nethttp.Response, error)

DeleteEmergencyAddress Method for DeleteEmergencyAddress

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

@return EmptyResponseDto

func (*PhoneControllerApiService) DeletePhoneNumber ¶ 

func (a *PhoneControllerApiService) DeletePhoneNumber(ctx _context.Context, phoneNumberId string) (*_nethttp.Response, error)

DeletePhoneNumber Method for DeletePhoneNumber

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

func (*PhoneControllerApiService) GetEmergencyAddress ¶ 

func (a *PhoneControllerApiService) GetEmergencyAddress(ctx _context.Context, addressId string) (EmergencyAddress, *_nethttp.Response, error)

GetEmergencyAddress Method for GetEmergencyAddress

  • @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 Method for GetEmergencyAddresses

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

@return []EmergencyAddressDto

func (*PhoneControllerApiService) GetPhoneNumber ¶ 

func (a *PhoneControllerApiService) GetPhoneNumber(ctx _context.Context, phoneNumberId string) (PhoneNumberDto, *_nethttp.Response, error)

GetPhoneNumber Method for GetPhoneNumber

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

@return PhoneNumberDto

func (*PhoneControllerApiService) GetPhoneNumbers ¶ 

func (a *PhoneControllerApiService) GetPhoneNumbers(ctx _context.Context, localVarOptionals *GetPhoneNumbersOpts) (PagePhoneNumberProjection, *_nethttp.Response, error)

GetPhoneNumbers Method for GetPhoneNumbers

  • @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 "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

@return PagePhoneNumberProjection

func (*PhoneControllerApiService) GetPhonePlans ¶ 

func (a *PhoneControllerApiService) GetPhonePlans(ctx _context.Context) ([]PhonePlanDto, *_nethttp.Response, error)

GetPhonePlans Method for GetPhonePlans

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

@return []PhonePlanDto

func (*PhoneControllerApiService) TestPhoneNumberSendSms ¶ 

func (a *PhoneControllerApiService) TestPhoneNumberSendSms(ctx _context.Context, phoneNumberId string, testPhoneNumberOptions TestPhoneNumberOptions, localVarOptionals *TestPhoneNumberSendSmsOpts) (*_nethttp.Response, error)

TestPhoneNumberSendSms Method for TestPhoneNumberSendSms

  • @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) -

type PhoneNumberDto ¶ 

type PhoneNumberDto struct {
	Id                string    `json:"id"`
	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"`
}

PhoneNumberDto struct for PhoneNumberDto

type PhoneNumberProjection ¶ 

type PhoneNumberProjection struct {
	Id           string    `json:"id"`
	UserId       string    `json:"userId"`
	PhoneCountry string    `json:"phoneCountry"`
	CreatedAt    time.Time `json:"createdAt"`
	PhoneNumber  string    `json:"phoneNumber"`
}

PhoneNumberProjection Phone number projection

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

SendEmailOptions Options for the email to be sent

type SendEmailSourceOptionalOpts ¶ 

type SendEmailSourceOptionalOpts struct {
	InboxId       optional.Interface
	UseDomainPool optional.Bool
	VirtualSend   optional.Bool
}

SendEmailSourceOptionalOpts Optional parameters for the method 'SendEmailSourceOptional'

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 Collection of items

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 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"`
	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"`
	PixelIds          *[]string                          `json:"pixelIds,omitempty"`
	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"`
	Html              bool                               `json:"html,omitempty"`
}

SentEmailDto Sent email details

type SentEmailProjection ¶ 

type SentEmailProjection struct {
	Id          string    `json:"id"`
	From        string    `json:"from,omitempty"`
	Subject     string    `json:"subject,omitempty"`
	UserId      string    `json:"userId"`
	InboxId     string    `json:"inboxId"`
	Attachments []string  `json:"attachments"`
	CreatedAt   time.Time `json:"createdAt"`
	To          []string  `json:"to"`
	Bcc         []string  `json:"bcc"`
	Cc          []string  `json:"cc"`
	BodyMD5Hash string    `json:"bodyMD5Hash,omitempty"`
	VirtualSend bool      `json:"virtualSend"`
}

SentEmailProjection Collection of items

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

@return string

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 ServerConfiguration ¶ 

type ServerConfiguration struct {
	Url         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

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 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) 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) 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) GetSmsMessagesPaginated ¶ 

func (a *SmsControllerApiService) GetSmsMessagesPaginated(ctx _context.Context, localVarOptionals *GetSmsMessagesPaginatedOpts) (PageSmsProjection, *_nethttp.Response, error)

GetSmsMessagesPaginated 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 *GetSmsMessagesPaginatedOpts - 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 "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

@return PageSmsProjection

type SmsDto ¶ 

type SmsDto struct {
	Id          string    `json:"id"`
	UserId      string    `json:"userId"`
	PhoneNumber string    `json:"phoneNumber"`
	FromNumber  string    `json:"fromNumber"`
	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"`
	Body        string    `json:"body"`
	PhoneNumber string    `json:"phoneNumber"`
	FromNumber  string    `json:"fromNumber"`
	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 Sort ¶ 

type Sort struct {
	Empty    bool `json:"empty,omitempty"`
	Sorted   bool `json:"sorted,omitempty"`
	Unsorted bool `json:"unsorted,omitempty"`
}

Sort struct for Sort

type SubmitFormOpts ¶ 

type SubmitFormOpts struct {
	To              optional.String
	Subject         optional.String
	RedirectTo      optional.String
	EmailAddress    optional.String
	SuccessMessage  optional.String
	SpamCheck       optional.String
	OtherParameters optional.String
}

SubmitFormOpts Optional parameters for the method 'SubmitForm'

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"`
	CreatedAt time.Time `json:"createdAt"`
	UpdatedAt time.Time `json:"updatedAt"`
	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 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   InboxRulesetTestOptions   `json:"inboxRulesetTestOptions"`
	CreateInboxRulesetOptions CreateInboxRulesetOptions `json:"createInboxRulesetOptions"`
}

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 ThreadProjection ¶ 

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

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

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 emails

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 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 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"`
	// String or wildcard style match for field specified when evaluating reply rules
	Match string `json:"match"`
	// 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"`
}

UpdateInboxReplierOptions Options for updating an inbox replier

type UploadAttachmentBytesOpts ¶ 

type UploadAttachmentBytesOpts struct {
	ContentType optional.String
	Filename    optional.String
}

UploadAttachmentBytesOpts Optional parameters for the method 'UploadAttachmentBytes'

type UploadAttachmentOptions ¶ 

type UploadAttachmentOptions struct {
	// 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 {
	ContentType  optional.String
	Filename     optional.String
	XFilename    optional.String
	InlineObject optional.Interface
}

UploadMultipartFormOpts Optional parameters for the method 'UploadMultipartForm'

type UserControllerApiService ¶ 

type UserControllerApiService service

UserControllerApiService UserControllerApi service

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

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 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 `waitForSms` etc., 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) 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 "EventType" (optional.String) - Optional event type
  • @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 PageWebhookProjection

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

@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 "PhoneId" (optional.Interface of string) - Filter by phoneId
  • @param "Before" (optional.Time) - Filter by created at before the given timestamp

@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

@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

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

@return PageWebhookResult

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) ([]WebhookDto, *_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

@return []WebhookDto

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

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

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 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 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"`
	InboxId       string    `json:"inboxId,omitempty"`
	EventName     string    `json:"eventName,omitempty"`
	CreatedAt     time.Time `json:"createdAt"`
	UpdatedAt     time.Time `json:"updatedAt"`
	PhoneNumberId string    `json:"phoneNumberId,omitempty"`
}

WebhookProjection Representation of a 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"`
	InboxId             *string   `json:"inboxId,omitempty"`
	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"`
}

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.