Skip to content

Commit 5d26dd6

Browse files
committed
Added javadoc
1 parent 2c7d5f0 commit 5d26dd6

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed
Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,35 @@
11
package io.mailtrap.api.abstractions;
22

33
import io.mailtrap.model.response.AttachmentResponse;
4+
import org.jetbrains.annotations.Nullable;
45

56
import java.util.List;
67

8+
/**
9+
* Interface representing the Mailtrap Testing API for interaction with email message attachments.
10+
*/
711
public interface Attachments {
812

13+
/**
14+
* Get message single attachment by ID
15+
*
16+
* @param accountId - unique account ID
17+
* @param inboxId - unique inbox ID
18+
* @param messageId - unique message ID
19+
* @param attachmentId - unique attachment ID
20+
* @return attachment details and download path
21+
*/
922
AttachmentResponse getSingleAttachment(long accountId, int inboxId, long messageId, long attachmentId);
1023

11-
List<AttachmentResponse> getAttachments(long accountId, int inboxId, long messageId, String attachmentType);
24+
/**
25+
* Get message attachments by inboxId and messageId
26+
*
27+
* @param accountId - unique account ID
28+
* @param inboxId - unique inbox ID
29+
* @param messageId - unique message ID
30+
* @param attachmentType - attachment type; optional query param
31+
* @return attachments with their details and download paths
32+
*/
33+
List<AttachmentResponse> getAttachments(long accountId, int inboxId, long messageId, @Nullable String attachmentType);
1234

1335
}

0 commit comments

Comments
 (0)