Module mailslurp::apis::email_controller_api

Structs

DeleteEmailParams	struct for passing parameters to the method delete_email
DownloadAttachmentBase64Params	struct for passing parameters to the method download_attachment_base64
DownloadAttachmentParams	struct for passing parameters to the method download_attachment
ForwardEmailParams	struct for passing parameters to the method forward_email
GetAttachmentMetaDataParams	struct for passing parameters to the method get_attachment_meta_data
GetAttachmentsParams	struct for passing parameters to the method get_attachments
GetEmailContentMatchParams	struct for passing parameters to the method get_email_content_match
GetEmailHtmlParams	struct for passing parameters to the method get_email_html
GetEmailHtmlQueryParams	struct for passing parameters to the method get_email_html_query
GetEmailParams	struct for passing parameters to the method get_email
GetEmailTextLinesParams	struct for passing parameters to the method get_email_text_lines
GetEmailsPaginatedParams	struct for passing parameters to the method get_emails_paginated
GetLatestEmailInInboxParams	struct for passing parameters to the method get_latest_email_in_inbox
GetLatestEmailParams	struct for passing parameters to the method get_latest_email
GetOrganizationEmailsPaginatedParams	struct for passing parameters to the method get_organization_emails_paginated
GetRawEmailContentsParams	struct for passing parameters to the method get_raw_email_contents
GetRawEmailJsonParams	struct for passing parameters to the method get_raw_email_json
ReplyToEmailParams	struct for passing parameters to the method reply_to_email
ValidateEmailParams	struct for passing parameters to the method validate_email

Enums

DeleteAllEmailsError	struct for typed errors of method delete_all_emails
DeleteEmailError	struct for typed errors of method delete_email
DownloadAttachmentBase64Error	struct for typed errors of method download_attachment_base64
DownloadAttachmentError	struct for typed errors of method download_attachment
ForwardEmailError	struct for typed errors of method forward_email
GetAttachmentMetaDataError	struct for typed errors of method get_attachment_meta_data
GetAttachmentsError	struct for typed errors of method get_attachments
GetEmailContentMatchError	struct for typed errors of method get_email_content_match
GetEmailError	struct for typed errors of method get_email
GetEmailHtmlError	struct for typed errors of method get_email_html
GetEmailHtmlQueryError	struct for typed errors of method get_email_html_query
GetEmailTextLinesError	struct for typed errors of method get_email_text_lines
GetEmailsPaginatedError	struct for typed errors of method get_emails_paginated
GetLatestEmailError	struct for typed errors of method get_latest_email
GetLatestEmailInInboxError	struct for typed errors of method get_latest_email_in_inbox
GetOrganizationEmailsPaginatedError	struct for typed errors of method get_organization_emails_paginated
GetRawEmailContentsError	struct for typed errors of method get_raw_email_contents
GetRawEmailJsonError	struct for typed errors of method get_raw_email_json
GetUnreadEmailCountError	struct for typed errors of method get_unread_email_count
ReplyToEmailError	struct for typed errors of method reply_to_email
ValidateEmailError	struct for typed errors of method validate_email

Functions

delete_all_emails	Deletes all emails in your account. Be careful as emails cannot be recovered
delete_email	Deletes an email and removes it from the inbox. Deleted emails cannot be recovered.
download_attachment	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.
download_attachment_base64	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 downloadAttachment method but allows some clients to get around issues with binary responses.
forward_email	Forward an existing email to new recipients.
get_attachment_meta_data	Returns the metadata such as name and content-type for a given attachment and email.
get_attachments	Returns an array of attachment metadata such as name and content-type for a given email if present.
get_email	Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints
get_email_content_match	Return the matches for a given 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.
get_email_html	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: ?apiKey=xxx
get_email_html_query	Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors
get_email_text_lines	Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators.
get_emails_paginated	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
get_latest_email	Get the newest email in all inboxes or in a passed set of inbox IDs
get_latest_email_in_inbox	Get the newest email in all inboxes or in a passed set of inbox IDs
get_organization_emails_paginated	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
get_raw_email_contents	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
get_raw_email_json	Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response
get_unread_email_count	Get number of emails unread
reply_to_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 to, cc, and bcc.
validate_email	Validate the HTML content of email if HTML is found. Considered valid if no HTML.