Structures
The following structures are available globally.
-
Core entity representation of an email folder business rule. Depicts the information of a user’s email folder and related information.
Declaration
Swift
public struct EmailFolderEntity : Equatable
-
Result type of an API that returns multiple records. Supports partial results.
See moreDeclaration
Swift
public struct BatchOperationResult<S, F>
-
Representation of the result of an unsuccessful operation performed on an email message
See moreDeclaration
Swift
public struct EmailMessageOperationFailureResult : Equatable
-
Representation of email configuration data in Platform SDK.
See moreDeclaration
Swift
public struct ConfigurationData : Equatable
-
The result of a successful email message delete
See moreDeclaration
Swift
public struct DeleteEmailMessageSuccessResult : Equatable
-
Representation of a draft email message object associated with a draft email message in Platform SDK.
See moreDeclaration
Swift
public struct DraftEmailMessage : Equatable
-
Representation of a draft email message metadata object associated with a draft email message in Platform SDK.
See moreDeclaration
Swift
public struct DraftEmailMessageMetadata
-
Representation of email address public information associated with an email address in the Platform SDK.
See moreDeclaration
Swift
public struct EmailAddressPublicInfo : Equatable
-
Representation of a email message object associated with a email message in Platform SDK.
See moreDeclaration
Swift
public struct EmailMessage : Equatable
-
Representation of an email message object without any unsealed attributes associated with a email message in Platform SDK.
See moreDeclaration
Swift
public struct PartialEmailMessage : Equatable
-
Representation of an email message date range used in the Sudo Platform Email SDK.
Note that both timestamps cannot be specified otherwise an
See moreInvalidArgumentError
will occur.Declaration
Swift
public struct EmailMessageDateRange : Equatable
-
Representation of an email message with body attachments used in the Sudo Platform Email SDK.
See moreDeclaration
Swift
public struct EmailMessageWithBody
-
input object for Provisioning an email address using
See moreSudoEmailClient
Declaration
Swift
public struct CheckEmailAddressAvailabilityInput : Equatable
-
Input object for creating a custom EmailFolder
See moreDeclaration
Swift
public struct CreateCustomEmailFolderInput
-
input object for creating a draft email message using
See moreSudoEmailClient
Declaration
Swift
public struct CreateDraftEmailMessageInput
-
Input object for deleting a custom EmailFolder
See moreDeclaration
Swift
public struct DeleteCustomEmailFolderInput
-
input object for deleting draft email messages using
See moreSudoEmailClient
Declaration
Swift
public struct DeleteDraftEmailMessagesInput
-
input object for getting a draft email message using
See moreSudoEmailClient
Declaration
Swift
public struct GetDraftEmailMessageInput
-
input object for getting an email address using
See moreSudoEmailClient
Declaration
Swift
public struct GetEmailAddressInput : Equatable
-
input object for getting an email message using
See moreSudoEmailClient
Declaration
Swift
public struct GetEmailMessageInput : Equatable
-
input object for getting an email message’s RFC822 data using
See moreSudoEmailClient
Declaration
Swift
public struct GetEmailMessageRfc822DataInput : Equatable
-
Input object containing an email message identifier and email address identifier used to retrieve the email message data.
See moreDeclaration
Swift
public struct GetEmailMessageWithBodyInput : Equatable
-
input object for getting a email addresses associated with a sudo using
See moreSudoEmailClient
Declaration
Swift
public struct ListEmailAddressesForSudoIdInput : Equatable
-
input object for getting an email address using
See moreSudoEmailClient
Declaration
Swift
public struct ListEmailAddressesInput : Equatable
-
input object for listing email folders for an email address using
See moreSudoEmailClient
Declaration
Swift
public struct ListEmailFoldersForEmailAddressIdInput : Equatable
-
input object for listing email messages for an email address using
See moreSudoEmailClient
Declaration
Swift
public struct ListEmailMessagesForEmailAddressInput : Equatable
-
input object for listing email messages for an email folder using
See moreSudoEmailClient
Declaration
Swift
public struct ListEmailMessagesForEmailFolderIdInput : Equatable
-
Input object for listing email messages using
See moreSudoEmailClient
Declaration
Swift
public struct ListEmailMessagesInput : Equatable
-
Input object for retrieving public info for email addresses using
See moreSudoEmailClient
.Declaration
Swift
public struct LookupEmailAddressesPublicInfoInput : Equatable
-
input object for Provisioning an email address using
See moreSudoEmailClient
Declaration
Swift
public struct ProvisionEmailAddressInput : Equatable
-
Input object containing information required to send an email message.
See moreDeclaration
Swift
public struct SendEmailMessageInput : Equatable
-
object defining the values to be set when updating a custom email address using
See moreSudoEmailClient
Declaration
Swift
public struct UpdateCustomEmailFolderValues : Equatable
-
input object for updating a custom email folder using
See moreSudoEmailClient
Declaration
Swift
public struct UpdateCustomEmailFolderInput : Equatable
-
input object for updating a draft email message using
See moreSudoEmailClient
Declaration
Swift
public struct UpdateDraftEmailMessageInput
-
object defining the values to be set when updating email address metadata using
See moreSudoEmailClient
Declaration
Swift
public struct UpdateEmailAddressMetadataValues : Equatable
-
input object for updating an email address’ metadata using
See moreSudoEmailClient
Declaration
Swift
public struct UpdateEmailAddressMetadataInput : Equatable
-
object defining the values to be set when updating a list of email messages using
See moreSudoEmailClient
Declaration
Swift
public struct UpdateEmailMessagesValues : Equatable
-
input object for updating a list of email messages using
See moreSudoEmailClient
Declaration
Swift
public struct UpdateEmailMessagesInput : Equatable
-
Representation of the email headers formatted under the RFC-6854 (supersedes RFC 822) standard. Some further rules (beyond RFC 6854) must also be applied to the data:
- At least one recipient must exist (to, cc, bcc).
- For all email addresses:
- Total length (including both local part and domain) must not exceed 256 characters.
- Local part must not exceed more than 64 characters.
- Input domain parts (domain separated by
.
) must not exceed 63 characters. - Address must match standard email address pattern:
^[a-zA-Z0-9](\.?[-_a-zA-Z0-9])*@[a-zA-Z0-9](-*\.?[a-zA-Z0-9])*\.[a-zA-Z](-?[a-zA-Z0-9])+$
.
Declaration
Swift
public struct InternetMessageFormatHeader : Equatable
-
Generic Type to wrap around an Output SudoEmail type from a List result.
This is useful for pagination requests and can use its
See morenextToken
to call the next paginated results.Declaration
Swift
public struct ListOutput<T>
extension ListOutput: Equatable where T: Equatable
-
Representation of an Owner object from the Email Service.
This represents the relationship of a unique identifier (
See moreid
) with theissuer
.Declaration
Swift
public struct Owner : Hashable
-
Result type of an API call to send an email message
See moreDeclaration
Swift
public struct SendEmailMessageResult
-
Representation of an unsealed blocked email address in Platform SDK
See moreDeclaration
Swift
public struct UnsealedBlockedAddress
-
The result of a successful email message update
See moreDeclaration
Swift
public struct UpdatedEmailMessageSuccess
-
Generic non-specific error.
See moreDeclaration
Swift
public struct AnyError : Error, CustomStringConvertible, LocalizedError, Equatable
-
Declaration
Swift
public struct EmailAddressAndName : Equatable, CustomStringConvertible
-
Generic non-specific error.
See moreDeclaration
Swift
public struct AnyError : Error, CustomStringConvertible, LocalizedError, Equatable
-
Representation of an Sudo Platform Email service messageReceived notification
See moreDeclaration
Swift
public struct EmailMessageReceivedNotification : SudoNotification, Equatable
-
Catch all notification in case new Sudo Platform Email Service notifications are emitted before an application has updated its Sudo Platform Email Notification Extension SDK
See moreDeclaration
Swift
public struct EmailUnknownNotification : SudoNotification, Equatable