Class Mail

Inheritance

Object

Mail

Implements

IWebObject

IPlugin

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: SuperOffice.CRM.Web.AjaxMethods

Assembly: SuperOffice.CRMWeb.dll

Syntax

[SoWebObject("Mail")]
public class Mail : IWebObject, IPlugin

Constructors

Mail()

Declaration

public Mail()

Methods

ArchiveAsTaskFromInbox(EMailEntity, Int32, String)

Declaration

public string ArchiveAsTaskFromInbox(EMailEntity mail, int personId, string personFullName)

Parameters

Type	Name	Description
EMailEntity	mail
Int32	personId
String	personFullName

Returns

Type	Description
String

ArchiveAttachementFromInbox(EMailEntity, Int32, String, Int32, Boolean)

Declaration

public string ArchiveAttachementFromInbox(EMailEntity mail, int personId, string personFullName, int attachmentIdx, bool outgoing)

Parameters

Type	Name	Description
EMailEntity	mail
Int32	personId
String	personFullName
Int32	attachmentIdx
Boolean	outgoing

Returns

Type	Description
String

ArchiveEmailFromInbox(EMailEntity, Int32, Int32, String, Boolean, Boolean)

Declaration

public string ArchiveEmailFromInbox(EMailEntity entity, int folderId, int personId, string personFullName, bool stripAttachments, bool isOutgoing)

Parameters

Type	Name	Description
EMailEntity	entity
Int32	folderId
Int32	personId
String	personFullName
Boolean	stripAttachments
Boolean	isOutgoing

Returns

Type	Description
String

CreateNewContact(String, String)

Declaration

public int CreateNewContact(string name, string address)

Parameters

Type	Name	Description
String	name
String	address

Returns

Type	Description
Int32

CreateNewPerson(Int32, String, String)

Declaration

public void CreateNewPerson(int contactId, string name, string address)

Parameters

Type	Name	Description
Int32	contactId
String	name
String	address

DeleteByEmailItemId(String)

Declaration

public void DeleteByEmailItemId(string id)

Parameters

Type	Name	Description
String	id

DeleteMailById(String, String)

Declaration

public void DeleteMailById(string ids, string folderName)

Parameters

Type	Name	Description
String	ids
String	folderName

EmptyMailFolder(String)

Declaration

public void EmptyMailFolder(string folderName)

Parameters

Type	Name	Description
String	folderName

GetAddAttachmentScript(String)

Declaration

public string GetAddAttachmentScript(string soprotocol)

Parameters

Type	Name	Description
String	soprotocol

Returns

Type	Description
String

GetAddRecipientsScript(String)

Declaration

public string GetAddRecipientsScript(string recipients)

Parameters

Type	Name	Description
String	recipients

Returns

Type	Description
String

GetAddToSuperOfficeScript(EMailEntity, String)

Declaration

public string GetAddToSuperOfficeScript(EMailEntity mailEntity, string archiveScript)

Parameters

Type	Name	Description
EMailEntity	mailEntity
String	archiveScript

Returns

Type	Description
String

GetArchiveMailAttachmentScript()

Declaration

public string GetArchiveMailAttachmentScript()

Returns

Type	Description
String

GetCurrentAccountId()

Declaration

public int GetCurrentAccountId()

Returns

Type	Description
Int32

GetCurrentAccountStatus()

Declaration

public int GetCurrentAccountStatus()

Returns

Type	Description
Int32

GetDocumentTemplateDefault(Int16, Boolean, String, String)

Declaration

public int GetDocumentTemplateDefault(short recordType, bool outgoing, string templateName, string templateExtension)

Parameters

Type	Name	Description
Int16	recordType
Boolean	outgoing
String	templateName
String	templateExtension

Returns

Type	Description
Int32

GetEMailEntityFromStream(String)

Declaration

public EMailEntity GetEMailEntityFromStream(string inputStream)

Parameters

Type	Name	Description
String	inputStream

Returns

Type	Description
EMailEntity

GetEmailTemplateAttachments(String)

Declaration

public List<EMailAttachment> GetEmailTemplateAttachments(string inputStream)

Parameters

