Index
All Classes and Interfaces|All Packages|Serialized Form
A
- ALL - Enum constant in enum class com.mailosaur.models.SearchMatchOperator
- alt() - Method in class com.mailosaur.models.Image
-
Gets the `alt` text (alternative text), used to describe the image.
- analysis() - Method in class com.mailosaur.MailosaurClient
-
Gets message analysis operations.
- Analysis - Class in com.mailosaur
-
Message analysis operations.
- Analysis(MailosaurClient) - Constructor for class com.mailosaur.Analysis
- ANY - Enum constant in enum class com.mailosaur.models.SearchMatchOperator
- Attachment - Class in com.mailosaur.models
-
Describes a message attachment.
- Attachment() - Constructor for class com.mailosaur.models.Attachment
- attachments() - Method in class com.mailosaur.models.Message
-
Gets an array of attachment metadata for any attached files.
- attachments() - Method in class com.mailosaur.models.MessageSummary
-
Gets the number of attachments associated with the message.
B
- BaseModel - Class in com.mailosaur.models
- BaseModel() - Constructor for class com.mailosaur.models.BaseModel
- bcc() - Method in class com.mailosaur.models.Message
-
Gets the blind carbon-copied recipients for email messages.
- bcc() - Method in class com.mailosaur.models.MessageSummary
-
Gets the blind carbon-copied recipients for email messages.
- body() - Method in class com.mailosaur.models.MessageContent
-
Gets the HTML or plain text body of the message.
C
- canDisableImages() - Method in class com.mailosaur.models.PreviewEmailClient
-
If true, images can be disabled when generating previews.
- cc() - Method in class com.mailosaur.models.Message
-
Gets the carbon-copied recipients for email messages.
- cc() - Method in class com.mailosaur.models.MessageSummary
-
Gets the carbon-copied recipients for email messages.
- code() - Method in class com.mailosaur.models.OtpResult
-
Gets the current one-time password.
- Code - Class in com.mailosaur.models
-
Data associated with a hyperlink found within an email or SMS message.
- Code() - Constructor for class com.mailosaur.models.Code
- codes() - Method in class com.mailosaur.models.MessageContent
-
Gets any verification codes found within this content.
- com.mailosaur - package com.mailosaur
-
This package contains the classes for MailosaurClient.
- com.mailosaur.models - package com.mailosaur.models
-
This package contains the models classes for MailosaurClient.
- content() - Method in class com.mailosaur.models.Attachment
-
Gets the base64-encoded content of the attachment.
- contentId() - Method in class com.mailosaur.models.Attachment
-
Gets the content identifier (for attachments that are embedded within the body of the message).
- contentType() - Method in class com.mailosaur.models.Attachment
-
Gets the MIME type of the attachment.
- create(DeviceCreateOptions) - Method in class com.mailosaur.Devices
-
Creates a new virtual security device.
- create(ServerCreateOptions) - Method in class com.mailosaur.Servers
-
Creates a new virtual server.
- create(String, MessageCreateOptions) - Method in class com.mailosaur.Messages
-
Create a message.
- current() - Method in class com.mailosaur.models.UsageAccountLimit
-
Gets your account usage so far.
D
- delete(String) - Method in class com.mailosaur.Devices
-
Permanently delete a device.
- delete(String) - Method in class com.mailosaur.Messages
-
Delete an message.
- delete(String) - Method in class com.mailosaur.Servers
-
Permanently delete a server.
- deleteAll(String) - Method in class com.mailosaur.Messages
-
Delete all messages.
- description() - Method in class com.mailosaur.models.SpamAssassinRule
-
Gets the Spam Assassin rule description.
- Device - Class in com.mailosaur.models
-
Mailosaur virtual security device.
- Device() - Constructor for class com.mailosaur.models.Device
- DeviceCreateOptions - Class in com.mailosaur.models
-
Options used to create a new Mailosaur device.
- DeviceCreateOptions() - Constructor for class com.mailosaur.models.DeviceCreateOptions
- DeviceListResult - Class in com.mailosaur.models
-
The result of the device listing operation.
- DeviceListResult() - Constructor for class com.mailosaur.models.DeviceListResult
- devices() - Method in class com.mailosaur.MailosaurClient
-
Gets device management operations.
- Devices - Class in com.mailosaur
- Devices(MailosaurClient) - Constructor for class com.mailosaur.Devices
- dir() - Method in class com.mailosaur.models.MessageListParams
-
Optionally limits results based on the direction (`Sent` or `Received`), with the default being `Received`.
- dir() - Method in class com.mailosaur.models.MessageSearchParams
-
Optionally limits results based on the direction (`Sent` or `Received`), with the default being `Received`.
- disableImages() - Method in class com.mailosaur.models.Preview
-
True if images were disabled in the preview.
E
- email() - Method in class com.mailosaur.models.MessageAddress
-
Gets the email address (applicable to email messages).
- email() - Method in class com.mailosaur.models.UsageAccountLimits
-
Gets emails per day limits.
- email() - Method in class com.mailosaur.models.UsageTransaction
-
Gets the number of emails.
- emailClient() - Method in class com.mailosaur.models.Preview
-
Gets the email client the preview was generated with.
- errorOnTimeout() - Method in class com.mailosaur.models.MessageSearchParams
-
Gets whether or not an error will not be throw if timeout is reached (default: true).
- errorType() - Method in exception com.mailosaur.MailosaurException
- expires() - Method in class com.mailosaur.models.OtpResult
-
Gets the expiry date/time of the current one-time password.
F
- field() - Method in class com.mailosaur.models.MessageHeader
-
Gets the header key.
- fileName() - Method in class com.mailosaur.models.Attachment
-
Gets the filename of the attachment.
- files() - Method in class com.mailosaur.MailosaurClient
-
Gets file operations.
- Files - Class in com.mailosaur
-
File operations.
- Files(MailosaurClient) - Constructor for class com.mailosaur.Files
- forward(String, MessageForwardOptions) - Method in class com.mailosaur.Messages
-
Forward an email.
- from() - Method in class com.mailosaur.models.Message
-
Gets the sender of the message.
- from() - Method in class com.mailosaur.models.MessageSummary
-
Gets the sender of the message.
G
- generateEmailAddress(String) - Method in class com.mailosaur.Servers
-
Generates a random email address by appending a random string in front of the server's domain name.
- generatePreviews(String, PreviewRequestOptions) - Method in class com.mailosaur.Messages
-
Generates screenshots of an email rendered in the specified email clients.
- get(MessageSearchParams, SearchCriteria) - Method in class com.mailosaur.Messages
-
Retrieve a message using search criteria.
- get(String) - Method in class com.mailosaur.Servers
-
Retrieves the detail for a single server.
- get(String, SearchCriteria) - Method in class com.mailosaur.Messages
-
Deprecated.
- get(String, SearchCriteria, int) - Method in class com.mailosaur.Messages
-
Deprecated.Use
Messages.get(MessageSearchParams, SearchCriteria)instead. - get(String, SearchCriteria, long) - Method in class com.mailosaur.Messages
-
Deprecated.Use
Messages.get(MessageSearchParams, SearchCriteria)instead. - get(String, SearchCriteria, Integer, long) - Method in class com.mailosaur.Messages
-
Deprecated.Use
Messages.get(MessageSearchParams, SearchCriteria)instead. - getAttachment(String) - Method in class com.mailosaur.Files
-
Downloads a single attachment.
- getById(String) - Method in class com.mailosaur.Messages
-
Retrieve an message.
- getEmail(String) - Method in class com.mailosaur.Files
-
Downloads an EML file representing the specified email.
- getPassword(String) - Method in class com.mailosaur.Servers
-
Retrieves the password for a server.
- getPreview(String) - Method in class com.mailosaur.Files
-
Downloads a screenshot of your email rendered in a real email client.
H
- headers() - Method in class com.mailosaur.models.Metadata
-
Gets the message headers.
- helo() - Method in class com.mailosaur.models.Metadata
-
Gets the fully-qualified domain name or IP address that was provided with the Extended HELLO (EHLO) or HELLO (HELO) command.
- href() - Method in class com.mailosaur.models.Link
-
Gets the URL for the link.
- html() - Method in class com.mailosaur.models.Message
-
Gets the message content that was sent in HTML format.
- httpResponseBody() - Method in exception com.mailosaur.MailosaurException
- httpStatusCode() - Method in exception com.mailosaur.MailosaurException
I
- id() - Method in class com.mailosaur.models.Attachment
-
Gets the unique identifier for the attachment.
- id() - Method in class com.mailosaur.models.Device
-
Gets the unique identifier for the device.
- id() - Method in class com.mailosaur.models.Message
-
Gets the unique identifier for the message.
- id() - Method in class com.mailosaur.models.MessageSummary
-
Get the unique identifier for the message.
- id() - Method in class com.mailosaur.models.Preview
-
Gets the unique identifier for the email preview.
- id() - Method in class com.mailosaur.models.PreviewEmailClient
-
Gets the unique identifier of the email client.
- id() - Method in class com.mailosaur.models.Server
-
Gets the unique identifier of the server.
- Image - Class in com.mailosaur.models
-
Data associated with an image found within a message.
- Image() - Constructor for class com.mailosaur.models.Image
- images() - Method in class com.mailosaur.models.MessageContent
-
Gets any images found within this content.
- items() - Method in class com.mailosaur.models.DeviceListResult
-
Gets the individual devices forming the result.
- items() - Method in class com.mailosaur.models.MessageListResult
-
Gets the individual summaries of each message forming the result.
- items() - Method in class com.mailosaur.models.PreviewEmailClientListResult
-
Gets a list of available email clients.
- items() - Method in class com.mailosaur.models.PreviewListResult
-
Gets a list of requested email previews.
- items() - Method in class com.mailosaur.models.ServerListResult
-
Gets the individual servers forming the result.
- items() - Method in class com.mailosaur.models.UsageTransactionListResult
-
Gets the individual transactions that have occurred.
- itemsPerPage() - Method in class com.mailosaur.models.MessageListParams
-
Gets the limit on the number of results to be returned per page.
- itemsPerPage() - Method in class com.mailosaur.models.MessageSearchParams
-
Gets the limit on the number of results to be returned per page.
L
- length() - Method in class com.mailosaur.models.Attachment
-
Gets the file size, in bytes.
- limit() - Method in class com.mailosaur.models.UsageAccountLimit
-
Gets the limit for your account.
- limits() - Method in class com.mailosaur.Usage
-
Retrieve account usage limits.
- Link - Class in com.mailosaur.models
-
Data associated with a hyperlink found within an email or SMS message.
- Link() - Constructor for class com.mailosaur.models.Link
- links() - Method in class com.mailosaur.models.MessageContent
-
Gets any hyperlinks found within this content.
- list() - Method in class com.mailosaur.Devices
-
Returns a list of your virtual security devices.
- list() - Method in class com.mailosaur.Servers
-
Returns a list of your virtual servers.
- list(MessageListParams) - Method in class com.mailosaur.Messages
-
List all messages.
- list(String) - Method in class com.mailosaur.Messages
-
Deprecated.Use
Messages.list(MessageListParams)instead. - list(String, int, int) - Method in class com.mailosaur.Messages
-
Deprecated.Use
Messages.list(MessageListParams)instead. - list(String, long) - Method in class com.mailosaur.Messages
-
Deprecated.Use
Messages.list(MessageListParams)instead. - list(String, Integer, Integer, long) - Method in class com.mailosaur.Messages
-
Deprecated.Use
Messages.list(MessageListParams)instead. - listEmailClients() - Method in class com.mailosaur.Previews
-
Returns the list of all email clients that can be used to generate email previews.
M
- mailFrom() - Method in class com.mailosaur.models.Metadata
-
Gets the source mailbox/email address, referred to as the 'reverse-path', provided via the MAIL command during the SMTP transaction.
- MailosaurClient - Class in com.mailosaur
- MailosaurClient(String) - Constructor for class com.mailosaur.MailosaurClient
-
Initializes an instance of the Mailosaur client.
- MailosaurClient(String, String) - Constructor for class com.mailosaur.MailosaurClient
-
Initializes an instance of the Mailosaur client.
- MailosaurException - Exception in com.mailosaur
- MailosaurException(String, String) - Constructor for exception com.mailosaur.MailosaurException
- MailosaurException(String, String, Integer, String) - Constructor for exception com.mailosaur.MailosaurException
- MailosaurException(Throwable) - Constructor for exception com.mailosaur.MailosaurException
- Message - Class in com.mailosaur.models
-
The email or SMS message processed by Mailosaur.
- Message() - Constructor for class com.mailosaur.models.Message
- Message(String, List<MessageAddress>, List<MessageAddress>, String, String, DateTime) - Constructor for class com.mailosaur.models.Message
-
This constructor used for Mailosaur library tests only
- MessageAddress - Class in com.mailosaur.models
-
Contact information for a message sender or recipient.
- MessageAddress() - Constructor for class com.mailosaur.models.MessageAddress
- MessageContent - Class in com.mailosaur.models
-
The content of the message.
- MessageContent() - Constructor for class com.mailosaur.models.MessageContent
- MessageCreateOptions - Class in com.mailosaur.models
-
Options to use when creating a new message.
- MessageCreateOptions() - Constructor for class com.mailosaur.models.MessageCreateOptions
- MessageForwardOptions - Class in com.mailosaur.models
-
Options to use when forwarding a message.
- MessageForwardOptions() - Constructor for class com.mailosaur.models.MessageForwardOptions
- MessageHeader - Class in com.mailosaur.models
-
Message header key/value pair.
- MessageHeader() - Constructor for class com.mailosaur.models.MessageHeader
- MessageListParams - Class in com.mailosaur.models
-
Parameters for message listing.
- MessageListParams() - Constructor for class com.mailosaur.models.MessageListParams
- MessageListResult - Class in com.mailosaur.models
-
The result of a message listing request.
- MessageListResult() - Constructor for class com.mailosaur.models.MessageListResult
- MessageReplyOptions - Class in com.mailosaur.models
-
Options to use when replying to a message.
- MessageReplyOptions() - Constructor for class com.mailosaur.models.MessageReplyOptions
- messages() - Method in class com.mailosaur.MailosaurClient
-
Gets message operations.
- messages() - Method in class com.mailosaur.models.Server
-
Gets the number of messages currently in the server.
- Messages - Class in com.mailosaur
-
An instance of this class provides access to all the operations defined in Messages.
- Messages(MailosaurClient) - Constructor for class com.mailosaur.Messages
-
Initializes an instance of Messages.
- MessageSearchParams - Class in com.mailosaur.models
-
Parameters for message searching.
- MessageSearchParams() - Constructor for class com.mailosaur.models.MessageSearchParams
- MessageSummary - Class in com.mailosaur.models
-
The MessageSummary model.
- MessageSummary() - Constructor for class com.mailosaur.models.MessageSummary
- metadata() - Method in class com.mailosaur.models.Message
-
Gets further metadata related to the message, including email headers.
- Metadata - Class in com.mailosaur.models
-
Further metadata related to the message, including email headers.
- Metadata() - Constructor for class com.mailosaur.models.Metadata
N
- name() - Method in class com.mailosaur.models.Device
-
Gets the name of the device.
- name() - Method in class com.mailosaur.models.MessageAddress
-
Gets the display name, if one is specified.
- name() - Method in class com.mailosaur.models.PreviewEmailClient
-
Gets the display name of the email client.
- name() - Method in class com.mailosaur.models.Server
-
Gets the name of the server.
- nullableString(String) - Method in class com.mailosaur.models.BaseModel
O
- otp(String) - Method in class com.mailosaur.Devices
-
Retrieve the current one-time password.
- OtpResult - Class in com.mailosaur.models
-
Mailosaur virtual security device.
- OtpResult() - Constructor for class com.mailosaur.models.OtpResult
P
- page() - Method in class com.mailosaur.models.MessageListParams
-
Gets the page index, used in conjunction with `itemsPerPage` to support pagination.
- page() - Method in class com.mailosaur.models.MessageSearchParams
-
Gets the page index, used in conjunction with `itemsPerPage` to support pagination.
- phone() - Method in class com.mailosaur.models.MessageAddress
-
Gets the phone number (applicable to SMS messages).
- platformGroup() - Method in class com.mailosaur.models.PreviewEmailClient
-
Gets whether the platform is desktop, mobile, or web-based.
- platformType() - Method in class com.mailosaur.models.PreviewEmailClient
-
Gets the type of platform on which the email client is running.
- platformVersion() - Method in class com.mailosaur.models.PreviewEmailClient
-
Gets the platform version number.
- Preview - Class in com.mailosaur.models
-
Describes an email preview.
- Preview() - Constructor for class com.mailosaur.models.Preview
- PreviewEmailClient - Class in com.mailosaur.models
-
Describes an email client with which email previews can be generated.
- PreviewEmailClient() - Constructor for class com.mailosaur.models.PreviewEmailClient
- PreviewEmailClientListResult - Class in com.mailosaur.models
-
A list of available email clients with which to generate email previews.
- PreviewEmailClientListResult() - Constructor for class com.mailosaur.models.PreviewEmailClientListResult
- PreviewListResult - Class in com.mailosaur.models
-
The result of a preview listing operation.
- PreviewListResult() - Constructor for class com.mailosaur.models.PreviewListResult
- PreviewRequest - Class in com.mailosaur.models
-
Describes an email preview request.
- PreviewRequest(String) - Constructor for class com.mailosaur.models.PreviewRequest
- PreviewRequest(String, Boolean) - Constructor for class com.mailosaur.models.PreviewRequest
- PreviewRequestOptions - Class in com.mailosaur.models
-
Preview request options.
- PreviewRequestOptions() - Constructor for class com.mailosaur.models.PreviewRequestOptions
- previews() - Method in class com.mailosaur.MailosaurClient
-
Gets Email Previews operations.
- Previews - Class in com.mailosaur
- Previews(MailosaurClient) - Constructor for class com.mailosaur.Previews
R
- rcptTo() - Method in class com.mailosaur.models.Metadata
-
Gets the recipient email addresses, each referred to as a 'forward-path', provided via the RCPT command during the SMTP transaction.
- received() - Method in class com.mailosaur.models.Message
-
Gets the date/time that this message was received by Mailosaur.
- received() - Method in class com.mailosaur.models.MessageSummary
-
Gets the date/time that this message was received by Mailosaur.
- receivedAfter() - Method in class com.mailosaur.models.MessageListParams
-
Gets the receivedAfter timestamp.
- receivedAfter() - Method in class com.mailosaur.models.MessageSearchParams
-
Gets the receivedAfter timestamp.
- reply(String, MessageReplyOptions) - Method in class com.mailosaur.Messages
-
Reply to an email.
- request(String, String) - Method in class com.mailosaur.MailosaurClient
- request(String, String, Object) - Method in class com.mailosaur.MailosaurClient
- request(String, String, Object, HashMap<String, String>) - Method in class com.mailosaur.MailosaurClient
- request(String, String, HashMap<String, String>) - Method in class com.mailosaur.MailosaurClient
- requestFile(String, String) - Method in class com.mailosaur.MailosaurClient
- rule() - Method in class com.mailosaur.models.SpamAssassinRule
-
Gets the Spam Assassin rule name.
S
- score() - Method in class com.mailosaur.models.SpamAnalysisResult
-
Gets the overall Mailosaur spam score.
- score() - Method in class com.mailosaur.models.SpamAssassinRule
-
Gets the Spam Assassin rule score.
- search(MessageSearchParams, SearchCriteria) - Method in class com.mailosaur.Messages
-
Search for messages.
- search(String, SearchCriteria) - Method in class com.mailosaur.Messages
-
Deprecated.Use
Messages.search(MessageSearchParams, SearchCriteria)instead. - search(String, SearchCriteria, int) - Method in class com.mailosaur.Messages
-
Deprecated.Use
Messages.search(MessageSearchParams, SearchCriteria)instead. - search(String, SearchCriteria, int, boolean) - Method in class com.mailosaur.Messages
-
Deprecated.Use
Messages.search(MessageSearchParams, SearchCriteria)instead. - search(String, SearchCriteria, int, boolean, long) - Method in class com.mailosaur.Messages
-
Deprecated.Use
Messages.search(MessageSearchParams, SearchCriteria)instead. - search(String, SearchCriteria, int, int) - Method in class com.mailosaur.Messages
-
Deprecated.Use
Messages.search(MessageSearchParams, SearchCriteria)instead. - search(String, SearchCriteria, int, long) - Method in class com.mailosaur.Messages
-
Deprecated.Use
Messages.search(MessageSearchParams, SearchCriteria)instead. - search(String, SearchCriteria, long) - Method in class com.mailosaur.Messages
-
Deprecated.Use
Messages.search(MessageSearchParams, SearchCriteria)instead. - search(String, SearchCriteria, Integer, Integer, Integer, long, boolean) - Method in class com.mailosaur.Messages
-
Deprecated.Use
Messages.search(MessageSearchParams, SearchCriteria)instead. - SearchCriteria - Class in com.mailosaur.models
-
The criteria with which to find messages during a search.
- SearchCriteria() - Constructor for class com.mailosaur.models.SearchCriteria
- SearchMatchOperator - Enum Class in com.mailosaur.models
- server() - Method in class com.mailosaur.models.Message
-
Gets the identifier for the server in which the message is located.
- server() - Method in class com.mailosaur.models.MessageListParams
-
Gets the identifier of the server hosting the messages.
- server() - Method in class com.mailosaur.models.MessageSearchParams
-
Gets the identifier of the server hosting the messages.
- server() - Method in class com.mailosaur.models.MessageSummary
-
Gets the identifier for the server in which the message is located.
- Server - Class in com.mailosaur.models
-
Mailosaur virtual SMTP/SMS server.
- Server() - Constructor for class com.mailosaur.models.Server
- ServerCreateOptions - Class in com.mailosaur.models
-
Options used to create a new Mailosaur server.
- ServerCreateOptions() - Constructor for class com.mailosaur.models.ServerCreateOptions
- ServerListResult - Class in com.mailosaur.models
-
The result of the server listing operation.
- ServerListResult() - Constructor for class com.mailosaur.models.ServerListResult
- servers() - Method in class com.mailosaur.MailosaurClient
-
Gets server management operations.
- servers() - Method in class com.mailosaur.models.UsageAccountLimits
-
Gets server limits.
- Servers - Class in com.mailosaur
- Servers(MailosaurClient) - Constructor for class com.mailosaur.Servers
- sms() - Method in class com.mailosaur.models.UsageAccountLimits
-
Gets SMS message per month limits.
- sms() - Method in class com.mailosaur.models.UsageTransaction
-
Gets the number of SMS messages.
- spam(String) - Method in class com.mailosaur.Analysis
-
Perform a spam analysis of an email.
- SpamAnalysisResult - Class in com.mailosaur.models
-
The results of spam analysis performed by Mailosaur.
- SpamAnalysisResult() - Constructor for class com.mailosaur.models.SpamAnalysisResult
- spamAssassin() - Method in class com.mailosaur.models.SpamFilterResults
-
Gets the Spam Assassin filter results.
- SpamAssassinRule - Class in com.mailosaur.models
-
The result of an individual Spam Assassin rule
- SpamAssassinRule() - Constructor for class com.mailosaur.models.SpamAssassinRule
- spamFilterResults() - Method in class com.mailosaur.models.SpamAnalysisResult
-
Gets the Spam filter results.
- SpamFilterResults - Class in com.mailosaur.models
-
Results for this email against various spam filters.
- SpamFilterResults() - Constructor for class com.mailosaur.models.SpamFilterResults
- src() - Method in class com.mailosaur.models.Image
-
Gets the value of the `src` attribute of the image.
- status() - Method in class com.mailosaur.models.PreviewEmailClient
-
Gets the current status of the email client.
- subject() - Method in class com.mailosaur.models.Message
-
Gets the subject of the message.
- subject() - Method in class com.mailosaur.models.MessageSummary
-
Gets the subject of the message.
- summary() - Method in class com.mailosaur.models.MessageSummary
-
Gets a short, summarized version of the message content.
T
- text() - Method in class com.mailosaur.models.Link
-
The display text of the link.
- text() - Method in class com.mailosaur.models.Message
-
Gets the message content that was sent in plain text format.
- timeout() - Method in class com.mailosaur.models.MessageSearchParams
-
Gets how long to wait for a matching result (in milliseconds).
- timestamp() - Method in class com.mailosaur.models.UsageTransaction
-
Gets the date/time of the transaction.
- to() - Method in class com.mailosaur.models.Message
-
Gets the recipients of the message.
- to() - Method in class com.mailosaur.models.MessageSummary
-
Gets the recipients of the message.
- transactions() - Method in class com.mailosaur.Usage
-
Retrieves the last 31 days of transactional usage.
- type() - Method in class com.mailosaur.models.Message
-
Gets the type of message.
- type() - Method in class com.mailosaur.models.MessageSummary
-
Gets the type of message.
U
- update(String, Server) - Method in class com.mailosaur.Servers
-
Updates the attributes of a server.
- usage() - Method in class com.mailosaur.MailosaurClient
-
Gets account usage operations.
- Usage - Class in com.mailosaur
- Usage(MailosaurClient) - Constructor for class com.mailosaur.Usage
- UsageAccountLimit - Class in com.mailosaur.models
-
The detail of an individual account limit.
- UsageAccountLimit() - Constructor for class com.mailosaur.models.UsageAccountLimit
- UsageAccountLimits - Class in com.mailosaur.models
-
The current limits and usage for your account.
- UsageAccountLimits() - Constructor for class com.mailosaur.models.UsageAccountLimits
- UsageTransaction - Class in com.mailosaur.models
-
Usage transaction.
- UsageTransaction() - Constructor for class com.mailosaur.models.UsageTransaction
- UsageTransactionListResult - Class in com.mailosaur.models
-
Usage transactions from your account.
- UsageTransactionListResult() - Constructor for class com.mailosaur.models.UsageTransactionListResult
- users() - Method in class com.mailosaur.models.Server
-
Gets the IDs of users who have access to the server (if it is restricted).
- users() - Method in class com.mailosaur.models.UsageAccountLimits
-
Gets user limits.
V
- value() - Method in class com.mailosaur.models.Code
-
Gets the extracted code found within the message content.
- value() - Method in class com.mailosaur.models.MessageHeader
-
Gets the header value.
- valueOf(String) - Static method in enum class com.mailosaur.models.SearchMatchOperator
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.mailosaur.models.SearchMatchOperator
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- withAttachments(List<Attachment>) - Method in class com.mailosaur.models.MessageCreateOptions
-
Sets any message attachments.
- withAttachments(List<Attachment>) - Method in class com.mailosaur.models.MessageReplyOptions
-
Sets any message attachments.
- withBody(String) - Method in class com.mailosaur.models.SearchCriteria
-
Sets the value to seek within the body of the target message.
- withContent(String) - Method in class com.mailosaur.models.Attachment
-
Sets the base64-encoded content of the attachment.
- withContentId(String) - Method in class com.mailosaur.models.Attachment
-
Sets the content identifier (for attachments that are embedded within the body of the message).
- withContentType(String) - Method in class com.mailosaur.models.Attachment
-
Sets the MIME type of the attachment.
- withDir(String) - Method in class com.mailosaur.models.MessageListParams
-
Optionally limits results based on the direction (`Sent` or `Received`), with the default being `Received`.
- withDir(String) - Method in class com.mailosaur.models.MessageSearchParams
-
Optionally limits results based on the direction (`Sent` or `Received`), with the default being `Received`.
- withDisableImages(Boolean) - Method in class com.mailosaur.models.PreviewRequest
-
Sets whether images should be disabled in the preview (only if supported by the client).
- withEmailClient(String) - Method in class com.mailosaur.models.PreviewRequest
-
Sets the email client you wish to generate a preview for.
- withErrorOnTimeout(boolean) - Method in class com.mailosaur.models.MessageSearchParams
-
Set whether or not an error will not be throw if timeout is reached (default: true).
- withFileName(String) - Method in class com.mailosaur.models.Attachment
-
Sets the filename of the attachment.
- withFrom(String) - Method in class com.mailosaur.models.MessageCreateOptions
-
Partially overrides of the message's 'from' address.
- withHtml(String) - Method in class com.mailosaur.models.MessageCreateOptions
-
Sets any HTML content to include when forwarding the message.
- withHtml(String) - Method in class com.mailosaur.models.MessageForwardOptions
-
Sets any HTML content to include when forwarding the message.
- withHtml(String) - Method in class com.mailosaur.models.MessageReplyOptions
-
Sets any additional HTML content to include in the reply.
- withItemsPerPage(int) - Method in class com.mailosaur.models.MessageListParams
-
Set the limit on the number of results to be returned per page.
- withItemsPerPage(int) - Method in class com.mailosaur.models.MessageSearchParams
-
Set the limit on the number of results to be returned per page.
- withMatch(SearchMatchOperator) - Method in class com.mailosaur.models.SearchCriteria
-
If set to `ALL` (default), then only results that match all specified criteria will be returned.
- withName(String) - Method in class com.mailosaur.models.DeviceCreateOptions
-
Sets a name used to identify the device.
- withName(String) - Method in class com.mailosaur.models.Server
-
Sets the name of the server.
- withName(String) - Method in class com.mailosaur.models.ServerCreateOptions
-
Sets a name used to identify the server.
- withPage(int) - Method in class com.mailosaur.models.MessageListParams
-
Sets the page index, used in conjunction with `itemsPerPage` to support pagination.
- withPage(int) - Method in class com.mailosaur.models.MessageSearchParams
-
Sets the page index, used in conjunction with `itemsPerPage` to support pagination.
- withPreviews(List<PreviewRequest>) - Method in class com.mailosaur.models.PreviewRequestOptions
-
Sets the list of email preview requests.
- withReceivedAfter(long) - Method in class com.mailosaur.models.MessageListParams
-
Limits results to only messages received after this timestamp.
- withReceivedAfter(long) - Method in class com.mailosaur.models.MessageSearchParams
-
Limits results to only messages received after this timestamp.
- withSend(Boolean) - Method in class com.mailosaur.models.MessageCreateOptions
-
Sets whether the email should be sent upon creation.
- withSentFrom(String) - Method in class com.mailosaur.models.SearchCriteria
-
Sets the full email address (or phone number for SMS) from which the target message was sent.
- withSentTo(String) - Method in class com.mailosaur.models.SearchCriteria
-
Sets the full email address (or phone number for SMS) to which the target message was sent.
- withServer(String) - Method in class com.mailosaur.models.MessageListParams
-
Sets the identifier of the server hosting the messages.
- withServer(String) - Method in class com.mailosaur.models.MessageSearchParams
-
Sets the identifier of the server hosting the messages.
- withSharedSecret(String) - Method in class com.mailosaur.models.DeviceCreateOptions
-
Sets the base32-encoded shared secret for this device.
- withSubject(String) - Method in class com.mailosaur.models.MessageCreateOptions
-
Sets the email subject line.
- withSubject(String) - Method in class com.mailosaur.models.SearchCriteria
-
Sets the value to seek within the subject line of a target email.
- withText(String) - Method in class com.mailosaur.models.MessageCreateOptions
-
Sets any plain text to include when forwarding the message.
- withText(String) - Method in class com.mailosaur.models.MessageForwardOptions
-
Sets any plain text to include when forwarding the message.
- withText(String) - Method in class com.mailosaur.models.MessageReplyOptions
-
Sets any additional plain text content to include in the reply.
- withTimeout(int) - Method in class com.mailosaur.models.MessageSearchParams
-
Sets how long to wait for a matching result (in milliseconds).
- withTo(String) - Method in class com.mailosaur.models.MessageCreateOptions
-
Sets the email address to which the email will be sent.
- withTo(String) - Method in class com.mailosaur.models.MessageForwardOptions
-
Sets the email address to which the email will be sent.
- withUsers(List<String>) - Method in class com.mailosaur.models.Server
-
Sets the IDs of users who have access to the server (if it is restricted).
All Classes and Interfaces|All Packages|Serialized Form
Messages.get(MessageSearchParams, SearchCriteria)instead.