Email sender http reference

Fireback accelerates backend and mobile app development, offering powerful code generation tools and standardized architecture. With seamless backend integration and streamlined workflows, Fireback expedites the creation of robust and scalable apps.

getEmailSenders

emailSenders

Response Dto/Entity: *[]workspaces.EmailSenderEntity

message EmailSenderEntity {
  optional string workspaceId = 1; // @tag(yaml:"workspaceId")
  optional string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  optional string userId = 4; // @tag(yaml:"userId")
  optional string fromName = 6; // @tag( validate:"required,omitempty,min=1" yaml:"fromName" )
  optional string fromEmailAddress = 7; // @tag( validate:"required,omitempty,min=1" yaml:"fromEmailAddress" )
  optional string replyTo = 8; // @tag( validate:"required,omitempty,min=1" yaml:"replyTo" )
  optional string nickName = 9; // @tag( validate:"required,omitempty,min=1" yaml:"nickName" )
  optional string visibility = 10; // @tag(yaml:"visibility")


  int64 rank = 11; // @tag(gorm:"type:int;name:rank")
  int64 updated = 12; // @tag(gorm:"autoUpdateTime:nano")
  int64 created = 13; // @tag(gorm:"autoUpdateTime:nano")
  string createdFormatted = 14; // @tag(sql:"-")
  string updatedFormatted = 15; // @tag(sql:"-")

}
export interface EmailSenderEntity {
  /** @tag(yaml:"workspaceId") */
  workspaceId?: string | undefined;
  /** @tag(yaml:"parentId") */
  parentId?: string | undefined;
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
  uniqueId: string;
  /** @tag(yaml:"userId") */
  userId?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"fromName" ) */
  fromName?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"fromEmailAddress" ) */
  fromEmailAddress?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"replyTo" ) */
  replyTo?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"nickName" ) */
  nickName?: string | undefined;
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
  /** @tag(gorm:"type:int;name:rank") */
  rank: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  updated: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  created: number;
  /** @tag(sql:"-") */
  createdFormatted: string;
  /** @tag(sql:"-") */
  updatedFormatted: string;
}

getEmailSenderByUniqueId

emailSender/:uniqueId

Response Dto/Entity: *workspaces.EmailSenderEntity

message EmailSenderEntity {
  optional string workspaceId = 1; // @tag(yaml:"workspaceId")
  optional string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  optional string userId = 4; // @tag(yaml:"userId")
  optional string fromName = 6; // @tag( validate:"required,omitempty,min=1" yaml:"fromName" )
  optional string fromEmailAddress = 7; // @tag( validate:"required,omitempty,min=1" yaml:"fromEmailAddress" )
  optional string replyTo = 8; // @tag( validate:"required,omitempty,min=1" yaml:"replyTo" )
  optional string nickName = 9; // @tag( validate:"required,omitempty,min=1" yaml:"nickName" )
  optional string visibility = 10; // @tag(yaml:"visibility")


  int64 rank = 11; // @tag(gorm:"type:int;name:rank")
  int64 updated = 12; // @tag(gorm:"autoUpdateTime:nano")
  int64 created = 13; // @tag(gorm:"autoUpdateTime:nano")
  string createdFormatted = 14; // @tag(sql:"-")
  string updatedFormatted = 15; // @tag(sql:"-")

}
export interface EmailSenderEntity {
  /** @tag(yaml:"workspaceId") */
  workspaceId?: string | undefined;
  /** @tag(yaml:"parentId") */
  parentId?: string | undefined;
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
  uniqueId: string;
  /** @tag(yaml:"userId") */
  userId?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"fromName" ) */
  fromName?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"fromEmailAddress" ) */
  fromEmailAddress?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"replyTo" ) */
  replyTo?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"nickName" ) */
  nickName?: string | undefined;
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
  /** @tag(gorm:"type:int;name:rank") */
  rank: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  updated: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  created: number;
  /** @tag(sql:"-") */
  createdFormatted: string;
  /** @tag(sql:"-") */
  updatedFormatted: string;
}

Params: :uniqueId

postEmailSender

emailSender

Response Dto/Entity: *workspaces.EmailSenderEntity