Type	Name	Description
String	inputStream

Returns

Type	Description
List<EMailAttachment>

GetEmailTemplateHTMLBody(String)

Declaration

public string GetEmailTemplateHTMLBody(string inputStream)

Parameters

Type	Name	Description
String	inputStream

Returns

Type	Description
String

GetFolderHasNewEMail()

Declaration

public bool GetFolderHasNewEMail()

Returns

Type	Description
Boolean

GetFolderList(String)

Declaration

public string[] GetFolderList(string folder)

Parameters

Type	Name	Description
String	folder

Returns

Type	Description
String[]

GetForwardDocumentScript(Int32)

Declaration

public string GetForwardDocumentScript(int documentId)

Parameters

Type	Name	Description
Int32	documentId

Returns

Type	Description
String

GetMailArchivedString(Int32)

Declaration

public string GetMailArchivedString(int id)

Parameters

Type	Name	Description
Int32	id

Returns

Type	Description
String

GetMailArchivedStringById()

Declaration

public string GetMailArchivedStringById()

Returns

Type	Description
String

GetOpenMailInboxScript()

Declaration

public string GetOpenMailInboxScript()

Returns

Type	Description
String

GetPopulatedMailEntity()

Declaration

public static EMailEntity GetPopulatedMailEntity()

Returns

Type	Description
EMailEntity

GetReplyToDocumentScript(Int32)

Declaration

public string GetReplyToDocumentScript(int documentId)

Parameters

Type	Name	Description
Int32	documentId

Returns

Type	Description
String

GetSendAppointmentScript(Int32)

Declaration

public string GetSendAppointmentScript(int appointmentId)

Parameters

Type	Name	Description
Int32	appointmentId

Returns

Type	Description
String

GetSendDocumentAsFaxScript(Int32)

Declaration

public string GetSendDocumentAsFaxScript(int documentId)

Parameters

Type	Name	Description
Int32	documentId

Returns

Type	Description
String

GetSendDocumentScript(Int32)

Declaration

public string GetSendDocumentScript(int documentId)

Parameters

Type	Name	Description
Int32	documentId

Returns

Type	Description
String

GetSendDocumentsScript(String)

Declaration

public string GetSendDocumentsScript(string documentIds)

Parameters

Type	Name	Description
String	documentIds

Returns

Type	Description
String

GetSendEMailScript(String)

Declaration

public string GetSendEMailScript(string addresses)

Parameters

Type	Name	Description
String	addresses

Returns

Type	Description
String

GetSendEMailScriptWithDefaults()

Declaration

public string GetSendEMailScriptWithDefaults()

Returns

Type	Description
String

GetSendEMailToPersonEmailAdddressScript(String, String, String)

Declaration

public string GetSendEMailToPersonEmailAdddressScript(string email, string description, string type)

Parameters

Type	Name	Description
String	email
String	description
String	type

Returns

Type	Description
String

GetSendEMailToPersonsScript(String)

Declaration

public string GetSendEMailToPersonsScript(string personIds)

Parameters

Type	Name	Description
String	personIds

Returns

Type	Description
String

GetSendEMailToProjectMembersScript(String)

Declaration

public string GetSendEMailToProjectMembersScript(string projectMemberIds)

Parameters

Type	Name	Description
String	projectMemberIds

Returns

Type	Description
String

GetSendEMailToProjectScript(Int32)

Declaration

public string GetSendEMailToProjectScript(int projectId)

Parameters

Type	Name	Description
Int32	projectId

Returns

Type	Description
String

GetSendEMailToSelectionMembersScript(String, String)

Declaration

public string GetSendEMailToSelectionMembersScript(string personIds, string contactIds)

Parameters

Type	Name	Description
String	personIds
String	contactIds

Returns

Type	Description
String

GetSendQuoteDocumentsScript(Boolean)

Declaration

public string GetSendQuoteDocumentsScript(bool addMainPageCode)

Parameters

Type	Name	Description
Boolean	addMainPageCode

Returns

Type	Description
String

GetSessionValue(String)

Declaration

public string GetSessionValue(string key)

Parameters

Type	Name	Description
String	key

Returns

Type	Description
String

InitialSync(String[])

Declaration

public static string InitialSync(string[] folderList)

Parameters

Type	Name	Description
String[]	folderList

Returns

Type	Description
String

MailLogOut()

Declaration

public void MailLogOut()

MarkEmailsAsRead(Int32[], Boolean)

Declaration

public void MarkEmailsAsRead(int[] ids, bool read)

Parameters

Type	Name	Description
Int32[]	ids
Boolean	read

OpenCurrentDocumentAsMail()

Declaration

public string OpenCurrentDocumentAsMail()

Returns

Type	Description
String

RefreshFolder()

Declaration

public void RefreshFolder()

ResolveEmails(Int32[])

Declaration

public string[] ResolveEmails(int[] emailIds)

Parameters

Type	Name	Description
Int32[]	emailIds

Returns

Type	Description
String[]

SaveDocumentAttachment(Int32)

Declaration

public string SaveDocumentAttachment(int documentId)

Parameters

Type	Name	Description
Int32	documentId

Returns

Type	Description
String

SetArchiveAsTaskCurrents()

Declaration

public string SetArchiveAsTaskCurrents()

Returns

Type	Description
String

SetArchiveAsTaskCurrentsByEmailEntity(EMailEntity)

Declaration

public string SetArchiveAsTaskCurrentsByEmailEntity(EMailEntity mail)

Parameters

Type	Name	Description
EMailEntity	mail

Returns

Type	Description
String

SetArchiveAttachmentCurrents(Int32)

Declaration

public string SetArchiveAttachmentCurrents(int attachmentIdx)

Parameters

Type	Name	Description
Int32	attachmentIdx

Returns

Type	Description
String

SetArchiveOnContactCurrents(String, Boolean)

Declaration

public string SetArchiveOnContactCurrents(string folder, bool stripAttachments)

Parameters

Type	Name	Description
String	folder
Boolean	stripAttachments

Returns

Type	Description
String

SetArchiveOnContactCurrentsById(Int32, String)

Declaration

public string SetArchiveOnContactCurrentsById(int id, string folder)

Parameters

Type	Name	Description
Int32	id
String	folder

Returns

Type	Description
String

SetArchiveOnContactCurrentsByMail(EMailEntity, String)

Declaration

public string SetArchiveOnContactCurrentsByMail(EMailEntity mail, string folder)

Parameters

Type	Name	Description
EMailEntity	mail
String	folder

Returns

Type	Description
String

SetArchiveOnContactCurrentsEx(EMailEntity, String, Boolean)

Declaration

public string SetArchiveOnContactCurrentsEx(EMailEntity entity, string folder, bool stripAttachments)

Parameters

Type	Name	Description
EMailEntity	entity
String	folder
Boolean	stripAttachments

Returns

Type	Description
String

SetArchiveOnProjectCurrents()

Declaration

public string SetArchiveOnProjectCurrents()

Returns

Type	Description
String

SetEmailTemplateValues(EMailEntity, Int32, String, Int32)

Declaration

public TemplateInfo SetEmailTemplateValues(EMailEntity mail, int documentTemplateId, string languageCode = "", int pluginId = -1)

Parameters

Type	Name	Description
EMailEntity	mail
Int32	documentTemplateId
String	languageCode
Int32	pluginId

Returns

Type	Description
TemplateInfo

SetSendAppointmentCurrents(Int32)

Declaration

public void SetSendAppointmentCurrents(int appointmentId)

Parameters

Type	Name	Description
Int32	appointmentId

SetSendDocumentFaxCurrents(Int32)

Declaration

public void SetSendDocumentFaxCurrents(int documentId)

Parameters

Type	Name	Description
Int32	documentId

SetSessionValue(String, String)

Declaration

public void SetSessionValue(string key, string value)

Parameters

Type	Name	Description
String	key
String	value

SetupOnlineBackgroundTask()

Declaration

public static string SetupOnlineBackgroundTask()

Returns

Type	Description
String

TogglePreview()

Declaration

public void TogglePreview()

Implements

IWebObject

SuperOffice.Factory.IPlugin