Class MessageApi


  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
    public class MessageApi
    extends Object
    • Constructor Detail

      • MessageApi

        public MessageApi()
      • MessageApi

        public MessageApi​(ApiClient apiClient)
    • Method Detail

      • attachment

        public void attachment​(String ID,
                               String partID)
                        throws ApiException
        Get message attachment This will return the attachment part using the appropriate Content-Type.
        Parameters:
        ID - Database ID (required)
        partID - Attachment part ID (required)
        Throws:
        ApiException - if fails to make API call
      • attachmentWithHttpInfo

        public ApiResponse<Void> attachmentWithHttpInfo​(String ID,
                                                        String partID)
                                                 throws ApiException
        Get message attachment This will return the attachment part using the appropriate Content-Type.
        Parameters:
        ID - Database ID (required)
        partID - Attachment part ID (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - if fails to make API call
      • headers

        public Map<String,​List<String>> headers​(String ID)
                                               throws ApiException
        Get message headers Returns the message headers as an array.
        Parameters:
        ID - Database ID (required)
        Returns:
        Map<String, List<String>>
        Throws:
        ApiException - if fails to make API call
      • headersWithHttpInfo

        public ApiResponse<Map<String,​List<String>>> headersWithHttpInfo​(String ID)
                                                                        throws ApiException
        Get message headers Returns the message headers as an array.
        Parameters:
        ID - Database ID (required)
        Returns:
        ApiResponse<Map<String, List<String>>>
        Throws:
        ApiException - if fails to make API call
      • message

        public Message message​(String ID)
                        throws ApiException
        Get message summary Returns the summary of a message, marking the message as read.
        Parameters:
        ID - Database ID (required)
        Returns:
        Message
        Throws:
        ApiException - if fails to make API call
      • messageWithHttpInfo

        public ApiResponse<Message> messageWithHttpInfo​(String ID)
                                                 throws ApiException
        Get message summary Returns the summary of a message, marking the message as read.
        Parameters:
        ID - Database ID (required)
        Returns:
        ApiResponse<Message>
        Throws:
        ApiException - if fails to make API call
      • raw

        public void raw​(String ID)
                 throws ApiException
        Get message source Returns the full email source as plain text.
        Parameters:
        ID - Database ID (required)
        Throws:
        ApiException - if fails to make API call
      • rawWithHttpInfo

        public ApiResponse<Void> rawWithHttpInfo​(String ID)
                                          throws ApiException
        Get message source Returns the full email source as plain text.
        Parameters:
        ID - Database ID (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - if fails to make API call
      • release

        public void release​(String ID,
                            ReleaseMessageRequest to)
                     throws ApiException
        Release message Release a message via a pre-configured external SMTP server..
        Parameters:
        ID - Database ID (required)
        to - Array of email addresses to release message to (required)
        Throws:
        ApiException - if fails to make API call
      • releaseWithHttpInfo

        public ApiResponse<Void> releaseWithHttpInfo​(String ID,
                                                     ReleaseMessageRequest to)
                                              throws ApiException
        Release message Release a message via a pre-configured external SMTP server..
        Parameters:
        ID - Database ID (required)
        to - Array of email addresses to release message to (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - if fails to make API call
      • thumbnail

        public void thumbnail​(String ID,
                              String partID)
                       throws ApiException
        Get an attachment image thumbnail This will return a cropped 180x120 JPEG thumbnail of an image attachment. If the image is smaller than 180x120 then the image is padded. If the attachment is not an image then a blank image is returned.
        Parameters:
        ID - Database ID (required)
        partID - Attachment part ID (required)
        Throws:
        ApiException - if fails to make API call
      • thumbnailWithHttpInfo

        public ApiResponse<Void> thumbnailWithHttpInfo​(String ID,
                                                       String partID)
                                                throws ApiException
        Get an attachment image thumbnail This will return a cropped 180x120 JPEG thumbnail of an image attachment. If the image is smaller than 180x120 then the image is padded. If the attachment is not an image then a blank image is returned.
        Parameters:
        ID - Database ID (required)
        partID - Attachment part ID (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - if fails to make API call