message EmailSenderEntity {
  optional string workspaceId = 1; // @tag(yaml:"workspaceId")
  optional string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  optional string userId = 4; // @tag(yaml:"userId")
  optional string fromName = 6; // @tag( validate:"required,omitempty,min=1" yaml:"fromName" )
  optional string fromEmailAddress = 7; // @tag( validate:"required,omitempty,min=1" yaml:"fromEmailAddress" )
  optional string replyTo = 8; // @tag( validate:"required,omitempty,min=1" yaml:"replyTo" )
  optional string nickName = 9; // @tag( validate:"required,omitempty,min=1" yaml:"nickName" )
  optional string visibility = 10; // @tag(yaml:"visibility")


  int64 rank = 11; // @tag(gorm:"type:int;name:rank")
  int64 updated = 12; // @tag(gorm:"autoUpdateTime:nano")
  int64 created = 13; // @tag(gorm:"autoUpdateTime:nano")
  string createdFormatted = 14; // @tag(sql:"-")
  string updatedFormatted = 15; // @tag(sql:"-")

}
export interface EmailSenderEntity {
  /** @tag(yaml:"workspaceId") */
  workspaceId?: string | undefined;
  /** @tag(yaml:"parentId") */
  parentId?: string | undefined;
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
  uniqueId: string;
  /** @tag(yaml:"userId") */
  userId?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"fromName" ) */
  fromName?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"fromEmailAddress" ) */
  fromEmailAddress?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"replyTo" ) */
  replyTo?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"nickName" ) */
  nickName?: string | undefined;
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
  /** @tag(gorm:"type:int;name:rank") */
  rank: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  updated: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  created: number;
  /** @tag(sql:"-") */
  createdFormatted: string;
  /** @tag(sql:"-") */
  updatedFormatted: string;
}

Request Dto/Entity: *workspaces.EmailSenderEntity

message EmailSenderEntity {
  optional string workspaceId = 1; // @tag(yaml:"workspaceId")
  optional string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  optional string userId = 4; // @tag(yaml:"userId")
  optional string fromName = 6; // @tag( validate:"required,omitempty,min=1" yaml:"fromName" )
  optional string fromEmailAddress = 7; // @tag( validate:"required,omitempty,min=1" yaml:"fromEmailAddress" )
  optional string replyTo = 8; // @tag( validate:"required,omitempty,min=1" yaml:"replyTo" )
  optional string nickName = 9; // @tag( validate:"required,omitempty,min=1" yaml:"nickName" )
  optional string visibility = 10; // @tag(yaml:"visibility")


  int64 rank = 11; // @tag(gorm:"type:int;name:rank")
  int64 updated = 12; // @tag(gorm:"autoUpdateTime:nano")
  int64 created = 13; // @tag(gorm:"autoUpdateTime:nano")
  string createdFormatted = 14; // @tag(sql:"-")
  string updatedFormatted = 15; // @tag(sql:"-")

}
export interface EmailSenderEntity {
  /** @tag(yaml:"workspaceId") */
  workspaceId?: string | undefined;
  /** @tag(yaml:"parentId") */
  parentId?: string | undefined;
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
  uniqueId: string;
  /** @tag(yaml:"userId") */
  userId?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"fromName" ) */
  fromName?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"fromEmailAddress" ) */
  fromEmailAddress?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"replyTo" ) */
  replyTo?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"nickName" ) */
  nickName?: string | undefined;
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
  /** @tag(gorm:"type:int;name:rank") */
  rank: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  updated: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  created: number;
  /** @tag(sql:"-") */
  createdFormatted: string;
  /** @tag(sql:"-") */
  updatedFormatted: string;
}

patchEmailSender

emailSender

Response Dto/Entity: *workspaces.EmailSenderEntity

message EmailSenderEntity {
  optional string workspaceId = 1; // @tag(yaml:"workspaceId")
  optional string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  optional string userId = 4; // @tag(yaml:"userId")
  optional string fromName = 6; // @tag( validate:"required,omitempty,min=1" yaml:"fromName" )
  optional string fromEmailAddress = 7; // @tag( validate:"required,omitempty,min=1" yaml:"fromEmailAddress" )
  optional string replyTo = 8; // @tag( validate:"required,omitempty,min=1" yaml:"replyTo" )
  optional string nickName = 9; // @tag( validate:"required,omitempty,min=1" yaml:"nickName" )
  optional string visibility = 10; // @tag(yaml:"visibility")


  int64 rank = 11; // @tag(gorm:"type:int;name:rank")
  int64 updated = 12; // @tag(gorm:"autoUpdateTime:nano")
  int64 created = 13; // @tag(gorm:"autoUpdateTime:nano")
  string createdFormatted = 14; // @tag(sql:"-")
  string updatedFormatted = 15; // @tag(sql:"-")

}
export interface EmailSenderEntity {
  /** @tag(yaml:"workspaceId") */
  workspaceId?: string | undefined;
  /** @tag(yaml:"parentId") */
  parentId?: string | undefined;
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
  uniqueId: string;
  /** @tag(yaml:"userId") */
  userId?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"fromName" ) */
  fromName?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"fromEmailAddress" ) */
  fromEmailAddress?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"replyTo" ) */
  replyTo?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"nickName" ) */
  nickName?: string | undefined;
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
  /** @tag(gorm:"type:int;name:rank") */
  rank: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  updated: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  created: number;
  /** @tag(sql:"-") */
  createdFormatted: string;
  /** @tag(sql:"-") */
  updatedFormatted: string;
}

