Interface ISentEmailsControllerApiSync
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface ISentEmailsControllerApiSync : IApiAccessor
Methods
View SourceDeleteAllSentEmails(int)
Delete all sent email receipts
Declaration
void DeleteAllSentEmails(int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
int | operationIndex | Index associated with the operation. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
DeleteAllSentEmailsWithHttpInfo(int)
Delete all sent email receipts
Declaration
ApiResponse<object> DeleteAllSentEmailsWithHttpInfo(int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<object> | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
DeleteSentEmail(Guid, int)
Delete sent email receipt
Declaration
void DeleteSentEmail(Guid id, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | |
int | operationIndex | Index associated with the operation. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
DeleteSentEmailWithHttpInfo(Guid, int)
Delete sent email receipt
Declaration
ApiResponse<object> DeleteSentEmailWithHttpInfo(Guid id, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<object> | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetAllSentTrackingPixels(int?, int?, string, string, DateTime?, DateTime?, int)
Declaration
PageTrackingPixelProjection GetAllSentTrackingPixels(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
int? | page | Optional page index in sent email tracking pixel list pagination (optional, default to 0) |
int? | size | Optional page size in sent email tracking pixel list pagination (optional, default to 20) |
string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
string | searchFilter | Optional search filter (optional) |
DateTime? | since | Filter by created at after the given timestamp (optional) |
DateTime? | before | Filter by created at before the given timestamp (optional) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
PageTrackingPixelProjection | PageTrackingPixelProjection |
Remarks
Get all sent email tracking pixels in paginated form
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetAllSentTrackingPixelsWithHttpInfo(int?, int?, string, string, DateTime?, DateTime?, int)
Declaration
ApiResponse<PageTrackingPixelProjection> GetAllSentTrackingPixelsWithHttpInfo(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
int? | page | Optional page index in sent email tracking pixel list pagination (optional, default to 0) |
int? | size | Optional page size in sent email tracking pixel list pagination (optional, default to 20) |
string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
string | searchFilter | Optional search filter (optional) |
DateTime? | since | Filter by created at after the given timestamp (optional) |
DateTime? | before | Filter by created at before the given timestamp (optional) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<PageTrackingPixelProjection> | ApiResponse of PageTrackingPixelProjection |
Remarks
Get all sent email tracking pixels in paginated form
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetRawSentEmailContents(Guid, int)
Get raw sent email string. Returns unparsed raw SMTP message with headers and body.
Declaration
void GetRawSentEmailContents(Guid emailId, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | emailId | ID of email |
int | operationIndex | Index associated with the operation. |
Remarks
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
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetRawSentEmailContentsWithHttpInfo(Guid, int)
Get raw sent email string. Returns unparsed raw SMTP message with headers and body.
Declaration
ApiResponse<object> GetRawSentEmailContentsWithHttpInfo(Guid emailId, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | emailId | ID of email |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<object> | ApiResponse of Object(void) |
Remarks
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
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetRawSentEmailJson(Guid, int)
Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format.
Declaration
RawEmailJson GetRawSentEmailJson(Guid emailId, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | emailId | ID of email |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
RawEmailJson | RawEmailJson |
Remarks
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
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetRawSentEmailJsonWithHttpInfo(Guid, int)
Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format.
Declaration
ApiResponse<RawEmailJson> GetRawSentEmailJsonWithHttpInfo(Guid emailId, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | emailId | ID of email |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<RawEmailJson> | ApiResponse of RawEmailJson |
Remarks
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
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetSentDeliveryStatus(Guid, int)
Declaration
DeliveryStatusDto GetSentDeliveryStatus(Guid deliveryId, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | deliveryId | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
DeliveryStatusDto | DeliveryStatusDto |
Remarks
Get a sent email delivery status
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetSentDeliveryStatuses(int?, int?, string, DateTime?, DateTime?, int)
Declaration
PageDeliveryStatus GetSentDeliveryStatuses(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
int? | page | Optional page index in delivery status list pagination (optional, default to 0) |
int? | size | Optional page size in delivery status list pagination (optional, default to 20) |
string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
DateTime? | since | Filter by created at after the given timestamp (optional) |
DateTime? | before | Filter by created at before the given timestamp (optional) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
PageDeliveryStatus | PageDeliveryStatus |
Remarks
Get all sent email delivery statuses
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetSentDeliveryStatusesBySentId(Guid, int?, int?, string, DateTime?, DateTime?, int)
Declaration
PageDeliveryStatus GetSentDeliveryStatusesBySentId(Guid sentId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | sentId | ID of the sent email that you want to get the delivery status of. Sent email object is returned when sending an email |
int? | page | Optional page index in delivery status list pagination (optional, default to 0) |
int? | size | Optional page size in delivery status list pagination (optional, default to 20) |
string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
DateTime? | since | Filter by created at after the given timestamp (optional) |
DateTime? | before | Filter by created at before the given timestamp (optional) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
PageDeliveryStatus | PageDeliveryStatus |
Remarks
Get all sent email delivery statuses
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetSentDeliveryStatusesBySentIdWithHttpInfo(Guid, int?, int?, string, DateTime?, DateTime?, int)
Declaration
ApiResponse<PageDeliveryStatus> GetSentDeliveryStatusesBySentIdWithHttpInfo(Guid sentId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | sentId | ID of the sent email that you want to get the delivery status of. Sent email object is returned when sending an email |
int? | page | Optional page index in delivery status list pagination (optional, default to 0) |
int? | size | Optional page size in delivery status list pagination (optional, default to 20) |
string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
DateTime? | since | Filter by created at after the given timestamp (optional) |
DateTime? | before | Filter by created at before the given timestamp (optional) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<PageDeliveryStatus> | ApiResponse of PageDeliveryStatus |
Remarks
Get all sent email delivery statuses
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetSentDeliveryStatusesWithHttpInfo(int?, int?, string, DateTime?, DateTime?, int)
Declaration
ApiResponse<PageDeliveryStatus> GetSentDeliveryStatusesWithHttpInfo(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
int? | page | Optional page index in delivery status list pagination (optional, default to 0) |
int? | size | Optional page size in delivery status list pagination (optional, default to 20) |
string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
DateTime? | since | Filter by created at after the given timestamp (optional) |
DateTime? | before | Filter by created at before the given timestamp (optional) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<PageDeliveryStatus> | ApiResponse of PageDeliveryStatus |
Remarks
Get all sent email delivery statuses
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetSentDeliveryStatusWithHttpInfo(Guid, int)
Declaration
ApiResponse<DeliveryStatusDto> GetSentDeliveryStatusWithHttpInfo(Guid deliveryId, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | deliveryId | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<DeliveryStatusDto> | ApiResponse of DeliveryStatusDto |
Remarks
Get a sent email delivery status
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetSentEmail(Guid, int)
Get sent email receipt
Declaration
SentEmailDto GetSentEmail(Guid id, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
SentEmailDto | SentEmailDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetSentEmailHTMLContent(Guid, int)
Get sent email HTML content
Declaration
string GetSentEmailHTMLContent(Guid id, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
string | string |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetSentEmailHTMLContentWithHttpInfo(Guid, int)
Get sent email HTML content
Declaration
ApiResponse<string> GetSentEmailHTMLContentWithHttpInfo(Guid id, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<string> | ApiResponse of string |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetSentEmailPreviewURLs(Guid, int)
Get sent email URL for viewing in browser or downloading
Declaration
EmailPreviewUrls GetSentEmailPreviewURLs(Guid id, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
EmailPreviewUrls | EmailPreviewUrls |
Remarks
Get a list of URLs for sent email content as text/html or raw SMTP message for viewing the message in a browser.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetSentEmailPreviewURLsWithHttpInfo(Guid, int)
Get sent email URL for viewing in browser or downloading
Declaration
ApiResponse<EmailPreviewUrls> GetSentEmailPreviewURLsWithHttpInfo(Guid id, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<EmailPreviewUrls> | ApiResponse of EmailPreviewUrls |
Remarks
Get a list of URLs for sent email content as text/html or raw SMTP message for viewing the message in a browser.
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetSentEmails(Guid?, int?, int?, string, string, DateTime?, DateTime?, int)
Get all sent emails in paginated form
Declaration
PageSentEmailProjection GetSentEmails(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid? | inboxId | Optional inboxId to filter sender of sent emails by (optional) |
int? | page | Optional page index in inbox sent email list pagination (optional, default to 0) |
int? | size | Optional page size in inbox sent email list pagination (optional, default to 20) |
string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
string | searchFilter | Optional search filter (optional) |
DateTime? | since | Filter by created at after the given timestamp (optional) |
DateTime? | before | Filter by created at before the given timestamp (optional) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
PageSentEmailProjection | PageSentEmailProjection |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetSentEmailsWithHttpInfo(Guid?, int?, int?, string, string, DateTime?, DateTime?, int)
Get all sent emails in paginated form
Declaration
ApiResponse<PageSentEmailProjection> GetSentEmailsWithHttpInfo(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid? | inboxId | Optional inboxId to filter sender of sent emails by (optional) |
int? | page | Optional page index in inbox sent email list pagination (optional, default to 0) |
int? | size | Optional page size in inbox sent email list pagination (optional, default to 20) |
string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
string | searchFilter | Optional search filter (optional) |
DateTime? | since | Filter by created at after the given timestamp (optional) |
DateTime? | before | Filter by created at before the given timestamp (optional) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<PageSentEmailProjection> | ApiResponse of PageSentEmailProjection |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetSentEmailsWithQueueResults(int?, int?, string, DateTime?, DateTime?, int)
Get results of email sent with queues in paginated form
Declaration
PageSentEmailWithQueueProjection GetSentEmailsWithQueueResults(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
int? | page | Optional page index in inbox sent email list pagination (optional, default to 0) |
int? | size | Optional page size in inbox sent email list pagination (optional, default to 20) |
string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
DateTime? | since | Filter by created at after the given timestamp (optional) |
DateTime? | before | Filter by created at before the given timestamp (optional) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
PageSentEmailWithQueueProjection | PageSentEmailWithQueueProjection |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetSentEmailsWithQueueResultsWithHttpInfo(int?, int?, string, DateTime?, DateTime?, int)
Get results of email sent with queues in paginated form
Declaration
ApiResponse<PageSentEmailWithQueueProjection> GetSentEmailsWithQueueResultsWithHttpInfo(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
int? | page | Optional page index in inbox sent email list pagination (optional, default to 0) |
int? | size | Optional page size in inbox sent email list pagination (optional, default to 20) |
string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
DateTime? | since | Filter by created at after the given timestamp (optional) |
DateTime? | before | Filter by created at before the given timestamp (optional) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<PageSentEmailWithQueueProjection> | ApiResponse of PageSentEmailWithQueueProjection |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetSentEmailTrackingPixels(Guid, int?, int?, string, string, DateTime?, DateTime?, int)
Declaration
PageTrackingPixelProjection GetSentEmailTrackingPixels(Guid id, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | |
int? | page | Optional page index in sent email tracking pixel list pagination (optional, default to 0) |
int? | size | Optional page size in sent email tracking pixel list pagination (optional, default to 20) |
string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
string | searchFilter | Optional search filter (optional) |
DateTime? | since | Filter by created at after the given timestamp (optional) |
DateTime? | before | Filter by created at before the given timestamp (optional) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
PageTrackingPixelProjection | PageTrackingPixelProjection |
Remarks
Get all tracking pixels for a sent email in paginated form
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetSentEmailTrackingPixelsWithHttpInfo(Guid, int?, int?, string, string, DateTime?, DateTime?, int)
Declaration
ApiResponse<PageTrackingPixelProjection> GetSentEmailTrackingPixelsWithHttpInfo(Guid id, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | |
int? | page | Optional page index in sent email tracking pixel list pagination (optional, default to 0) |
int? | size | Optional page size in sent email tracking pixel list pagination (optional, default to 20) |
string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
string | searchFilter | Optional search filter (optional) |
DateTime? | since | Filter by created at after the given timestamp (optional) |
DateTime? | before | Filter by created at before the given timestamp (optional) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<PageTrackingPixelProjection> | ApiResponse of PageTrackingPixelProjection |
Remarks
Get all tracking pixels for a sent email in paginated form
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetSentEmailWithHttpInfo(Guid, int)
Get sent email receipt
Declaration
ApiResponse<SentEmailDto> GetSentEmailWithHttpInfo(Guid id, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<SentEmailDto> | ApiResponse of SentEmailDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetSentOrganizationEmails(Guid?, int?, int?, string, string, DateTime?, DateTime?, int)
Declaration
PageSentEmailProjection GetSentOrganizationEmails(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid? | inboxId | Optional inboxId to filter sender of sent emails by (optional) |
int? | page | Optional page index in sent email list pagination (optional, default to 0) |
int? | size | Optional page size in sent email list pagination (optional, default to 20) |
string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
string | searchFilter | Optional search filter (optional) |
DateTime? | since | Filter by created at after the given timestamp (optional) |
DateTime? | before | Filter by created at before the given timestamp (optional) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
PageSentEmailProjection | PageSentEmailProjection |
Remarks
Get all sent organization emails in paginated form
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetSentOrganizationEmailsWithHttpInfo(Guid?, int?, int?, string, string, DateTime?, DateTime?, int)
Declaration
ApiResponse<PageSentEmailProjection> GetSentOrganizationEmailsWithHttpInfo(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid? | inboxId | Optional inboxId to filter sender of sent emails by (optional) |
int? | page | Optional page index in sent email list pagination (optional, default to 0) |
int? | size | Optional page size in sent email list pagination (optional, default to 20) |
string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
string | searchFilter | Optional search filter (optional) |
DateTime? | since | Filter by created at after the given timestamp (optional) |
DateTime? | before | Filter by created at before the given timestamp (optional) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<PageSentEmailProjection> | ApiResponse of PageSentEmailProjection |
Remarks
Get all sent organization emails in paginated form
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
WaitForDeliveryStatuses(Guid?, Guid?, long?, int?, DateTime?, DateTime?, int)
Declaration
DeliveryStatusDto WaitForDeliveryStatuses(Guid? sentId = null, Guid? inboxId = null, long? timeout = null, int? index = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid? | sentId | Optional sent email ID filter (optional) |
System.Guid? | inboxId | Optional inbox ID filter (optional) |
long? | timeout | Optional timeout milliseconds (optional) |
int? | index | 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 (optional) |
DateTime? | since | Filter by created at after the given timestamp (optional) |
DateTime? | before | Filter by created at before the given timestamp (optional) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
DeliveryStatusDto | DeliveryStatusDto |
Remarks
Wait for delivery statuses
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
WaitForDeliveryStatusesWithHttpInfo(Guid?, Guid?, long?, int?, DateTime?, DateTime?, int)
Declaration
ApiResponse<DeliveryStatusDto> WaitForDeliveryStatusesWithHttpInfo(Guid? sentId = null, Guid? inboxId = null, long? timeout = null, int? index = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid? | sentId | Optional sent email ID filter (optional) |
System.Guid? | inboxId | Optional inbox ID filter (optional) |
long? | timeout | Optional timeout milliseconds (optional) |
int? | index | 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 (optional) |
DateTime? | since | Filter by created at after the given timestamp (optional) |
DateTime? | before | Filter by created at before the given timestamp (optional) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<DeliveryStatusDto> | ApiResponse of DeliveryStatusDto |
Remarks
Wait for delivery statuses
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |