Module mailslurp::apis::email_controller_api [−][src]
Structs
DeleteEmailParams | struct for passing parameters to the method |
DownloadAttachmentBase64Params | struct for passing parameters to the method |
DownloadAttachmentParams | struct for passing parameters to the method |
DownloadBodyBytesParams | struct for passing parameters to the method |
DownloadBodyParams | struct for passing parameters to the method |
ForwardEmailParams | struct for passing parameters to the method |
GetAttachmentMetaDataParams | struct for passing parameters to the method |
GetAttachments1Params | struct for passing parameters to the method |
GetEmailContentMatchParams | struct for passing parameters to the method |
GetEmailHtmlParams | struct for passing parameters to the method |
GetEmailHtmlQueryParams | struct for passing parameters to the method |
GetEmailParams | struct for passing parameters to the method |
GetEmailTextLinesParams | struct for passing parameters to the method |
GetEmailsPaginatedParams | struct for passing parameters to the method |
GetLatestEmailInInboxParams | struct for passing parameters to the method |
GetLatestEmailParams | struct for passing parameters to the method |
GetOrganizationEmailsPaginatedParams | struct for passing parameters to the method |
GetRawEmailContentsParams | struct for passing parameters to the method |
GetRawEmailJsonParams | struct for passing parameters to the method |
ReplyToEmailParams | struct for passing parameters to the method |
ValidateEmailParams | struct for passing parameters to the method |
Enums
DeleteAllEmailsError | struct for typed errors of method |
DeleteEmailError | struct for typed errors of method |
DownloadAttachmentBase64Error | struct for typed errors of method |
DownloadAttachmentError | struct for typed errors of method |
DownloadBodyBytesError | struct for typed errors of method |
DownloadBodyError | struct for typed errors of method |
ForwardEmailError | struct for typed errors of method |
GetAttachmentMetaDataError | struct for typed errors of method |
GetAttachments1Error | struct for typed errors of method |
GetEmailContentMatchError | struct for typed errors of method |
GetEmailError | struct for typed errors of method |
GetEmailHtmlError | struct for typed errors of method |
GetEmailHtmlQueryError | struct for typed errors of method |
GetEmailTextLinesError | struct for typed errors of method |
GetEmailsPaginatedError | struct for typed errors of method |
GetLatestEmailError | struct for typed errors of method |
GetLatestEmailInInboxError | struct for typed errors of method |
GetOrganizationEmailsPaginatedError | struct for typed errors of method |
GetRawEmailContentsError | struct for typed errors of method |
GetRawEmailJsonError | struct for typed errors of method |
GetUnreadEmailCountError | struct for typed errors of method |
ReplyToEmailError | struct for typed errors of method |
ValidateEmailError | struct for typed errors of method |
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 |
download_body | Returns the specified email body for a given email as a string |
download_body_bytes | Returns the specified email body for a given email as a stream / array of bytes. |
forward_email | 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 |
get_attachment_meta_data | Returns the metadata such as name and content-type for a given attachment and email. |
get_attachments1 | 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 |
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: |
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. Unread means has not been viewed in dashboard or returned in an email API response |
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 |
validate_email | Validate the HTML content of email if HTML is found. Considered valid if no HTML is present. |