Attachments

Our common recommendation with attachments is to use them in moderation with a preference to documents in libraries and linking business objects items to that document using metadata and other logical relationship. But sometimes you need nothing more than just a simple binary addition to an item.
Working with attachments is mostly straightforward as you can only get a list of item's attachment, get a specific attachment by its name, add and delete an attachment.
Getting attachments
1
list := sp.Web().GetList("Lists/MyList")
2
item := list.Items().GetByID(1)
3
​
4
attachments, err := item.Attachments().Get()
5
if err != nil {
6
	log.Fatal(err)
7
}
8
​
9
for _, attachment := range attachments.Data() {
10
	data := attachment.Data()
11
	fmt.Printf("%s (%s)\n", data.FileName, data.ServerRelativeURL)
12
}
Copied!
Attachments API provides little information, actually only FileName and ServerRelativeURL.
Items have attachments
To detect which items have attachments the corresponding Attachments property can be requested within an ordinary get items request:
1
items, err := list.Items().Select("Id,Attachments").Get()
2
if err != nil {
3
	log.Fatal(err)
4
}
5
​
6
for _, item := range items.Data() {
7
	data := item.Data()
8
	hasAttachments := "has no"
9
	if data.Attachments {
10
		hasAttachments = "has"
11
	}
12
	fmt.Printf("Item ID %d %s attachments\n", data.ID, hasAttachments)
13
}
Copied!
Adding attachments
Adding attachments is almost identical to adding documents to a document library.
1
list := sp.Web().GetList("Lists/MyList")
2
item := list.Items().GetByID(1)
3
​
4
content := strings.NewReader("Get content in a usual Go way you like")
5
​
6
item.Attachments().GetByName("MyAttachment.txt").Delete()
7
​
8
resp, err := item.Attachments().Add("MyAttachment.txt", content)
9
if err != nil {
10
	log.Fatal(err)
11
}
12
​
13
fmt.Printf("Attachment is added: %s\n", resp.Data().ServerRelativeURL)
Copied!
Getting attachment by name
1
list := sp.Web().GetList("Lists/MyList")
2
item := list.Items().GetByID(1)
3
​
4
content, err := item.Attachments().GetByName("MyAttachment.txt").Download()
5
if err != nil {
6
	log.Fatal(err)
7
}
8
​
9
fmt.Printf(
10
	"Do whatever needed with this content of %d bytes\n",
11
	len(content),
12
)
Copied!
Attachment actions
With an attachment you can:
Download
Get reader (download in a stream way)
Delete
or Recycle
These actions are rather obvious with the help of the Fluent API.

Samples - Previous

Change API

Next - Samples

Record Management

Last modified 2yr ago

Export as PDF

Copy link

Contents

Getting attachments

Items have attachments

Adding attachments

Getting attachment by name

Attachment actions