Request Dto/Entity: *workspaces.EmailSenderEntity

message EmailSenderEntity {
  optional string workspaceId = 1; // @tag(yaml:"workspaceId")
  optional string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  optional string userId = 4; // @tag(yaml:"userId")
  optional string fromName = 6; // @tag( validate:"required,omitempty,min=1" yaml:"fromName" )
  optional string fromEmailAddress = 7; // @tag( validate:"required,omitempty,min=1" yaml:"fromEmailAddress" )
  optional string replyTo = 8; // @tag( validate:"required,omitempty,min=1" yaml:"replyTo" )
  optional string nickName = 9; // @tag( validate:"required,omitempty,min=1" yaml:"nickName" )
  optional string visibility = 10; // @tag(yaml:"visibility")


  int64 rank = 11; // @tag(gorm:"type:int;name:rank")
  int64 updated = 12; // @tag(gorm:"autoUpdateTime:nano")
  int64 created = 13; // @tag(gorm:"autoUpdateTime:nano")
  string createdFormatted = 14; // @tag(sql:"-")
  string updatedFormatted = 15; // @tag(sql:"-")

}
export interface EmailSenderEntity {
  /** @tag(yaml:"workspaceId") */
  workspaceId?: string | undefined;
  /** @tag(yaml:"parentId") */
  parentId?: string | undefined;
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
  uniqueId: string;
  /** @tag(yaml:"userId") */
  userId?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"fromName" ) */
  fromName?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"fromEmailAddress" ) */
  fromEmailAddress?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"replyTo" ) */
  replyTo?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"nickName" ) */
  nickName?: string | undefined;
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
  /** @tag(gorm:"type:int;name:rank") */
  rank: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  updated: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  created: number;
  /** @tag(sql:"-") */
  createdFormatted: string;
  /** @tag(sql:"-") */
  updatedFormatted: string;
}

patchEmailSenders

emailSenders

Response Dto/Entity: *core.BulkRecordRequest[workspaces.EmailSenderEntity]

Request Dto/Entity: *core.BulkRecordRequest[workspaces.EmailSenderEntity]

deleteEmailSender

emailSender

Request Dto/Entity: *core.DeleteRequest

Target Entity: *workspaces.EmailSenderEntity

message EmailSenderEntity {
  optional string workspaceId = 1; // @tag(yaml:"workspaceId")
  optional string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  optional string userId = 4; // @tag(yaml:"userId")
  optional string fromName = 6; // @tag( validate:"required,omitempty,min=1" yaml:"fromName" )
  optional string fromEmailAddress = 7; // @tag( validate:"required,omitempty,min=1" yaml:"fromEmailAddress" )
  optional string replyTo = 8; // @tag( validate:"required,omitempty,min=1" yaml:"replyTo" )
  optional string nickName = 9; // @tag( validate:"required,omitempty,min=1" yaml:"nickName" )
  optional string visibility = 10; // @tag(yaml:"visibility")


  int64 rank = 11; // @tag(gorm:"type:int;name:rank")
  int64 updated = 12; // @tag(gorm:"autoUpdateTime:nano")
  int64 created = 13; // @tag(gorm:"autoUpdateTime:nano")
  string createdFormatted = 14; // @tag(sql:"-")
  string updatedFormatted = 15; // @tag(sql:"-")

}
export interface EmailSenderEntity {
  /** @tag(yaml:"workspaceId") */
  workspaceId?: string | undefined;
  /** @tag(yaml:"parentId") */
  parentId?: string | undefined;
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
  uniqueId: string;
  /** @tag(yaml:"userId") */
  userId?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"fromName" ) */
  fromName?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"fromEmailAddress" ) */
  fromEmailAddress?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"replyTo" ) */
  replyTo?: string | undefined;
  /** @tag( validate:"required,omitempty,min=1" yaml:"nickName" ) */
  nickName?: string | undefined;
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
  /** @tag(gorm:"type:int;name:rank") */
  rank: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  updated: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  created: number;
  /** @tag(sql:"-") */
  createdFormatted: string;
  /** @tag(sql:"-") */
  updatedFormatted: string;
}