dotmailer SDK: dotMailer.Sdk.ImageFactory Class Reference

dotmailer SDK

dotmailer SDK
Tools to access and manage an account in the dotMailer system
dotMailer.Sdk.ImageFactory Class Reference

Provides methods for handling Images. More...

Inheritance diagram for dotMailer.Sdk.ImageFactory:

Public Member Functions

DmImage UploadImage (int parentFolderId, string dotMailerFileName, Byte[] imageData)
 Uploads a new campaign image to the specified folder.
 
DmImage UploadImage (DmImageFolder parentFolder, string dotMailerFileName, Byte[] imageData)
 Uploads a new campaign image to the specified folder.
 
DmImage UploadImage (DmImageFolder parentFolder, string dotMailerFileName, Stream imageDataStream)
 Uploads a new campaign image to the specified folder.
 
DmImage UploadImage (DmImageFolder parentFolder, string dotMailerFileName, string fileName)
 Uploads a new campaign image to the specified folder.
 
DmImage UploadImage (DmImageFolder parentFolder, string fileName)
 Uploads a new campaign image to the specified folder.
 
DmImageFolder CreateImageFolder (string newFolderName, int parentFolderId)
 Creates a new image folder as a child folder of the folder whose ID is passed.
 
DmImageFolder CreateImageFolder (string newFolderName, DmImageFolder parentFolder)
 Creates a new image folder as a child folder of the folder passed.
 
DmImageFolder CreateRootImageFolder (string newFolderName)
 Creates a new image folder in the root of the image folder hierarchy.
 
DmImageFolder GetImageFolderTree ()
 Returns the root folder of a tree of folders available to upload images into your account.
 

Properties

int RootFolderId [get]
 The ID of the root folder in the Image Manager.
 

Detailed Description

Provides methods for handling Images.

Member Function Documentation

DmImageFolder dotMailer.Sdk.ImageFactory.CreateImageFolder ( string  newFolderName,
int  parentFolderId 
)

Creates a new image folder as a child folder of the folder whose ID is passed.

Parameters
newFolderNameThe name for new folder.
parentFolderIdThe Id of the folder in which the new folder will be created.
Returns
The newly created folder.
DmImageFolder dotMailer.Sdk.ImageFactory.CreateImageFolder ( string  newFolderName,
DmImageFolder  parentFolder 
)

Creates a new image folder as a child folder of the folder passed.

Parameters
newFolderNameThe name for new folder.
parentFolderThe folder in which the new folder will be created. If you pass null the new folder will be created as a root folder.
Returns
The newly created folder.
DmImageFolder dotMailer.Sdk.ImageFactory.CreateRootImageFolder ( string  newFolderName)

Creates a new image folder in the root of the image folder hierarchy.

Parameters
newFolderNameThe name for new folder.
Returns
The newly created folder.
DmImageFolder dotMailer.Sdk.ImageFactory.GetImageFolderTree ( )

Returns the root folder of a tree of folders available to upload images into your account.

Returns
The root folder.
DmImage dotMailer.Sdk.ImageFactory.UploadImage ( int  parentFolderId,
string  dotMailerFileName,
Byte[]  imageData 
)

Uploads a new campaign image to the specified folder.

Parameters
parentFolderIdThe ID of the image folder in which the image should appear.
dotMailerFileNameThe filename to display within dotMailer.
imageDataThe image data to upload.
Returns
A reference to the uploaded image.
DmImage dotMailer.Sdk.ImageFactory.UploadImage ( DmImageFolder  parentFolder,
string  dotMailerFileName,
Byte[]  imageData 
)

Uploads a new campaign image to the specified folder.

Parameters
parentFolderThe image folder in which the image should appear.
dotMailerFileNameThe filename to display within dotMailer.
imageDataThe image data to upload.
Returns
A reference to the uploaded image.
DmImage dotMailer.Sdk.ImageFactory.UploadImage ( DmImageFolder  parentFolder,
string  dotMailerFileName,
Stream  imageDataStream 
)

Uploads a new campaign image to the specified folder.

Parameters
parentFolderThe image folder in which the image should appear.
dotMailerFileNameThe filename to display within dotMailer.
imageDataStreamA stream containing the image data to upload.
Returns
DmImage dotMailer.Sdk.ImageFactory.UploadImage ( DmImageFolder  parentFolder,
string  dotMailerFileName,
string  fileName 
)

Uploads a new campaign image to the specified folder.

Parameters
parentFolderThe image folder in which the image should appear.
dotMailerFileNameThe filename to display within dotMailer.
fileNameThe filename of the image to upload.
Returns
DmImage dotMailer.Sdk.ImageFactory.UploadImage ( DmImageFolder  parentFolder,
string  fileName 
)

Uploads a new campaign image to the specified folder.

Parameters
parentFolderThe image folder in which the image should appear.
fileNameThe filename of the image to upload.
Returns

Property Documentation

int dotMailer.Sdk.ImageFactory.RootFolderId
get

The ID of the root folder in the Image Manager.

Generated by   doxygen 1.8.3