Package omero.cmd

Class SendEmailRequest

  • All Implemented Interfaces:
    Ice.Object, java.io.Serializable, java.lang.Cloneable
    Direct Known Subclasses:
    SendEmailRequestI
    public class SendEmailRequest
extends Request
    Requests an email to be send to all users of the omero determines inactive users, an active members of given groups and/or specific users. examples: - omero.cmd.SendEmailRequest(subject, body, everyone=True) sends message to everyone who has email set and is an active user - omero.cmd.SendEmailRequest(subject, body, everyone=True, inactive=True) sends message to everyone who has email set, even inactive users - omero.cmd.SendEmailRequest(subject, body, groupIds=\[...], userIds=\[...] ) sends email to active members of given groups and selected users - extra=\[...] allows to set extra email address if not in DB
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String[] __ids  
      java.lang.String body  
      boolean everyone  
      java.util.List<java.lang.String> extra  
      java.util.List<java.lang.Long> groupIds  
      boolean html  
      boolean inactive  
      static long serialVersionUID  
      java.lang.String subject  
      java.util.List<java.lang.Long> userIds  

      • Fields inherited from interface Ice.Object

        ice_staticId

    • Constructor Summary

      Constructors 
      Constructor Description
      SendEmailRequest()  
      SendEmailRequest​(java.lang.String subject, java.lang.String body, boolean html, java.util.List<java.lang.Long> userIds, java.util.List<java.lang.Long> groupIds, java.util.List<java.lang.String> extra, boolean inactive, boolean everyone)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void __readImpl​(IceInternal.BasicStream __is)  
      protected void __writeImpl​(IceInternal.BasicStream __os)  
      SendEmailRequest clone()  
      static Ice.ObjectFactory ice_factory()  
      java.lang.String ice_id()  
      java.lang.String ice_id​(Ice.Current __current)  
      java.lang.String[] ice_ids()  
      java.lang.String[] ice_ids​(Ice.Current __current)  
      boolean ice_isA​(java.lang.String s)  
      boolean ice_isA​(java.lang.String s, Ice.Current __current)  
      static java.lang.String ice_staticId()  

      • Methods inherited from class Ice.ObjectImpl

        ___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __dispatch, __read, __read, __readImpl, __write, __write, __writeImpl, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • __ids

        public static final java.lang.String[] __ids

      • subject

        public java.lang.String subject

      • body

        public java.lang.String body

      • html

        public boolean html

      • userIds

        public java.util.List<java.lang.Long> userIds

      • groupIds

        public java.util.List<java.lang.Long> groupIds

      • extra

        public java.util.List<java.lang.String> extra

      • inactive

        public boolean inactive

      • everyone

        public boolean everyone

    • Constructor Detail

      • SendEmailRequest

        public SendEmailRequest()

      • SendEmailRequest

        public SendEmailRequest​(java.lang.String subject,
                        java.lang.String body,
                        boolean html,
                        java.util.List<java.lang.Long> userIds,
                        java.util.List<java.lang.Long> groupIds,
                        java.util.List<java.lang.String> extra,
                        boolean inactive,
                        boolean everyone)

    • Method Detail

      • ice_factory

        public static Ice.ObjectFactory ice_factory()

      • ice_isA

        public boolean ice_isA​(java.lang.String s)
        Specified by:
        ice_isA in interface Ice.Object
        Overrides:
        ice_isA in class Request

      • ice_isA

        public boolean ice_isA​(java.lang.String s,
                       Ice.Current __current)
        Specified by:
        ice_isA in interface Ice.Object
        Overrides:
        ice_isA in class Request

      • ice_ids

        public java.lang.String[] ice_ids()
        Specified by:
        ice_ids in interface Ice.Object
        Overrides:
        ice_ids in class Request

      • ice_ids

        public java.lang.String[] ice_ids​(Ice.Current __current)
        Specified by:
        ice_ids in interface Ice.Object
        Overrides:
        ice_ids in class Request

      • ice_id

        public java.lang.String ice_id()
        Specified by:
        ice_id in interface Ice.Object
        Overrides:
        ice_id in class Request

      • ice_id

        public java.lang.String ice_id​(Ice.Current __current)
        Specified by:
        ice_id in interface Ice.Object
        Overrides:
        ice_id in class Request

      • ice_staticId

        public static java.lang.String ice_staticId()

      • __writeImpl

        protected void __writeImpl​(IceInternal.BasicStream __os)
        Overrides:
        __writeImpl in class Request

      • __readImpl

        protected void __readImpl​(IceInternal.BasicStream __is)
        Overrides:
        __readImpl in class Request